KYC Sharing

If your platform uses Sumsub for identity verification, you can share the customer's verified KYC data with Banxa before they enter checkout. Banxa retrieves the data directly from Sumsub — reducing or eliminating the verification steps the customer needs to complete in the Banxa checkout.

• Your platform uses Sumsub for identity verification.
• The identity endpoint must be enabled for your account (requires Banxa approval).
• You have completed the Sumsub token sharing agreement with Banxa.
• Only share data for customers who have already been KYC verified on your platform.

1. When a customer is KYC-verified on your platform, generate a Sumsub share token using Banxa's clientId and call the Banxa identity endpoint. Do this at verification time — not at order creation, as the data may not be processed in time for the customer's session.
2. Banxa stores the token and associates it with the externalCustomerId.
3. When the customer enters the Banxa checkout, Banxa retrieves their KYC data from Sumsub. Their details are pre-populated and some verification steps may be skipped.
4. Banxa still performs its own KYC due diligence. Additional information may be requested if required by compliance processes.

→ See Sumsub Integration for how to generate the share token and for details on Copy Applicant, which extracts a fuller profile including address and TIN.

POST /{partnerRef}/v2/identities/token/share

This endpoint uses HMAC authentication, not the standard x-api-key header. HMAC signing must be done server-side — never embed your API secret in frontend or mobile code.

See Authentication & Environments for the signing algorithm, code examples, and error codes.

curl -X POST "https://api.banxa-sandbox.com/{partnerRef}/v2/identities/token/share" \
  -H "Authorization: Bearer API_KEY:SIGNATURE:NONCE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "externalCustomerId": "user_12345",
    "mobileNumber": "+61412345678",
    "email": "[email protected]",
    "provider": {
      "vendor": "sumsub",
      "token": "_act-sbx-jwt-eyJhbGciOiJub25lIn0..."
    }
  }'

202 Accepted

{
  "externalCustomerId": "user_12345"
}

A 202 response confirms Banxa has received and queued the identity data for processing. It does not guarantee immediate availability in the checkout.

• externalCustomerId must be the same value used in order creation. Using different values for the same customer creates separate identities in the Banxa system.
• Banxa may still collect additional information from the customer during checkout if required by compliance processes.
• Only submit data for verified customers. Do not pass unverified or provisional data.