List all customers

GET/customers

Returns a list of customers with their KYC details. Use page query parameter for pagination.

Query Parameters

pageinteger

Specify the page number

emailstring

Filter customers by email address

Response

OK

idstring<uuid>

Unique ID for the Customer KYC record created

namestring

Name of the Customer

emailstring<email>

Email of the customer

dobstring<date>

Date of Birth of the customer

genderstring

Gender of the Customer

country_codestring

Country Code for the Country of Customer

kyc_statusstring

KYC status of the Customer after the details are inspected. verified or blocked

kyc_tiernumber

Tier of the customer set based on KYC details provided

retries_leftinteger
poiobject[]
Show poi properties
idstring<uuid>
created_atstring<date-time>
statusstring

Verification status of uploaded POI. accepted declined pending waiting_for_upload

declined_reasonstring
transaction_limitstring

Amount allowed in each transaction (in SGD)

Invalid/Expired Access Token

messagestring
errorsobject[]
Show errors properties
pathstring
messagestring

Server Error

messagestring
Request
curl -X GET "https://api.triple-a.work/kyc-api/v1/customers?page=<page>&email=<email>" \
  -H "Authorization: Bearer <token>"
Response
[
  {
    "id": "4d37cbdc-9dbb-4604-82a7-8f8753366a68",
    "name": "John Doe",
    "email": "[email protected]",
    "dob": null,
    "gender": null,
    "country_code": "US",
    "kyc_status": "verified",
    "kyc_tier": 1,
    "retries_left": 2,
    "poi": [],
    "transaction_limit": "1500 SGD"
  },
  {
    "id": "3ffa4a2c-1c3e-4ee3-a97b-22d6d323eab4",
    "name": "Jane Doe",
    "email": "[email protected]",
    "dob": "1991-05-04",
    "gender": "male",
    "country_code": "IN",
    "kyc_status": "blocked",
    "kyc_tier": 2,
    "retries_left": 1,
    "poi": [
      {
        "id": "a7d6016f-8b49-4e05-9a9c-08d4fc4e0644",
        "created_at": "2023-05-10T07:05:37.681Z",
        "status": "accepted",
        "declined_reason": null
      },
      {
        "id": "40d76a2e-7f39-46f5-924e-3a53af42e9b8",
        "created_at": "2023-05-03T05:52:03.821Z",
        "status": "declined",
        "declined_reason": "The document is expired, please upload a new document which is not expired"
      }
    ]
  }
]