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

Authorization

Bodyapplication/json
externalCustomerIdstringrequired

Unique customer reference provided by you.

emailstringrequired

The user's email address

mobileNumberstringrequired

The customer mobile number

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: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalCustomerId": "string",
    "email": "string",
    "mobileNumber": "string",
    "provider": {
      "vendor": "",
      "token": "string"
    }
  }'

Responses

202

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