Skip to navigation

Register Customer

View as Markdown

Registers or upserts a customer sender profile for the authenticated account.

Authentication:

  • REQUIRED: Basic Auth only (Authorization: Basic base64(client_id:client_secret)).

Behavior:

  1. Validates required sender fields (flat JSON at root, not nested under sender).

  2. Creates (201) or updates (200) the registered customer profile under your account.

Response:

  • Returns customer_id, normalized sender fields, and created_at / updated_at when available.

customer_id returned here is required for decodeQr, getQuotation, and executePayout.

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-specific profile notes:

  • Peru (PE): store occupation, email, phone, and gender (MALE or FEMALE) before decode.
  • Vietnam (VN): nationality (ISO 3166-1 alpha-2) is required. It is checked when the payer’s KYC record is first created, i.e. their first VN payout; backfill existing payers with updateCustomer.
  • LATAM corridors (AR, BR, PE, BO, CO): name_first, name_last, ic_number, ic_country required for lock/compliance.
  • Use checkCustomer.allowed to verify corridor eligibility before decode.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Request

This endpoint expects an object.
name_firststringRequired
name_laststringRequired
ic_numberstringRequired
ic_typestringRequired
ic_countrystringRequired
occupationstringRequired
country_of_residencestringRequired
dobdateRequired
addressstringRequired
ic_expiry_datedateRequired
genderstringOptional

Optional. M or F. Required only where a corridor asks for it; returned as a missing field at payout time when needed.

phonestringOptional

Optional. E.164 format. Required only where a corridor asks for it; returned as a missing field at payout time when needed.

emailstringOptionalformat: "email"

Optional. Required only where a corridor asks for it; returned as a missing field at payout time when needed.

nationalitystringOptional

Optional for most corridors. Required for Vietnam (VN), checked at the payer’s first VN payout.

Response

Created
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