KYC Solution API Documentation
  1. Documents
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. Documents

Get Documents List

GET
/service/documents/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/documents/list?page=1&per_page=10' \
--header 'X-API-Key: <api-key>'
Response Response Example
{
    "page": 1,
    "per_page": 10,
    "count": 145,
    "result": [
        {
            "id": "1553351d-5d62-4b97-b858-992d52b4e6e4",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "GB",
            "created_at": "2025-09-02T10:46:18.719Z",
            "updated_at": "2025-09-02T10:46:18.719Z",
            "deleted_at": null,
            "client": {
                "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
                }
            },
            "attachments": [
                {
                    "id": "259b6e4c-54e8-45da-bfe5-b6eccc45addd",
                    "mime_type": "image/jpeg",
                    "file_name": "fba4d571-dbe8-4411-9a30-8be7d632803d-document.jpg",
                    "side": 1,
                    "created_at": "2025-09-02T10:46:19.929Z",
                    "updated_at": "2025-09-02T10:46:19.929Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "2a3666d2-47f3-4a9a-a362-0bf111d983ab",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "GB",
            "created_at": "2025-09-02T10:05:10.353Z",
            "updated_at": "2025-09-02T10:05:10.353Z",
            "deleted_at": null,
            "client": {
                "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
                }
            },
            "attachments": [
                {
                    "id": "056befce-c1ab-4b45-a5fd-4d5a602d105c",
                    "mime_type": "image/jpeg",
                    "file_name": "b7bb6740-a755-4861-ad63-549b98909fcd-document.jpg",
                    "side": 1,
                    "created_at": "2025-09-02T10:05:11.362Z",
                    "updated_at": "2025-09-02T10:05:11.362Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "60f25e98-41f5-4898-997c-4e8fea7b85cf",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "GB",
            "created_at": "2025-08-25T09:24:14.479Z",
            "updated_at": "2025-08-25T09:24:14.479Z",
            "deleted_at": null,
            "client": {
                "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
                }
            },
            "attachments": [
                {
                    "id": "875c847c-a6ad-4be4-8f20-2d0d7d7b8d3d",
                    "mime_type": "image/jpeg",
                    "file_name": "627e33b2-a3f3-498d-9f06-2dadc26e1e58-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-25T09:24:18.775Z",
                    "updated_at": "2025-08-25T09:24:18.775Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "f29bb045-2196-4594-a628-007361ed1b9a",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "GB",
            "created_at": "2025-08-21T00:53:40.324Z",
            "updated_at": "2025-08-21T00:53:40.324Z",
            "deleted_at": null,
            "client": {
                "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
                }
            },
            "attachments": [
                {
                    "id": "dd981a18-67dc-4028-8953-abc39b298e02",
                    "mime_type": "image/jpeg",
                    "file_name": "fb854590-444c-406b-8954-e664d4693969-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-21T00:54:03.534Z",
                    "updated_at": "2025-08-21T00:54:03.534Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "8203bac8-7357-4232-81a4-cbf571d7388b",
            "type": 3,
            "document_number": null,
            "classification": 1,
            "issuing_country": "DE",
            "created_at": "2025-08-20T07:04:32.370Z",
            "updated_at": "2025-08-20T07:04:32.370Z",
            "deleted_at": null,
            "client": {
                "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
                }
            },
            "attachments": [
                {
                    "id": "5e8e6fe7-c461-4fe4-96da-dc9f86fad34e",
                    "mime_type": "image/jpeg",
                    "file_name": "c0476c12-e70f-4b36-8fdd-4975a9711f7c-document.jpg",
                    "side": 2,
                    "created_at": "2025-08-20T07:04:40.208Z",
                    "updated_at": "2025-08-20T07:04:40.208Z",
                    "deleted_at": null
                },
                {
                    "id": "49bcb7d2-c52a-4b29-bd14-6dd72cfe0a78",
                    "mime_type": "image/jpeg",
                    "file_name": "734ab40e-e7db-4e51-921e-6dc353e99b98-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-20T07:04:32.717Z",
                    "updated_at": "2025-08-20T07:04:32.717Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "7818c7c7-8485-4b17-a8d8-3d062115310c",
            "type": 3,
            "document_number": null,
            "classification": 1,
            "issuing_country": "DE",
            "created_at": "2025-08-20T06:31:48.249Z",
            "updated_at": "2025-08-20T06:31:48.249Z",
            "deleted_at": null,
            "client": {
                "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
                }
            },
            "attachments": [
                {
                    "id": "9e32d980-15c6-41d7-b582-ec6dd9178c46",
                    "mime_type": "image/jpeg",
                    "file_name": "7274305f-87c2-4630-b56d-8eff56dc03bd-document.jpg",
                    "side": 2,
                    "created_at": "2025-08-20T06:31:53.792Z",
                    "updated_at": "2025-08-20T06:31:53.792Z",
                    "deleted_at": null
                },
                {
                    "id": "0e9e9f87-f27a-4166-ab4c-0cc6521f9cd7",
                    "mime_type": "image/jpeg",
                    "file_name": "9ea56955-4970-47f7-bed7-9e72ce9ba389-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-20T06:31:48.575Z",
                    "updated_at": "2025-08-20T06:31:48.575Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "83b400a2-b4dc-47c8-bac9-2341f98b909d",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "AR",
            "created_at": "2025-08-19T11:13:28.118Z",
            "updated_at": "2025-08-19T11:13:28.118Z",
            "deleted_at": null,
            "client": {
                "id": "2feea1a8-97f9-47a1-990c-14d25642447f",
                "type": 1,
                "email": "david.smith@example.com",
                "mobile": "+14326525988",
                "external_id": "ext-713736",
                "created_at": "2025-08-19T11:12:41.539Z",
                "updated_at": "2025-08-19T11:12:41.539Z",
                "deleted_at": null,
                "person_details": {
                    "id": "0350c063-bb60-43dd-a0fd-496464911c8c",
                    "first_name": "DAVID",
                    "middle_name": null,
                    "last_name": "SMITH",
                    "dob": "2002-11-07",
                    "gender": 1,
                    "nationality": "CN",
                    "birth_country": "CN",
                    "created_at": "2025-08-19T11:12:41.587Z",
                    "updated_at": "2025-08-19T11:12:41.587Z",
                    "deleted_at": null
                }
            },
            "attachments": [
                {
                    "id": "13d7a2a0-1ae3-4a23-9b81-11237633e806",
                    "mime_type": "image/jpeg",
                    "file_name": "345e659a-0483-4e0b-9cae-2b09c617b8c9-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-19T11:13:29.218Z",
                    "updated_at": "2025-08-19T11:13:29.218Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "74767f1c-2a20-448c-b348-dbb6554fe1a6",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "GB",
            "created_at": "2025-08-19T03:53:58.078Z",
            "updated_at": "2025-08-19T03:53:58.078Z",
            "deleted_at": null,
            "client": {
                "id": "323ddaee-c40d-469c-a19a-f9ad34d8170a",
                "type": 1,
                "email": "jane.williams@example.com",
                "mobile": "+14004538557",
                "external_id": "ext-267228",
                "created_at": "2025-08-19T03:52:03.819Z",
                "updated_at": "2025-08-19T03:52:03.819Z",
                "deleted_at": null,
                "person_details": {
                    "id": "d25657eb-6f84-412b-81fc-f026a1474a66",
                    "first_name": "JANE",
                    "middle_name": null,
                    "last_name": "WILLIAMS",
                    "dob": "1985-11-12",
                    "gender": 1,
                    "nationality": "FR",
                    "birth_country": "FR",
                    "created_at": "2025-08-19T03:52:03.848Z",
                    "updated_at": "2025-08-19T03:52:03.848Z",
                    "deleted_at": null
                }
            },
            "attachments": [
                {
                    "id": "0aa11182-c4df-41f8-be4b-8d1386871ee0",
                    "mime_type": "image/jpeg",
                    "file_name": "664fc703-cf38-49c8-9b24-2e02e97d51e2-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-19T03:54:00.596Z",
                    "updated_at": "2025-08-19T03:54:00.596Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "eecb9b1b-949a-4bb0-ba38-ca9809e97fbc",
            "type": 3,
            "document_number": null,
            "classification": 1,
            "issuing_country": "DE",
            "created_at": "2025-08-19T03:45:09.134Z",
            "updated_at": "2025-08-19T03:45:09.134Z",
            "deleted_at": null,
            "client": {
                "id": "a8c07407-45ad-41d2-b8f1-08d13d177a91",
                "type": 1,
                "email": "michael.jones@example.com",
                "mobile": "+11426656540",
                "external_id": "ext-819612",
                "created_at": "2025-08-19T03:44:56.570Z",
                "updated_at": "2025-08-19T03:44:56.570Z",
                "deleted_at": null,
                "person_details": {
                    "id": "653053b1-5ba4-4c5e-a288-6e53fedff9a4",
                    "first_name": "MICHAEL",
                    "middle_name": null,
                    "last_name": "JONES",
                    "dob": "1996-08-08",
                    "gender": 1,
                    "nationality": "IN",
                    "birth_country": "IN",
                    "created_at": "2025-08-19T03:44:56.593Z",
                    "updated_at": "2025-08-19T03:44:56.593Z",
                    "deleted_at": null
                }
            },
            "attachments": [
                {
                    "id": "650db877-86db-4d39-be63-b5c35ab3fd50",
                    "mime_type": "image/jpeg",
                    "file_name": "6b500ef7-7694-48d2-b354-e8e7f99454eb-document.jpg",
                    "side": 2,
                    "created_at": "2025-08-19T03:45:15.470Z",
                    "updated_at": "2025-08-19T03:45:15.470Z",
                    "deleted_at": null
                },
                {
                    "id": "f8384224-9431-480a-80c5-23ff334ab59f",
                    "mime_type": "image/jpeg",
                    "file_name": "815433fe-07b2-4ddb-89f6-6d96c2847a62-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-19T03:45:09.608Z",
                    "updated_at": "2025-08-19T03:45:09.608Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": "81e19d59-6b85-49e4-a750-4ab491f3f192",
            "type": 1,
            "document_number": null,
            "classification": 1,
            "issuing_country": "GB",
            "created_at": "2025-08-19T03:23:29.573Z",
            "updated_at": "2025-08-19T03:23:29.573Z",
            "deleted_at": null,
            "client": {
                "id": "0fefd683-9383-4cc6-864c-f4c324933da0",
                "type": 1,
                "email": "emily.williams@example.com",
                "mobile": "+16700901674",
                "external_id": "ext-724520",
                "created_at": "2025-08-19T03:23:17.948Z",
                "updated_at": "2025-08-19T03:23:17.948Z",
                "deleted_at": null,
                "person_details": {
                    "id": "b149f49b-5f89-4f89-bf7f-09302e5b9194",
                    "first_name": "EMILY",
                    "middle_name": null,
                    "last_name": "WILLIAMS",
                    "dob": "1981-01-28",
                    "gender": 1,
                    "nationality": "FR",
                    "birth_country": "FR",
                    "created_at": "2025-08-19T03:23:17.981Z",
                    "updated_at": "2025-08-19T03:23:17.981Z",
                    "deleted_at": null
                }
            },
            "attachments": [
                {
                    "id": "54b507bb-7e62-4f5d-8306-7c1dbfabeb8a",
                    "mime_type": "image/jpeg",
                    "file_name": "02fc67cd-90e2-44eb-8547-6087684412cd-document.jpg",
                    "side": 1,
                    "created_at": "2025-08-19T03:23:30.359Z",
                    "updated_at": "2025-08-19T03:23:30.359Z",
                    "deleted_at": null
                }
            ]
        }
    ]
}
Modified at 2025-11-27 20:03:00
Previous
Add Document Attachment
Next
Get Document
Built with