Skip to main content

Documentation

Step 2: Create an Application

Create an application with the information gathered in step 1.

  • The application type

  • The business industry

  • The sell type

  • The company ewallet ID of the organization

Parameters
Request Header Parameters
Request Body Parameters

    • application_type

    • Code for the type of application. String starting with typ_.

    • authorized_user_email

    • The official email address of the company.

    • business_industry

    • The business industry of the company. See step 1.

    • application_type

    • Code for the type of application. String starting with typ_.

    • client_reference_id

    • ID defined by the client. Limited to 255 characters.

    • country

    • The country where the company is domiciled. Two-letter ISO 3166-1 ALPHA-2 code.

    • metadata

    • A JSON object defined by the client.

    • rapyd_entity_token

    • The ewallet ID of the organization.

    • sell_type

    • The sell type of the company. See step 1.

Response

Note

Due to the length of the response, in this example, a shortened version of the relevant portions of the response is displayed. It does not include all the contents of the triggers object and the sections object. The triggers object is explained in the next step.

Response parameters include all the request parameters and the following:

    • copied_from_application_token

    • Indicates whether the application was copied from another application. Default is false.

    • created_at

    • Time of creation of the application, in Unix time.: 

    • is_authorized_by_service

    • Non configurable field that is false by default. Indicates whether the application data was auto populated by an external data provider.

    • token

    • ID of the verification application or one of its parts, such as a subsection or document, depending on the context. String starting with sect_.

    • triggers

    • See the next step for a detailed explanation.

    • updated_at

    • Indicates the time the application was updated.

    • version

    • Version of the application. Increases by 1 each time the application is saved. Starts at 0.

Sections Object Description

Contains the data portion of the application. The object contains the following section objects with their current values:

  • business - General information about the business itself. 

  • company - Information about the identity of the company. All values are initially null.

  • AU - Information about the authorized user or agent who is submitting the information on behalf of the company. All values are initially null.

  • shareholders_3 - Information about the fourth owner of the business, including the high-level management executives hired by the business owners or board of directors. All values are initially null.

  • shareholders_2 -  Information about the third owner of the business, including the high-level management executives hired by the business owners or board of directors. All values are initially null.

  • shareholders_1 - Information about the second owner of the business, including the high-level management executives hired by the business owners or board of directors. All values are initially null.

  • shareholders_0 - Information about the first owner of the business, including the high-level management executives hired by the business owners or board of directors. All values are initially null.

  • officer - Information about the officer of the business, including the high-level management executives hired by the business owners or board of directors. All values are initially null.

    • Shortened sample of sections object:

      • {
    "sections": {
        "business": {
            "section_token": "sect_b436089c229f456d81145f64e2caab83",
            "metadata": {
                "error_message": null
            },


  "elements": { 
            "type": {
                "business_type": {
                    "metadata": {
                        "is_required": "REQUIRED",
                        "is_read_only": true
                    },
                    "value": "ATR-0009"
                }
            },
            "sell_type": {
                "sell_type": {
                    "metadata": {
                        "is_required": "REQUIRED",
                        "is_read_only": true
                    },
                    "value": "ATS-0001"
                }
            },
            "industry": {
                "business_industry": {
                    "metadata": {
                        "is_required": "REQUIRED",
                        "is_read_only": true
                    },
                    "value": "7273"
                },
                "sub_business_industry": {
                    "metadata": {
                        "is_required": "CONDITIONAL"
                    },
                    "value": null
                }
		
    //additional business field objects
            },
            "company": {
                "section_token": "sect_797daf5321784b42975a583125e06f1a"
    //additional company field objects
            },
            "AU": {
                "section_token": "sect_72ea99cfc98f48e5b8de3c3c4cf3556c"
           //additional AU field objects
            },
            "shareholder_3": {
                "section_token": "sect_209c34ae649f4dcf8af0c111a00bb1fb"
   //additional shareholder_3 field objects


            },
            "shareholder_2": {
                "section_token": "sect_291d2c1643c34050a64ed1f3f7cbc38a"
     //additional shareholder_2 field objects


            },
            "shareholder_1": {
                "section_token": "sect_0e53be84bfc64144b720a59ea2ed6293"
	     //additional shareholder_1 field objects	
            },
            "shareholder": {
                "section_token": "sect_572bcf25750c45168a71243bcf67c89c"
	     //additional shareholder_0 field objects	
            },
            "officer": {
                "section_token": "sect_7d2d9ca016714d988e9c8451c69ab512"
	    //additional officer field objects	

            },
            "application_type": "typ_WyJJUyIsMiwwLCJQcml2YXRlIExpbWl0ZWQgQ29tcGFueSJd"
        }
    }
  }
}
Section Object Fields - Each section object has the following fields:

    • section_token

    • The unique ID of the section. String starting with sect_.

    • metadata

    • After a save or submit action (see Step 5: Save Application Form and Step 7: Submit Application in workflow), this field is updated with all the related section errors. For example if first_name is a required field, but left blank then the value changes to "error_message": "first_name" (a mapping that indicates where there are errors in the section). Default is "error_message": null.

    • Data object of the section

    • Each data object includes the following fields:

      • Data object name

      • Field name

      • metadata object with the following boolean fields:

        • - is_required: Indicates whether the field is required

        • - is_read_only: Indicates whether the field is read only or can be edited by the applicant.

      • If relevant then dependent field or fields with the same object structure.

    • application_type

    • Code for the type of application. String starting with typ_.

    • client_reference_id

    • ID defined by the client. Limited to 255 characters.

    • country

    • The country where the company is domiciled. Two-letter ISO 3166-1 ALPHA-2 code.

    • metadata

    • A JSON object defined by the client.

    • rapyd_entity_token

    • The ewallet ID of the organization.

    • sell_type

    • The sell type of the company. See step 1.

