Update Application
Update the application with values for fields that have not been filled out yet or have been previously filled out incorrectly.
Some industry types require filling out the application via an online page. In this scenario, an error is returned. See also the related sample on this page.
app_token
ID of the
application. String starting with app_.
Note
Some fields are unique for a specific type of proprietor.
sections
Includes only the objects with new field values.
Refer to the samples on this page to view how the payload is submitted.
For non-sole proprietor applications it is recommended to initially indicate if there was a change to the
shareholder_existsvalue that was defined when the application was created. This information can be indicated by entering a yes or no value for theshareholder_existsfield. See also the samples on this page.
/v1/partner/onboarding/application/:app_token/update
Update Application - sole_prop_card_present
curl -X POST api.rapyd.net/v1/partner/onboarding/application/app_790a5db172024bc29a705416d70f9225/update -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' -d ' { "sections": { "business": { "statement_descriptor": { "statement_descriptor": "sell or buy" } } } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "0629edbd-735e-4c06-b6cc-3559d95ad4ec" }, "data": { "token": "app_790a5db172024bc29a705416d70f9225", "version": 3, "status": "NEW", "ewallet_token": "ewallet_527f7a2422ec8a2925f8a37e3f626db7", "metadata": {}, "entity_type": "Sole_Proprietor", "country": "GB", "created_at": 1750840363974, "updated_at": 1750840634659, "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": "4200000" }, "statement_descriptor": { "statement_descriptor": "sell or buy" }, "proof_of_address_document": { "issues": [ { "field": "address_ref", "details": "This file is required." } ] }, "proof_of_address": { "physical_address": "Mainland street 1", "address_additional_details": null, "postal_code": "SW1A 0AA", "city": "london", "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": "london", "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", "government_id_img": [], "issues": [ { "field": "id_img", "details": "This file is required." } ] }, "phone": { "phone_country_code": "GB", "phone_number": "2071234567" }, "email": { "email": "tradepvtl@gmail12345.com" }, "nationality": { "nationality": "IT", "additional_citizenships": [ "RU", "SO" ] }, "address": { "address": "Mainland building", "address_additional_details": "address additional input", "postal_code": "SW1A 0AA", "city": "london", "state": null, "us_state": null, "country": "GB" }, "proof_of_address_document": { "issues": [ { "field": "address_ref", "details": "This file is required." } ] } } }, "link": "https://qaverify.rapyd.net/verify?token=happ_99ba77b91ee54e6d8d5590853d226a75", "merchant_phone_number": { "country_code": "GB", "phone_number": "2071234567" }, "instructions": null } }
Update Application - sole_prop_card_not_present
curl -X POST api.rapyd.net/v1/partner/onboarding/application/app_4fd2784a04a147b29e5ec5d0106bbb0e/update -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' -d ' { "sections": { "business": { "transaction_information": { "avg_tpv_usd": 11, "expectedMaximumTransactionAmount": 21, "averageTimeBetweenPurchaseAndDeliveryInDays": 3, "annual_revenue": 4200000 } } } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "cb02f81c-72a0-4147-ba68-3441fa080e9a" }, "data": { "token": "app_4fd2784a04a147b29e5ec5d0106bbb0e", "version": 3, "status": "NEW", "ewallet_token": "ewallet_7c352dbcccbc887ceb97a27766dbd916", "metadata": {}, "entity_type": "Sole_Proprietor", "country": "DE", "created_at": 1750853685733, "updated_at": 1750853938648, "sell_type": "Website with a Checkout Page", "business_industry": 5965, "sections": { "business": { "trade_name": { "trade_name": "Online PVT Limited" }, "product_description": { "business_desc": "payment online store" }, "url": { "business_url": "https://www.onlinepvtl.com" }, "transaction_information": { "avg_tpv_usd": "11", "expectedMaximumTransactionAmount": "21", "averageTimeBetweenPurchaseAndDeliveryInDays": "3", "annual_revenue": "4200000" }, "statement_descriptor": { "statement_descriptor": "accept payment online" } }, "company": { "business_name": { "business_name": "Online PVT Limited" }, "phone": { "phone_country_code": "DE", "phone_number": "302918354" }, "company_number": { "registration_number": "HRA 1234" }, "address": { "address": "cottage area 1", "address_additional_details": "behind hypermarket", "postal_code": "01067", "city": "AnyTown", "state": "state", "us_state": null, "country": "DE" }, "company_documents": { "company_documents": [] }, "vat_id": { "tax_id": null } }, "owner": { "name": { "first_name": "John", "last_name": "Doe" }, "dob": { "dob": "12/12/1991" }, "identification": { "id_type": "Passport", "id": "PVT457829", "government_id_img": [], "issues": [ { "field": "id_img", "details": "This file is required." } ] }, "phone": { "phone_country_code": "DE", "phone_number": "302918354" }, "email": { "email": "onlinepvtl@gmail12345.com" }, "nationality": { "nationality": "DK", "additional_citizenships": [ "US" ] }, "address": { "address": "area 3", "address_additional_details": "al quasais", "postal_code": "01067", "city": "AnyTown", "state": "state", "us_state": null, "country": "DE" }, "proof_of_address_document": { "issues": [ { "field": "address_ref", "details": "This file is required." } ] } } }, "link": "https://qaverify.rapyd.net/verify?token=happ_b24c0a0393364f85b8ef3c81bb10abff", "merchant_phone_number": { "country_code": "AE", "phone_number": "502480600" }, "instructions": null } }
Update Application - non_sole_prop_card_present without shareholders
curl -X POST api.rapyd.net/v1/partner/onboarding/application/app_4f7ac75db0774e3699a25afba7a4c5f4/update -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' -d ' { "sections": { "business": { "trade_name": { "trade_name": "trade @name 123 input" }, "product_description": { "business_desc": "product description text area" }, "proof_of_address_document": { "address_ref": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" }, "url": { "business_url": "https://www.google.com" }, "transaction_information": { "avg_tpv_usd": 1, "expectedMaximumTransactionAmount": 2, "averageTimeBetweenPurchaseAndDeliveryInDays": 3, "annual_revenue": 4200000 }, "statement_descriptor": { "statement_descriptor": "statement input" }, "proof_of_address": { "physical_address": "proof of address input", "address_additional_details": "address_additional_details input", "postal_code": "123456", "city": "city input", "country": "IS", "state": "state input" } }, "company": { "business_name": { "business_name": "business name input" }, "registration_country": { "registration_country": "" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "company_number": { "registration_number": "reg 123 input" }, "address": { "address": "address input", "postal_code": "123456", "city": "city input", "country": "NL", "state": "state input", "address_additional_details": "address additional details input" }, "vat_id": { "tax_id": "tax id" } }, "AU": { "name": { "first_name": "Joe", "last_name": "Smith" }, "dob": { "dob": "12/12/1991" }, "address": { "address": "address", "postal_code": "123456", "city": "city", "country": "IS", "state": "state", "address_additional_details": "additional fields", "us_state": null }, "title": { "user_title": "CEO" }, "email": { "email": "TEST@gmail12345.com" }, "nationality": { "nationality": "IS" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "identification": { "id_type": "passport", "id": "12345", "id_img": null, "government_id_img": null }, "proof_of_address_document": { "address_ref": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" } }, "shareholders_control": { "has_owner": { "shareholder_exists": "No" } } } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "d1423cb1-4b61-4f86-ae08-d0c72449e68d" }, "data": { "token": "app_4f7ac75db0774e3699a25afba7a4c5f4", "version": 3, "status": "NEW", "ewallet_token": "ewallet_029136d8bb917ecb80687fdce4000a0d", "metadata": {}, "entity_type": "Charity_or_NPO", "country": "IS", "created_at": 1747895569173, "updated_at": 1747899032455, "sell_type": "Physical Business (Brick and Mortar)", "business_industry": 4814, "sections": { "business": { "trade_name": { "trade_name": "trade @name 123 input" }, "product_description": { "business_desc": "product description text area" }, "url": { "business_url": "https://www.google.com" }, "transaction_information": { "avg_tpv_usd": "1", "expectedMaximumTransactionAmount": "2", "averageTimeBetweenPurchaseAndDeliveryInDays": "3", "annual_revenue": "4200000" }, "statement_descriptor": { "statement_descriptor": "statement input" }, "proof_of_address_document": { "issues": [ { "field": "address_ref", "details": "This file is required." } ] }, "proof_of_address": { "physical_address": "proof of address input", "address_additional_details": "address_additional_details input", "postal_code": "123456", "city": "city input", "state": "state input", "country": "IS" } }, "company": { "business_name": { "business_name": "business name input" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "company_number": { "registration_number": "reg 123 input" }, "address": { "address": "address input", "address_additional_details": "address additional details input", "postal_code": "123456", "city": "city input", "state": "state input", "us_state": null, "country": "NL" }, "company_documents": { "company_documents": [] }, "vat_id": { "tax_id": "tax id" } }, "AU": { "name": { "first_name": "Joe", "last_name": "Smith" }, "dob": { "dob": "12/12/1991" }, "address": { "address": "address", "address_additional_details": "additional fields", "postal_code": "123456", "city": "city", "state": "state", "country": "IS" }, "title": { "user_title": "CEO" }, "email": { "email": "TEST@gmail12345.com" }, "nationality": { "nationality": "IS", "additional_citizenships": null }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "identification": { "id_type": "Passport", "id": "12345", "government_id_img": [], "issues": [ { "field": "id_img", "details": "This file is required." } ] }, "proof_of_address_document": { "issues": [ { "field": "address_ref", "details": "This file is required." } ] } }, "shareholders_control": { "has_owner": { "shareholder_exists": "No" } }, "shareholder_3": { "type": { "shareholder_type": "Individual" }, "name": { "first_name": null, "last_name": null }, "ownership": { "ownership_percentage": null }, "dob": { "dob": null }, "phone": { "phone_country_code": null, "phone_number": null }, "email": { "email": null }, "nationality": { "nationality": null, "additional_citizenships": null }, "address": { "address": null, "address_additional_details": null, "postal_code": null, "city": null, "state": null, "country": null }, "ownership_proof": { "ownership_ref_type": [] } }, "shareholder_2": { "type": { "shareholder_type": "Individual" }, "name": { "first_name": null, "last_name": null }, "ownership": { "ownership_percentage": null }, "dob": { "dob": null }, "phone": { "phone_country_code": null, "phone_number": null }, "email": { "email": null }, "nationality": { "nationality": null, "additional_citizenships": null }, "address": { "address": null, "address_additional_details": null, "postal_code": null, "city": null, "state": null, "country": null }, "ownership_proof": { "ownership_ref_type": [] } }, "shareholder_1": { "type": { "shareholder_type": "Individual" }, "name": { "first_name": null, "last_name": null }, "ownership": { "ownership_percentage": null }, "dob": { "dob": null }, "phone": { "phone_country_code": null, "phone_number": null }, "email": { "email": null }, "nationality": { "nationality": null, "additional_citizenships": null }, "address": { "address": null, "address_additional_details": null, "postal_code": null, "city": null, "state": null, "country": null }, "ownership_proof": { "ownership_ref_type": [] } }, "shareholder": { "type": { "shareholder_type": "Individual" }, "name": { "first_name": "Joe", "last_name": "Smith" }, "ownership": { "ownership_percentage": "34" }, "dob": { "dob": "12/12/1990" }, "phone": { "phone_country_code": "IL", "phone_number": "12345789" }, "email": { "email": "test@t1234567.com" }, "nationality": { "nationality": "GB", "additional_citizenships": null }, "address": { "address": "abcd", "address_additional_details": null, "postal_code": "1234", "city": "AnyTown", "state": null, "country": "GB" }, "ownership_proof": { "ownership_ref_type": [] } } }, "link": "https://qaverify.rapyd.net/verify?token=happ_fdaa12f357a0452595938520469d46f5", "instructions": null } }
Update Application - industry type must be filled out online
curl -X POST api.rapyd.net/v1/partner/onboarding/application/app_52b6e2a06c3f4159aec5d22199e5282f/update -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' -d ' { "sections": { "business": { "trade_name": { "trade_name": "trade @name 123 input" }, "product_description": { "business_desc": "product description text area" }, "url": { "business_url": "https://www.google.com" }, "transaction_information": { "avg_tpv_usd": 1, "expectedMaximumTransactionAmount": 2, "averageTimeBetweenPurchaseAndDeliveryInDays": 3, "annual_revenue": 4200000 }, "statement_descriptor": { "statement_descriptor": "statement input" }, "proof_of_address": { "physical_address": "proOf of address input" } }, "company": { "business_name": { "business_name": "business name input" }, "registration_country": { "registration_country": "" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "company_number": { "registration_number": "reg 123 input" }, "address": { "address": "address input", "postal_code": "123456", "city": "city input", "country": "NL", "state": "state input", "address_additional_details": "address additional details input" }, "vat_id": { "tax_id": "tax id" } }, "AU": { "name": { "first_name": "Joe", "last_name": "Smith" }, "dob": { "dob": "12/12/2000" }, "address": { "address": "address", "postal_code": "123456", "city": "city", "country": "IS", "state": "state", "address_additional_details": "additional fields" }, "title": { "user_title": "CFO" }, "email": { "email": "TEST@gmail124567.com" }, "nationality": { "nationality": "IS" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "identification": { "id_type": "passport", "id": "12345", "id_img": null, "government_id_img": null }, "proof_of_address_document": { "address_ref": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" } }, "shareholder": { "name": { "first_name": "Joe", "last_name": "Smith" }, "ownership": { "ownership_percentage": 25 }, "dob": { "dob": "12/12/1990" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "email": { "email": "test@t1234567.com" }, "nationality": { "nationality": "IS" }, "address": { "address": "address", "postal_code": "1234", "city": "AnyTown", "country": "IS", "state": "state", "address_additional_details": null }, "ownership_proof": { "ownership_ref_type": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" } }, "shareholder_1": { "name": { "first_name": "Joe", "last_name": "Smith" }, "ownership": { "ownership_percentage": 25 }, "dob": { "dob": "12/12/1990" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "email": { "email": "test@t1234567.com" }, "nationality": { "nationality": "IS" }, "address": { "address": "address", "postal_code": "1234", "city": "AnyTown", "country": "IS", "state": "state", "address_additional_details": null }, "ownership_proof": { "ownership_ref_type": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" } }, "shareholder_2": { "name": { "first_name": "Joe", "last_name": "Smith" }, "ownership": { "ownership_percentage": 25 }, "dob": { "dob": "12/12/1990" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "email": { "email": "test@t1234567.com" }, "nationality": { "nationality": "IS" }, "address": { "address": "address", "postal_code": "1234", "city": "AnyTown", "country": "IS", "state": "state", "address_additional_details": null }, "ownership_proof": { "ownership_ref_type": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" } }, "shareholder_3": { "name": { "first_name": "Joe", "last_name": "Smith" }, "ownership": { "ownership_percentage": 25 }, "dob": { "dob": "12/12/1990" }, "phone": { "phone_country_code": "IS", "phone_number": "8219888" }, "email": { "email": "test@t1234567.com" }, "nationality": { "nationality": "IS" }, "address": { "address": "address", "postal_code": "1234", "city": "AnyTown", "country": "IS", "state": "state", "address_additional_details": null }, "ownership_proof": { "ownership_ref_type": "iVBORw0KGgoAAAANSUhEUgAABQAAAAURCAMAAADnsN77AAAABGdBTUEAALGPC/xhBQAAAAFUgISMuLx0YGTw4OSsmJ2xqanFubkhERbW0tMGvFOEaIv/mACQf" } }, "shareholders_control": { "has_owner": { "shareholder_exists": "Yes" } } } } '{ "status": { "error_code": "ERROR_UPDATE_ONBOARDING_APPLICATION_MCC_NOT_SUPPORTED", "status": "ERROR", "message": "The MCC in the request is not supported. The request was rejected. Corrective action: The application must be filled out via its hosted page. The link to the application's hosted page appears at the end of the response code. hosted link: https://qaverify.rapyd.net/verify?token=happ_ead80cc78c824789a02ab3fefc0cd9d1", "response_code": "ERROR_UPDATE_ONBOARDING_APPLICATION_MCC_NOT_SUPPORTED", "operation_id": "5e3f92b5-8a47-401c-a1b9-591d85cb0dfc" } }