Register a customer

post

https://api-sandbox.interlace.money/open-api/v3/scan2pay/customer/register

Creates a customer profile by submitting identity, contact, and
supporting document information required for compliance review.
Returns the customer record together with the Interlace customer
identifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerEmail

string

required

Email address

version

string

API version associated with the customer onboarding request

firstName

string

required

First name

lastName

string

required

Last name

dateOfBirth

string

required

Date of birth in YYYY-MM-DD format

gender

string

enum

required

Gender code. Use M for male or F for female.

Allowed:

nationality

string

required

Nationality country code (ISO 3166-1 alpha-2)

nationalId

string

required

Government-issued ID number

idType

string

enum

required

Government-issued ID type

Allowed:

issueDate

string

Identity document issue date in YYYY-MM-DD format

expiryDate

string

Identity document expiry date in YYYY-MM-DD format

nationalAddress

object

required

Mailing or billing address

mailAddress

object

Mailing or billing address

idFrontId

string

required

Numeric string representing the file identifier for the front of the identity document, returned by the Scan-to-Pay file upload endpoint.

idBackId

string

required

Numeric string representing the file identifier for the back of the identity document, returned by the Scan-to-Pay file upload endpoint.

idHoldId

string

required

Numeric string representing the file identifier for the selfie holding the identity document, returned by the Scan-to-Pay file upload endpoint.

ipAddress

string

IP address captured during customer onboarding

phoneNumber

string

required

Phone number without the country calling code

phoneCountryCode

string

required

International calling code, digits only, without the plus sign

occupation

string

enum

Occupation code.
01=Office employee, 02=Freelancer, 03=Self-employed business owner,
04=Public sector employee, 05=State-owned enterprise employee,
06=Healthcare professional, 07=Teacher, 08=Construction worker,
09=Ride-hailing or logistics driver, 10=E-commerce professional,
11=Food service employee, 12=Financial services professional,
13=Unemployed or no fixed occupation, 14=Retired, 15=Student, 16=Other

transactionCountries

array of strings

required

Transaction country codes to activate for Scan-to-Pay

transactionCountries*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Successful operation

400Bad Request