--- title: "Create Rapyd Verify Application" source_url: https://docs.rapyd.net/en/create-rapyd-verify-application.html lang: en --- # 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](https://docs.rapyd.net/en/application-status-change-webhook.md "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 - - access_key - Unique access key provided by Rapyd for each authorized user. See [Developers](https://docs.rapyd.net/en/developers.md "Developers"). - - Content-Type - Indicates that the data appears in JSON format. Set to **application/json**. - - idempotency - A unique key that prevents the platform from creating the same object twice. See [Idempotency](https://docs.rapyd.net/en/idempotency.md "Idempotency"). - - salt - Random string. Recommended length: 8-16 characters. - - signature - Signature calculated for each request individually. See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures"). - - timestamp - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). ### Request Body Parameters - - application_type - Code for the type of application. See [List Rapyd Verify Application Types](https://docs.rapyd.net/en/list-rapyd-verify-application-types.md "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](https://docs.rapyd.net/en/metadata.md "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](https://support.rapyd.net). Response only. - - merchant_language - Determines the default language of the application page. The values are documented in [List Hosted Page Supported Languages](https://docs.rapyd.net/en/list-supported-languages.md "List 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 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' \ --data-raw '{ "rapyd_entity_token": "ewallet_b5320c566cc4aa01fe77440ad08693f7", "client_reference_id": "2025-11-03q", "phone_number": "+12125551256", "merchant_fallback_url": "https://rapyd.net", "country": "us" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "eddc0e9a-0a64-4015-ad74-757c66b7d026" }, "data": { "token": "happ_3a5a45f172364177bbbed5e08acada11", "rapyd_entity_token": "ewallet_b5320c566cc4aa01fe77440ad08693f7", "cancel_url": null, "complete_url": null, "client_reference_id": "2025-11-03q", "application_token": null, "phone_number": "+12125551256", "authorized_user_email": null, "metadata": null, "merchant_details": { "merchant_color": "323fff", "merchant_website": "https://example1234.net", "merchant_logo": "", "merchant_design": null, "merchant_language": null, "merchant_alias": "Doc Team", "merchant_customer_support": { "url": "https://example1234.net", "email": "support@example1234.net", "phone_number": "121255551213" }, "merchant_terms": "https://example1234.net/terms_and_conditions", "merchant_privacy_policy": "https://example1234.net/privacy_policy" }, "redirect_url": "https://sandboxverify.rapyd.net/verify?token=happ_3a5a45f172364177bbbed5e08acada11" } } ``` - Bad Request - Duplicate - ```curl 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' \ --data-raw '{ "rapyd_entity_token": "ewallet_5a3732a1633e9e1349bee0f8de840b8d", "phone_number": "+12125551256", "country": "US" }' ``` - ```json { "status": { "error_code": "ERROR_CREATE_HOSTED_APPLICATION_ALREADY_EXIST", "status": "ERROR", "message": "The request tried to create a hosted application for identity verification, but a previous application is currently in process for this contact. The request was rejected. Corrective action: Use ‘Retrieve Application’ to retrieve a copy of the existing application and advise the applicant to complete it. When it is complete, submit it for approval.", "response_code": "ERROR_CREATE_HOSTED_APPLICATION_ALREADY_EXIST", "operation_id": "a1f3bd10-a62a-41e1-9c4a-9917e7f9a739" } } ``` - Bad Request - Country Mismatch - ```curl 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' \ --data-raw '{ "rapyd_entity_token": "ewallet_5a3732a1633e9e1349bee0f8de840b8d", "phone_number": "+12125551256", "country": "DE" }' ``` - ```json { "status": { "error_code": "ERROR_CREATE_APPLICATION_COUNTRY_MISMATCH", "status": "ERROR", "message": "The request tried to create an application for verification, but the country provided did not match the country of the Rapyd wallet. The request was rejected. Corrective action: Contact Rapyd Client Support.", "response_code": "ERROR_CREATE_APPLICATION_COUNTRY_MISMATCH", "operation_id": "239cf7cb-33a0-4399-abd3-d8b33a997e77" } } ``` ### Related information - [Rapyd Verify Hosted Page](https://docs.rapyd.net/en/rapyd-verify-hosted-page.md "Rapyd Verify Hosted Page") - [Simulating Rapyd Verify Application Responses](https://docs.rapyd.net/en/simulating-rapyd-verify-application-responses.md "Simulating Rapyd Verify Application Responses")