Skip to navigation
SQRIL SaaS APIPayout Endpoints

Check Customer

View as Markdown

Retrieves a registered customer profile for the authenticated account.

Authentication:

  • REQUIRED: Basic Auth only.

Query Parameters:

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

Response:

  • Returns flat sender profile fields, customer_id, optional timestamps, and allowed (country code -> boolean).
  • Each key in allowed is an ISO 3166-1 alpha-2 corridor code (e.g. ID, PH, AR, PE). true means the stored sender profile satisfies that corridor’s requirements; false means updateCustomer is needed first.

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.

Peru (PE) extra fields when false: occupation, email, phone, gender.

Vietnam (VN): nationality is required by the rail at the payer’s first VN payout. allowed.VN does not yet reflect it, so send it regardless.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Query parameters

customer_idstringRequired
Customer identifier returned by registerCustomer

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

401
Unauthorized Error
404
Not Found Error