Submit customer information for Scan-to-Pay

Merchant use this API to submit customer identity details (name, phone, ID type, ID number) for compliance validation before initiating a Scan-to-Pay transaction. Returns a unique customerId for subsequent payment association.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

User's first name. Example: [email protected]

string
required

User's first name. Example: John

string
required

User's last name. Example: Smith

string
required

Date of birth in YYYY-MM-DD format. Example: 1990-01-01

string
enum
required

User’s gender. Use "M" for male or "F" for female. Example: M

Allowed:
string
required

Two-letter country code of nationality, as defined in ISO 3166-1 alpha-2. Example: US

string
required

ID number. Required for passport/driver’s license/national ID.

string
enum
required

Type of ID.

Allowed:
string
required

ID issue date in YYYY-MM-DD format. Example: 2018-05-10

string
required

ID expiry date in YYYY-MM-DD format. Example: 2028-05-10

string
required

Transaction's country

nationalAddress
object
required

Billing Address

mailAddress
object

Billing Address

string

Base64-encoded image of the front side of the ID document. Provide either idFrontBase64 or idFrontId.

string

Base64-encoded image of the back side of the ID document. Provide either idBackBase64 or idBackId.

string

Base64-encoded selfie with the ID document. Provide either idHoldBase64 or idHoldId.

string

File ID of the front side of the ID document, returned by the Scan-to-Pay file upload API. Provide either idFrontId or idFrontBase64.

string

File ID of the back side of the ID document, returned by the Scan-to-Pay file upload API. Provide either idBackId or idBackBase64.

string

File ID of the selfie with the ID document, returned by the Scan-to-Pay file upload API. Provide either idHoldId or idHoldBase64.

string
required

User's phone number without the country code. Example: 13800138000

string
required

The international dialing code of the user's mobile number, numbers only, no "+". Example: 86

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json