Register Customer
Registers or upserts a customer sender profile for the authenticated account.
Authentication:
- REQUIRED: Basic Auth only (
Authorization: Basic base64(client_id:client_secret)).
Behavior:
-
Validates required sender fields (flat JSON at root, not nested under
sender). -
Creates (201) or updates (200) the registered customer profile under your account.
Response:
- Returns
customer_id, normalized sender fields, andcreated_at/updated_atwhen available.
customer_id returned here is required for decodeQr, getQuotation, and executePayout.
Field code references:
-
ic_typemust be one of the supported identification document type codes:NIC,PP,WEP,DL. -
occupationmust be one of the supported occupation codes:OCC1throughOCC11.
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
Basic Auth: base64(client_id:client_secret)
Request
Optional. M or F. Required only where a corridor asks for it; returned as a missing field at payout time when needed.
Optional. E.164 format. Required only where a corridor asks for it; returned as a missing field at payout time when needed.
Optional. Required only where a corridor asks for it; returned as a missing field at payout time when needed.
Optional for most corridors. Required for Vietnam (VN), checked at the payer’s first VN payout.
Response
ISO 3166-1 alpha-2 corridor code → true when stored sender profile satisfies that corridor’s requirements.
