Sign in

v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Customer

Update customer details

Updates an existing customer profile. Only fields included in the request are updated; omitted fields remain unchanged. customerId identifies the customer record to update.

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

Request body

customerIdstring required

Numeric string representing a 64-bit Interlace customer identifier used to locate the customer record

customerEmailstring

Email address

firstNamestring

First name

lastNamestring

Last name

dateOfBirthstring

Date of birth in YYYY-MM-DD format

gender'M' | 'F'

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

nationalitystring

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

nationalIdstring

Government-issued ID number

idType'PASSPORT' | 'ID_CARD'

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

Numeric string representing the file identifier for the front side of the identity document

idBackIdstring

Numeric string representing the file identifier for the back side of the identity document

idHoldIdstring

Numeric string representing the file identifier for the selfie with the identity document

phoneNumberstring

Phone number without the country calling code

phoneCountryCodestring

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

extendobject

Client-defined extension fields for additional metadata

Example request

{
  "customerId": "1986466477083709441",
  "customerEmail": "john.smith@example.com",
  "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",
  "phoneNumber": "6505551234",
  "phoneCountryCode": "1",
  "occupation": "01",
  "extend": {
    "customField": "value"
  }
}

Response

Successful operation