image7.png

Note

 Most of the values in the initial response are null since the application has not been filled out yet.

Error Responses

  • ERROR_GET_HOSTED_APPLICATION - The request attempted an operation, but one or more required fields were missing. The request was rejected. Corrective action: Provide all of the fields that are listed at the end of the error code. For more information, see the API Reference.

  • MISSING_FIELDS - [COUNTRY_CODE] - The request attempted an operation, but one or more required fields were missing. The request was rejected. Corrective action: Provide all of the fields that are listed at the end of the error code. For more information, see the API Reference.

  • MISSING_FIELDS - [APP_LEVEL] - The request attempted an operation, but one or more required fields were missing. The request was rejected. Corrective action: Provide all of the fields that are listed at the end of the error code. For more information, see the API Reference.

  • MISSING_FIELDS - [ENTITY_TYPE] - The request attempted an operation, but one or more required fields were missing. The request was rejected. Corrective action: Provide all of the fields that are listed at the end of the error code. For more information, see the API Reference.

  • MISSING_FIELDS - [SELL_TYPE] - The request attempted an operation, but one or more required fields were missing. The request was rejected. Corrective action: Provide all of the fields that are listed at the end of the error code. For more information, see the API Reference.

  • ERROR_APPLICATION_TYPE_NOT_FOUND - The request attempted an operation on an application, but the application was not found. The request was rejected. Corrective action: Use the ID of a valid application.

  • ERROR_CREATE_RAPYD_VERIFY_APPLICATION_COUNTRY_MISMATCH - The request tried to create an application for Rapyd Verify, but the application type did not match the country provided. The request was rejected. Corrective action: For 'application_type', use an application that was created for the country specified in 'country'.

  • ERROR_GET_EWALLET - The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Use the ID of a valid wallet, a string starting with 'ewallet_'.

  • ERROR_PERSONAL_WALLET_APPROVAL_TYPE_MISMATCH - The request tried to create an application for approval of a personal wallet, but the application was for a company. The request was rejected. Corrective action: For 'application_type', select an application type that is relevant to an individual.

  • ERROR_COMPANY_WALLET_APPROVAL_TYPE_MISMATCH - The request tried to create an application for approval of a company wallet, but the application was for an individual. The request was rejected. Corrective action: For 'application_type', select an application type that is relevant to a company.

  • {base_uri}/verify/api/applications

  • Create Application

  • curl -X POST
{base_uri}/verify/api/applications/
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-H 'api_timestamp: your-unix-timestamp-here'
-d '
{
    "rapyd_entity_token": "ewallet_64e0c34fdf585a059eab5cb3d44ad8b3",
    "application_type": "typ_WyJGUiIsMixudWxsLCJQcml2YXRlIExpbWl0ZWQgQ29tcGFueSJd",
    "client_reference_id": "000001111",
    "authorized_user_email": "test@test.com",
    "sell_type": "ATS-0001",
    "business_industry": "4812",
    "metadata": {
        "modular": "true"
    },
    "country": "fr"
}
'
  • {
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "0bf00a37-d4a8-47ff-a7da-4ee70db57bbb"
    },
    "data": {
        "token": "app_c2b0b46034b14f528d7013b849721913",
        "rapyd_entity_token": "ewallet_64e0c34fdf585a059eab5cb3d44ad8b3",
        "copied_from_application_token": null,
        "client_reference_id": "000001111",
        "authorized_user_email": "test@test.com",
        "version": 0,
        "status": "new",
        "metadata": {
            "modular": "true"
        },
        "entity_type": "Private Limited Company",
        "country": "FR",
        "created_at": 1692874057137,
        "updated_at": 1692874057137,
        "sell_type": "ATS-0001",
        "business_industry": 4812,
        "is_authorized_by_service": false,
        "triggers": {},
        "is_lean": false,
        "sections": {
            "business": {
                "section_token": "sect_b436089c229f456d81145f64e2caab83"
            },
            "company": {
                "section_token": "sect_797daf5321784b42975a583125e06f1a"
            },
            "AU": {
                "section_token": "sect_72ea99cfc98f48e5b8de3c3c4cf3556c"
            },
            "shareholder_3": {
                "section_token": "sect_209c34ae649f4dcf8af0c111a00bb1fb"
            },
            "shareholder_2": {
                "section_token": "sect_291d2c1643c34050a64ed1f3f7cbc38a"
            },
            "shareholder_1": {
                "section_token": "sect_0e53be84bfc64144b720a59ea2ed6293"
            },
            "shareholder": {
                "section_token": "sect_572bcf25750c45168a71243bcf67c89c"
            },
            "officer": {
                "section_token": "sect_7d2d9ca016714d988e9c8451c69ab512"
            },
            "application_type": "typ_WyJJUyIsMiwwLCJQcml2YXRlIExpbWl0ZWQgQ29tcGFueSJd"
        }
    }
}}
In this section:

The number of seconds elapsed since the beginning of the Unix epoch, which was 00:00:00 GMT on January 1, 1970. 10-digit integer.