Retrieve Application
Use this GET method to retrieve an application that has been saved or submitted via its application token identifier.
app_token
The application token identifier. String that starts with app_.
Each section includes unique required and optional fields. A field includes the issues object in cases where its value of is missing or is invalid. The issues object includes the fieldname and the details for providing the correct value. For example, if an invalid value is provided for the business_name field, then details are "Enter a value of up to 80 alphanumeric characters and spaces."
If a required field value is entered correctly then the field displays its current value and it has no issues object.
instructions
Includes the instructions on how to fill out the application. Certain industry types enable filling out the application via the APIs and a link to hosted page. However, there are industry types that do not enable filling out the application via API methods and require filling it out via a hosted page link. In such scenarios the application is not returned and the following instructions are displayed: "The industry type for this application must filled out online. "
link
Link to a hosted page where the application can be filled out online.
{base_uri}/v1/partner/onboarding/app/:app_token
Retrieve Application
curl -X GET https://api.rapyd.net/partner/onboarding/app/app_790a5db172024bc29a705416d70f9225 -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 'merchant_account_id: : your-merchant-account-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "d330d011-8350-4979-9f83-8f56be97a85c" }, "data": { "token": "app_790a5db172024bc29a705416d70f9225", "version": 7, "status": "LIMITED_APPROVAL", "ewallet_token": "ewallet_527f7a2422ec8a2925f8a37e3f626db7", "metadata": {}, "entity_type": "Sole_Proprietor", "country": "GB", "created_at": 1750840363974, "updated_at": 1750841427731, "sell_type": "Physical Business (Brick and Mortar)", "business_industry": 4814, "sections": { "business": { "trade_name": { "trade_name": "trade PVT Limited" }, "product_description": { "business_desc": "Trading in and out" }, "url": { "business_url": "" }, "transaction_information": { "avg_tpv_usd": "1", "expectedMaximumTransactionAmount": "2", "averageTimeBetweenPurchaseAndDeliveryInDays": "3", "annual_revenue": "4" }, "statement_descriptor": { "statement_descriptor": "sell or buy" }, "proof_of_address_document": { "address_ref": [ "image (1).png" ] }, "proof_of_address": { "physical_address": "Mainland street 1", "address_additional_details": null, "postal_code": "SW1A 0AA", "city": "NewTown", "state": null, "country": "GB" } }, "company": { "business_name": { "business_name": "Trade PVT Limited" }, "phone": { "phone_country_code": "GB", "phone_number": "2071234567" }, "company_number": { "registration_number": "OC123456" }, "address": { "address": "Oasis street 12", "address_additional_details": null, "postal_code": "SW1A 0AA", "city": "NewTown", "state": null, "us_state": null, "country": "GB" }, "company_documents": { "company_documents": [] }, "vat_id": { "tax_id": null } }, "owner": { "name": { "first_name": "Joe", "last_name": "Smith" }, "dob": { "dob": "12/12/1991" }, "identification": { "id_type": "Driver's License", "id": "ID-63773", "id_img": [ "image (16).png" ], "government_id_img": [] }, "phone": { "phone_country_code": "GB", "phone_number": "2071234567" }, "email": { "email": "tradepvtl@gmail.com" }, "nationality": { "nationality": "IT", "additional_citizenships": [ "FR", "IT" ] }, "address": { "address": "Mainland building", "address_additional_details": "address additional input", "postal_code": "SW1A 0AA", "city": "NewTown", "state": null, "us_state": null, "country": "GB" }, "proof_of_address_document": { "address_ref": [ "image (1).png" ] } } }, "link": "https://qaverify.rapyd.net/verify?token=happ_99ba77b91ee54e6d8d5590853d226a75", "merchant_phone_number": { "country_code": "GB", "phone_number": "2071234567" }, "instructions": null } }