Allows you to register customer details with Banxa before an Order is created. This reduces the need for customers to re-submit personal details and perform KYC during the Banxa checkout flow. Detailed guide on how to implement this API can be found here.
This endpoint is restricted and subject to Banxa approval.
Unique customer reference provided by you. This should be the same value that is passed when calling the calling the Create Order endpoint.
Customer's email address. Must be a valid email address, and the Customer must have access to this email address to perform OTP verification if required.
Customer's contact number. Must be a valid mobile number and can support a value with or without "+" in the input.
Customer's date of birth (e.g. "1985-01-31"). Required to format as ISO 8601 Date format : YYYY-MM-DD.
Customer's residential address: Street number, street name and street type/suffix. E.g. "2 Abbey Road".
Address state / region. The 2-letter abbreviation for US States must be used.
Customer's country of residence. Required to be formatted using ISO 3166 two-letter country code e.g. "US" or "AU".
Supported values are PASSPORT , DRIVING_LICENSE or IDENTIFICATION,
The unique identity document number. For example a Passport number.
Customer's Social Security Number. Required if the Customer's Country of Residence is United States (e.g. the 'country' parameter contains a value of "US"). Must be submitted in the following format: "XXX-XX-XXXX".
The most recent date on which a PEP & Sanction screening check was conducted for the Customer. Required to format as ISO 8601 Date format : YYYY-MM-DD , date must be today or before.
If the Sanctions screening scan revealed the Customer is Sanctioned, then return a value of TRUE, otherwise return a value of FALSE.
- Mock serverhttps://docs.banxa.com/_mock/products/legacy-api/openapi/api/identities/reliance
- https://api.banxa.comhttps://api.banxa.com/api/identities/reliance
curl -i -X POST \
https://docs.banxa.com/_mock/products/legacy-api/openapi/api/identities/reliance \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"account_reference": "test001001",
"email": "[email protected]",
"mobile_number": "+16102458680",
"given_name": "Joe",
"middle_name": "Winter",
"surname": "Bloggs",
"dob": "1990-01-31",
"address_line_1": "1 East Liberty Street",
"suburb": "Reno",
"post_code": "89501",
"state": "NV",
"country": "US",
"document_type": "PASSPORT",
"document_number": "530000000",
"ssn": "530-42-3010",
"screening_date": "2022-05-01",
"screening_sanctions_result": false,
"screening_pep_result": false
}'