Skip to content

Share identity token

Request

Share a customer's Sumsub identity token with Banxa before creating an order. Banxa uses the token to retrieve KYC details directly from Sumsub, reducing re-verification friction in the checkout flow.

Requires HMAC authorization.

Path
partnerstringrequired

This is the partner code provided to you during onboarding. e.g. metamask.

Headers
Acceptstring
Default:"application/json"
Authorizationstring

HMAC authorization header. See Authentication & Environments for how to sign the request.

Example:Bearer API_KEY:SIGNATURE:NONCE
Bodyapplication/json
externalCustomerIdstringrequired

Unique customer reference provided by you.

emailstringrequired

The user's email address

mobileNumberstring

The customer mobile number, in international format. Optional. Interac (Canada) requires a mobile number: if you do not provide one, Banxa collects it from the customer during checkout.

Example:"+14155552671"
providerobjectrequired
curl -i -X POST \
  'https://docs.banxa.com/_mock/products/hosted-checkout/openapi/{partner}/v2/identities/token/share' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer API_KEY:SIGNATURE:NONCE' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalCustomerId": "user_12345",
    "email": "[email protected]",
    "mobileNumber": "+14155552671",
    "provider": {
      "vendor": "sumsub",
      "token": "_act-sbx-jwt-eyJhbGciOiJub25lIn0..."
    }
  }'

Responses

Accepted. Banxa has stored the token against the customer.

Bodyapplication/json
externalCustomerIdstringrequired
Response
{ "externalCustomerId": "user_12345" }