KYC Sharing Customer Registration

post

https://api.banxa.com/api/identities

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.

Body Params

account_reference

string

required

Unique customer reference provided by you. This should be the same value that is passed when calling the calling the Create Order endpoint.

string

required

Customer's email address. Must be a valid email address.

mobile_number

string

Customer's contact number. Must be a valid mobile number and must include the country code.

customer_identity

object

An array of fields containing the customer's personal details.

identity_documents

array of objects

An array of objects containing a type, data and links to the location of the customer's KYC documents.

identity_documents

identity_sharing

array of objects

An array of objects containing KYC outcomes. Required for Sumsub only.

identity_sharing

Headers

string

Defaults to application/json

X-Request-Id

string

This is the correlation ID related to the request.

Responses

Language

Credentials

Header

Request

Response

Choose an example:

application/json

200200

422422