Create Rapyd Verify Application

Create an application for Rapyd Verify where the client (applicant) provides information directly to Rapyd.

After the applicant submits the application on the hosted page, Rapyd verifies the information. When the status of the application changes, Rapyd sends Application Status Change Webhook.

The redirect_url value in the response provides the link to the hosted application.

When the customer browses to the URL, Rapyd sends an authentication code to the applicant's phone. For the sandbox, the authentication code is 111111.

The application is created upon one of the following events:

If you specify application_type in the request, the application is created when the hosted page is created.
If you do not specify application_type, the application is created when the applicant selects an application type and saves it.

Parameters

Request Header Parameters

Request Body Parameters

- application_type
- Code for the type of application.
  See List Rapyd Verify Application Types.
- 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. The hosted application displays the country as the default setting. Must match the wallet contact country.
- merchant_fallback_url
- The landing page that is displayed after the application process is completed. Does not support localhost URLs.
- metadata
- A JSON object defined by the client. See Metadata.
- phone_number
- The phone number of the applicant. This is the phone number where an authentication code is sent. Must have a leading plus sign (+).
- rapyd_entity_token
- The ID of the Rapyd wallet of the company. String starting with ewallet_.
  Must be a company type wallet.

Response Parameters

- application_token
- Identifier of the application. String starting with app_.
- cancel_url
- URL where the customer is redirected after pressing Back to Website to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs.
- client_reference_id
- ID defined by the client. Limited to 255 characters.
- complete_url
- URL where the customer is redirected after pressing Close to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs.
- merchant_details
- Object containing information about the merchant.
  merchant_alias
  The name that appears on the hosted page when merchant_logo is not specified. To change this value, contact Client Support. Response only.
  merchant_language
  Determines the default language of the application page. The values are documented in List Hosted Page Supported Languages. * When this parameter is null, the language of the user's browser is used. * If the language of the user's browser cannot be determined, the default language is English. Response only.
  merchant_logo
  URL for the image of the client's logo. Response only.To configure this feature, use the Client Portal.
  merchant_website
  The URL where the customer is redirected after exiting the hosted page.Response only.
- phone_number
- The phone number of the applicant. This is the phone number where an authentication code is sent. Must have a leading plus sign (+).
- rapyd_entity_token
- The ID of the Rapyd wallet of the company. String starting with ewallet_.
  Must be a company type wallet.
- redirect_url
- URL of the hosted page that is shown to the customer.
- token
- Identifier of the hosted application. String starting with happ_.

Important

The redirect_url value in the response provides the link to the hosted application.

When the customer browses to the URL, Rapyd sends an authentication code to the applicant's phone. For the sandbox, the authentication code is 111111.

/v1/verify/applications/hosted

Create Rapyd Verify Application

curl -X post
https://sandboxapi.rapyd.net/v1/verify/applications/hosted/
-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'
-d '{
    "rapyd_entity_token": "ewallet_ef84c580177dbfc4293b1cf73c73fc77",
    "client_reference_id": "1234-b",
    "phone_number": "+12125551256",
    "merchant_fallback_url": "https://rapyd.net",
    "metadata": {
        "merchant-defined": true
    },
    "country": "us"
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "36ded6e4-9fc2-4aff-8163-1a3ee5d7d265"
    },
    "data": {
        "token": "happ_327bc354-2b6f-41d9-90e3-74aa7fed3287",
        "rapyd_entity_token": "ewallet_ef84c580177dbfc4293b1cf73c73fc77",
        "cancel_url": null,
        "complete_url": null,
        "client_reference_id": "1234-b",
        "application_token": null,
        "phone_number": "+12125551256",
        "merchant_details": {
            "merchant_website": "https://www.net.net",
            "merchant_logo": "",
            "merchant_language": null,
            "merchant_alias": "Rapyd"
        },
        "redirect_url": "https://sandboxverify.rapyd.net/verify?token=happ_327bc354-2b6f-41d9-90e3-74aa7fed3287"
    }
}

Related information

In this section:

Documentation