Sign in

v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Customer

Register a customer

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.

post/open-api/v3/scan2pay/customer/register

Request body

customerEmailstring required

Email address

versionstring

API version associated with the customer onboarding request

firstNamestring required

First name

lastNamestring required

Last name

dateOfBirthstring required

Date of birth in YYYY-MM-DD format

gender'M' | 'F' required

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

nationalitystring required

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

nationalIdstring required

Government-issued ID number

idType'PASSPORT' | 'ID_CARD' required

Government-issued ID type

issueDatestring

Identity document issue date in YYYY-MM-DD format

expiryDatestring

Identity document expiry date in YYYY-MM-DD format

idFrontIdstring required

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

idBackIdstring required

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

idHoldIdstring required

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

ipAddressstring

IP address captured during customer onboarding

phoneNumberstring required

Phone number without the country calling code

phoneCountryCodestring required

International calling code, digits only, without the plus sign

occupation'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16'

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

transactionCountriesstring[] required

Transaction country codes to activate for Scan-to-Pay

Example request

{
  "customerEmail": "john.smith@example.com",
  "version": "v3",
  "firstName": "John",
  "lastName": "Smith",
  "dateOfBirth": "1990-01-01",
  "nationality": "US",
  "issueDate": "2018-05-10",
  "expiryDate": "2028-05-10",
  "nationalAddress": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "country": "US",
    "postalCode": "10001"
  },
  "mailAddress": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "country": "US",
    "postalCode": "10001"
  },
  "idFrontId": "2046061141584039936",
  "idBackId": "2046061141584039936",
  "idHoldId": "2046061141584039936",
  "ipAddress": "192.168.1.1",
  "phoneNumber": "6505551234",
  "phoneCountryCode": "1",
  "occupation": "01",
  "transactionCountries": [
    "VN",
    "TH"
  ]
}

Response

Successful operation