Skip to navigation

Update Customer

View as Markdown

Updates an existing registered customer profile for the authenticated account.

Authentication:

  • REQUIRED: Basic Auth only.

Query Parameters:

  • customer_id (required): Customer identifier returned by registerCustomer.

Request Body:

  • Provide one or more updatable sender fields.
  • name_first and name_last are immutable and cannot be updated.

Response:

  • Returns updated flat sender profile with customer_id and timestamps.

Field code references:

  • ic_type must be one of the supported identification document type codes: NIC, PP, WEP, DL.
  • occupation must be one of the supported occupation codes: OCC1 through OCC11.

Corridor eligibility: After updating, call checkCustomer and inspect allowed before retrying decodeQr for the target country.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Query parameters

customer_idstringRequired

Request

This endpoint expects an object.
emailstringOptionalformat: "email"
phonestringOptional
occupationstringOptional
addressstringOptional
genderstringOptional

MALE or FEMALE for Peru (PE)

Response

OK
customer_idstringOptional
name_firststringOptional
name_laststringOptional
genderstringOptional
ic_numberstringOptional
ic_typestringOptional
ic_countrystringOptional
occupationstringOptional
country_of_residencestringOptional
phonestringOptional
emailstringOptionalformat: "email"
nationalitystringOptional
dobdateOptional
addressstringOptional
ic_expiry_datedateOptional
created_atdatetimeOptional
updated_atdatetimeOptional
allowedmap from strings to booleansOptional

ISO 3166-1 alpha-2 corridor code → true when stored sender profile satisfies that corridor’s requirements.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error