Share customer identity
A unique customer identifier provided by the partner. This field is required and must be unique for each customer.
Important: You must consistently reuse the same identityReference for repeat interactions with the same customer, allowing Banxa to reliably recognize and associate their identity across multiple transactions.
Format Requirements:
- Only ASCII letters (a-z, A-Z), digits (0-9), and hyphens (-) are allowed
- Must be between 1 and 255 characters
- Case-sensitive
Best Practices:
- Use a consistent format across your system
- Consider using a prefix to identify your organization (e.g., 'partner-customer-123')
- Do not include personally identifiable information (PII) in the reference
- Store the mapping between your internal customer ID and this reference securely
Mobile phone number in international format (E.164).
Format: Include country code with + prefix
Examples:
- "+61431000001" (Australia)
- "+14155552671" (USA)
- "+442071234567" (UK)
Requirements:
- Must be a valid, active mobile number
- Used for SMS verification if needed
- Maximum 20 characters
The category of tax or government identifier supplied in taxId. The correct value depends on the customer's country and the identifier type accepted for that country.
| Value | Description |
|---|---|
identity_card | A government-issued identity card number used for identity or tax reporting in the customer's country. |
tax_id | A tax identification number issued by a tax authority, such as a TFN, TIN, ITIN, or equivalent. |
national_number | A national, citizen, resident, or social insurance number used to identify an individual in their country. |
ssn | A Social Security Number, generally used for US individuals. |
Tax state or region if applicable.(associated with the taxId) Required format as two characters. Note; We do not accept any states where Banxa is not licensed.
- Mock serverhttps://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/identities/share/token
- Production environment serverhttps://api.banxa.com/eapi/v0/identities/share/token
- Sandbox environment serverhttps://api.banxa-sandbox.com/eapi/v0/identities/share/token
curl -i -X POST \
https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/identities/share/token \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"identityReference": "customer-12345",
"email": "[email protected]",
"mobileNumber": "+61431000001",
"provider": {
"vendor": "sumsub",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
}'The identity sharing request has been accepted for processing, but the processing has not been finished yet.
A unique customer identifier provided by the partner. This field is required and must be unique for each customer.
Important: You must consistently reuse the same identityReference for repeat interactions with the same customer, allowing Banxa to reliably recognize and associate their identity across multiple transactions.
Format Requirements:
- Only ASCII letters (a-z, A-Z), digits (0-9), and hyphens (-) are allowed
- Must be between 1 and 255 characters
- Case-sensitive
Best Practices:
- Use a consistent format across your system
- Consider using a prefix to identify your organization (e.g., 'partner-customer-123')
- Do not include personally identifiable information (PII) in the reference
- Store the mapping between your internal customer ID and this reference securely
{ "identityReference": "customer-12345" }