INinterlace
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.

For the request structure, see the Update Customer Request Resource. For the response structure, see the Customer Resource.

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

Request

  • Base URL
    https://api-sandbox.interlace.money
  • URL
    https://api-sandbox.interlace.money/open-api/v3/scan2pay/customer/update
  • Auth
    API key in header x-access-token

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

frontImageIdstring

Numeric string representing the uploaded image identifier for the front of the identity document

backImageIdstring

Numeric string representing the uploaded image identifier for the back of the identity document

holdImageIdstring

Numeric string representing the uploaded image identifier for the selfie holding the identity document

phoneNumberstring

Phone number without the country calling code

phoneCountryCodestring

International calling code, digits only, without the plus sign

occupation'EXECUTIVE' | 'MANAGER' | 'BUSINESS_OWNER' | 'PROFESSIONAL' | 'EMPLOYEE' | 'HOMEMAKER' | 'STUDENT' | 'RETIRED' | 'UNEMPLOYED' | 'OTHER'

Customer occupation classification

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"
  },
  "frontImageId": "2046061141584039936",
  "backImageId": "2046061141584039936",
  "holdImageId": "2046061141584039936",
  "phoneNumber": "6505551234",
  "phoneCountryCode": "1",
  "occupation": "EMPLOYEE",
  "extend": {
    "customField": "value"
  }
}

Response

Successful operation

codestring

Business code, 000000 means success

messagestring

Message description

Example response

{
  "code": "000000",
  "message": "success",
  "data": {
    "customerId": "1986466477083709441",
    "customerEmail": "john.smith@example.com",
    "version": "v3",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "1990-01-01",
    "gender": "M",
    "nationality": "US",
    "nationalId": "A123456789",
    "idType": "PASSPORT",
    "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"
    },
    "frontImageId": "2046061141584039936",
    "backImageId": "2046061141584039936",
    "holdImageId": "2046061141584039936",
    "ipAddress": "192.168.1.1",
    "phoneNumber": "6505551234",
    "phoneCountryCode": "1",
    "occupation": "EMPLOYEE"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.