Allows you to share customer details with Banxa before an Order is created. This reduces the need for customers to re-submit personal details and upload KYC documentation 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 contact number. Must be a valid mobile number and must include the country code.
An array of objects containing a type, data and links to the location of the customer's KYC documents.
An array of objects containing KYC outcomes. Required for Sumsub only.
Customer's occupation industry. Please contact Banxa for a list of accepted values.
Customer's occupation, which must be associated to the Customer's 'occupation_industry'. Please contact Banxa for a list of accepted values. Required if 'occupation_primary' is passed.
- Mock serverhttps://docs.banxa.com/_mock/products/legacy-api/openapi/api/identities
- https://api.banxa.comhttps://api.banxa.com/api/identities
curl -i -X POST \
https://docs.banxa.com/_mock/products/legacy-api/openapi/api/identities \
-H 'Accept: application/json' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-H 'X-Request-Id: string' \
-d '{
"account_reference": "string",
"email": "string",
"mobile_number": "string",
"customer_identity": {
"given_name": "string",
"surname": "string",
"dob": "string",
"taxId": "456-44-4564",
"taxState": "CA",
"residential_address": {
"address_line_1": "string",
"suburb": "string",
"post_code": "string",
"state": "string",
"country": "GB"
}
},
"identity_documents": [
{
"type": "string",
"images": {
"link": "string",
"base64": "string",
"mimetype": "image/jpeg"
},
"data": {
"number": "string"
}
}
],
"identity_sharing": [
{
"provider": "sumsub",
"token": "string"
}
],
"occupation_industry": "string",
"occupation": "string",
"purpose_of_tx": "string"
}'