KYC Solution API Documentation
  1. Clients
KYC Solution API Documentation
  • 📘 Enum Reference
  • Clients
    • Create Client
      POST
    • Get Clients List
      GET
    • Get Client
      GET
  • Documents
    • Add Document
      POST
    • Add Document Attachment
      POST
    • Get Documents List
      GET
    • Get Document
      GET
    • View Document Attachment
      GET
  • Live Photos
    • Add Live Photo
      POST
    • Get Live Photos List
      GET
    • Get Live Photo
      GET
    • View Live Photo
      GET
  • Checks
    • Create Check Request
      POST
    • Get Check Result
      GET
    • Get Checks List
      GET
    • Get Client Latest Check
      GET
  1. Clients

Get Clients List

GET
/service/clients/list

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Query Params

Responses

🟢200200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.kycsolution.com/api/service/clients/list?page=1&per_page=10' \
--header 'X-API-Key: <api-key>'
Response Response Example
{
    "page": 1,
    "per_page": 10,
    "count": 286,
    "result": [
        {
            "id": "1577bd5a-a01f-4c97-b809-6db73f7733f7",
            "type": 1,
            "email": "david.brown@example.com",
            "mobile": "+12252387559",
            "external_id": "ext-340121",
            "created_at": "2025-09-05T02:25:13.646Z",
            "updated_at": "2025-09-05T02:25:13.646Z",
            "deleted_at": null,
            "person_details": {
                "id": "86481881-e042-49dd-86b9-1398194fae8c",
                "first_name": "DAVID",
                "middle_name": "MIDDLE",
                "last_name": "BROWN",
                "dob": "1984-08-22",
                "gender": 2,
                "nationality": "DE",
                "birth_country": "DE",
                "created_at": "2025-09-05T02:25:13.841Z",
                "updated_at": "2025-09-05T02:25:13.841Z",
                "deleted_at": null
            }
        },
        {
            "id": "f21aa885-e2ab-4080-bd0b-d54fe3cf5fa6",
            "type": 1,
            "email": "jane.brown@example.com",
            "mobile": "+15777241555",
            "external_id": "ext-566592",
            "created_at": "2025-09-02T10:45:13.463Z",
            "updated_at": "2025-09-02T10:45:13.463Z",
            "deleted_at": null,
            "person_details": {
                "id": "1b5d3701-17b1-4a5f-b9a0-1aca05b4401d",
                "first_name": "JANE",
                "middle_name": "MIDDLE",
                "last_name": "BROWN",
                "dob": "1991-01-28",
                "gender": 2,
                "nationality": "IN",
                "birth_country": "IN",
                "created_at": "2025-09-02T10:45:13.487Z",
                "updated_at": "2025-09-02T10:45:13.487Z",
                "deleted_at": null
            }
        },
        {
            "id": "a59e7fdc-55dd-4d51-be90-a3863bdee459",
            "type": 1,
            "email": "michael.smith@example.com",
            "mobile": "+13701278832",
            "external_id": "ext-163093",
            "created_at": "2025-09-02T10:44:55.882Z",
            "updated_at": "2025-09-02T10:44:55.882Z",
            "deleted_at": null,
            "person_details": {
                "id": "1cf00505-a2d8-4a0d-84bd-1fce95674ed1",
                "first_name": "MICHAEL",
                "middle_name": null,
                "last_name": "SMITH",
                "dob": "1998-06-15",
                "gender": 2,
                "nationality": "JP",
                "birth_country": "JP",
                "created_at": "2025-09-02T10:44:55.954Z",
                "updated_at": "2025-09-02T10:44:55.954Z",
                "deleted_at": null
            }
        },
        {
            "id": "84ebe1d6-cb2a-47b3-9923-21bf6852554e",
            "type": 1,
            "email": "david.brown@example.com",
            "mobile": "+11729823122",
            "external_id": "ext-77565",
            "created_at": "2025-09-02T10:04:48.606Z",
            "updated_at": "2025-09-02T10:04:48.606Z",
            "deleted_at": null,
            "person_details": {
                "id": "d8627c12-78de-43e3-977a-94488ca2652e",
                "first_name": "DAVID",
                "middle_name": null,
                "last_name": "BROWN",
                "dob": "1956-09-18",
                "gender": 2,
                "nationality": "US",
                "birth_country": "US",
                "created_at": "2025-09-02T10:04:48.633Z",
                "updated_at": "2025-09-02T10:04:48.633Z",
                "deleted_at": null
            }
        },
        {
            "id": "9ee45b42-9df6-4142-bd45-3f9ae184f767",
            "type": 1,
            "email": "emily.brown@example.com",
            "mobile": "+14432146844",
            "external_id": "ext-530879",
            "created_at": "2025-09-02T02:42:48.253Z",
            "updated_at": "2025-09-02T02:42:48.253Z",
            "deleted_at": null,
            "person_details": {
                "id": "b73a4a93-7c1f-4adf-809a-87ad30fe1336",
                "first_name": "EMILY",
                "middle_name": "MIDDLE",
                "last_name": "BROWN",
                "dob": "1967-08-08",
                "gender": 1,
                "nationality": "IN",
                "birth_country": "IN",
                "created_at": "2025-09-02T02:42:48.359Z",
                "updated_at": "2025-09-02T02:42:48.359Z",
                "deleted_at": null
            }
        },
        {
            "id": "3d39190d-6ae1-43da-a141-893fd825a77e",
            "type": 1,
            "email": "jane.jones@example.com",
            "mobile": "+13434551567",
            "external_id": "ext-557622",
            "created_at": "2025-08-25T13:41:59.211Z",
            "updated_at": "2025-08-25T13:41:59.211Z",
            "deleted_at": null,
            "person_details": {
                "id": "b42be3a5-b113-4624-bae2-f0798970d5dd",
                "first_name": "JANE",
                "middle_name": null,
                "last_name": "JONES",
                "dob": "1958-11-06",
                "gender": 2,
                "nationality": "DE",
                "birth_country": "DE",
                "created_at": "2025-08-25T13:41:59.242Z",
                "updated_at": "2025-08-25T13:41:59.242Z",
                "deleted_at": null
            }
        },
        {
            "id": "78b77f19-a645-4c5a-b8e1-06919a6dd4a8",
            "type": 1,
            "email": "sarah.williams@example.com",
            "mobile": "+19122822084",
            "external_id": "ext-963280",
            "created_at": "2025-08-25T09:23:36.212Z",
            "updated_at": "2025-08-25T09:23:36.212Z",
            "deleted_at": null,
            "person_details": {
                "id": "e55cad07-ee8a-4675-bc1e-938989df04b1",
                "first_name": "SARAH",
                "middle_name": "MIDDLE",
                "last_name": "WILLIAMS",
                "dob": "1977-03-16",
                "gender": 1,
                "nationality": "CA",
                "birth_country": "CA",
                "created_at": "2025-08-25T09:23:36.360Z",
                "updated_at": "2025-08-25T09:23:36.360Z",
                "deleted_at": null
            }
        },
        {
            "id": "7bd2078b-18d8-4d76-ac07-e5cee8abdd37",
            "type": 1,
            "email": "john.brown@example.com",
            "mobile": "+12706627398",
            "external_id": "ext-363023",
            "created_at": "2025-08-21T00:53:23.910Z",
            "updated_at": "2025-08-21T00:53:23.910Z",
            "deleted_at": null,
            "person_details": {
                "id": "6c5fc3a7-9161-41c5-8c7f-0196ba1868e6",
                "first_name": "JOHN",
                "middle_name": null,
                "last_name": "BROWN",
                "dob": "1960-12-29",
                "gender": 1,
                "nationality": "BR",
                "birth_country": "BR",
                "created_at": "2025-08-21T00:53:24.163Z",
                "updated_at": "2025-08-21T00:53:24.163Z",
                "deleted_at": null
            }
        },
        {
            "id": "d6751e63-db50-4d01-b0eb-793c8f0d389f",
            "type": 1,
            "email": "jane.jones@example.com",
            "mobile": "+12244494500",
            "external_id": "ext-881800",
            "created_at": "2025-08-20T07:02:57.536Z",
            "updated_at": "2025-08-20T07:02:57.536Z",
            "deleted_at": null,
            "person_details": {
                "id": "365eed00-1817-4e3e-8df3-21b408396508",
                "first_name": "JANE",
                "middle_name": null,
                "last_name": "JONES",
                "dob": "1972-03-08",
                "gender": 1,
                "nationality": "FR",
                "birth_country": "FR",
                "created_at": "2025-08-20T07:02:57.575Z",
                "updated_at": "2025-08-20T07:02:57.575Z",
                "deleted_at": null
            }
        },
        {
            "id": "c383d584-b627-4839-b1dd-fe440d3e2e2c",
            "type": 1,
            "email": "michael.jones@example.com",
            "mobile": "+12174376537",
            "external_id": "ext-151735",
            "created_at": "2025-08-20T06:31:29.431Z",
            "updated_at": "2025-08-20T06:31:29.431Z",
            "deleted_at": null,
            "person_details": {
                "id": "8db01353-5e0b-4513-befe-6266a885ce2e",
                "first_name": "MICHAEL",
                "middle_name": null,
                "last_name": "JONES",
                "dob": "1977-09-22",
                "gender": 1,
                "nationality": "JP",
                "birth_country": "JP",
                "created_at": "2025-08-20T06:31:29.485Z",
                "updated_at": "2025-08-20T06:31:29.485Z",
                "deleted_at": null
            }
        }
    ]
}
Modified at 2025-11-27 20:03:00
Previous
Create Client
Next
Get Client
Built with