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

Get Checks List

GET
/service/checks/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/checks/list?page=1&per_page=10' \
--header 'X-API-Key: <api-key>'
Response Response Example
{
    "page": 1,
    "per_page": 10,
    "count": 28,
    "result": [
        {
            "id": "2d6afa01-cfa3-4368-aec9-9950ef3fb365",
            "outcome": "attention",
            "reason": "Document back is invalid. & Eye color is missing or cannot be read. & The document uploaded is a fake or sample document, not an authentic document. Matching address from database. & Face mismatch between document photo and selfie photo, similarity score: 0.01.",
            "result": {
                "mrz_text": null,
                "person_age": 31,
                "person_gender": "MALE",
                "person_height": "5'-05\"",
                "person_address1": "2570 24TH STREET",
                "person_address2": "ANYTOWN, CA",
                "document_id_type": "DRIVING_LICENSE",
                "person_eye_color": null,
                "person_full_name": "CHARLIE KIRK",
                "person_last_name": "KIRK",
                "person_post_code": null,
                "person_first_name": "CHARLIE",
                "document_id_number": "03062567",
                "person_middle_name": null,
                "document_expiry_date": "2030-08-31",
                "document_issued_date": "2009-08-31",
                "person_date_of_birth": "1993-10-14",
                "document_country_iso2": "US",
                "document_country_iso3": "USA",
                "document_country_name": "UNITED STATES",
                "person_place_of_birth": null,
                "document_issuing_authority": null,
                "person_nationality_country_iso2": "US",
                "person_nationality_country_iso3": "USA",
                "person_nationality_country_name": "UNITED STATES"
            },
            "warnings": [
                {
                    "code": "INVALID_BACK_DOCUMENT",
                    "decision": "reject",
                    "severity": "high",
                    "confidence": 1,
                    "description": "Document back is invalid."
                },
                {
                    "code": "MISSING_EYE_COLOR",
                    "decision": "accept",
                    "severity": "low",
                    "confidence": 1,
                    "description": "Eye color is missing or cannot be read."
                },
                {
                    "code": "FAKE_ID",
                    "decision": "reject",
                    "severity": "high",
                    "confidence": 1,
                    "description": "The document uploaded is a fake or sample document, not an authentic document. Matching address from database."
                },
                {
                    "code": "FACE_MISMATCH",
                    "decision": "reject",
                    "severity": "high",
                    "confidence": 1,
                    "description": "Face mismatch between document photo and selfie photo, similarity score: 0.01."
                }
            ],
            "created_at": "2025-09-19T16:32:00.317Z",
            "updated_at": "2025-09-19T16:32:00.317Z",
            "deleted_at": null,
            "client": {
                "id": "a5ac2059-39b2-43eb-9df9-e631b025d513",
                "type": 1,
                "email": "michael.brown@example.com",
                "mobile": "+15434622092",
                "external_id": "ext-798113",
                "created_at": "2025-09-19T02:39:44.721Z",
                "updated_at": "2025-09-19T02:39:44.721Z",
                "deleted_at": null,
                "person_details": {
                    "id": "d2dbe748-aeff-4cf6-86c8-6a0cab673736",
                    "first_name": "MICHAEL",
                    "middle_name": "MIDDLE",
                    "last_name": "BROWN",
                    "dob": "1953-04-22",
                    "gender": 2,
                    "nationality": "JP",
                    "birth_country": "JP",
                    "created_at": "2025-09-19T02:39:45.308Z",
                    "updated_at": "2025-09-19T02:39:45.308Z",
                    "deleted_at": null
                }
            },
            "document": {
                "id": "6ef36d58-de7b-4b94-821d-315ef33a5c1d",
                "type": 2,
                "document_number": null,
                "classification": 1,
                "issuing_country": "US",
                "created_at": "2025-09-19T02:40:25.683Z",
                "updated_at": "2025-09-19T02:40:25.683Z",
                "deleted_at": null,
                "attachments": [
                    {
                        "id": "af9566b6-a34a-4dcb-a017-259671dd896f",
                        "mime_type": "image/jpeg",
                        "file_name": "5a3d4578-3eaa-4445-b8c9-8d5e149211f8-document.jpg",
                        "side": 2,
                        "created_at": "2025-09-19T02:40:37.838Z",
                        "updated_at": "2025-09-19T02:40:37.838Z",
                        "deleted_at": null
                    
Modified at 2025-11-27 20:03:00
Previous
Get Check Result
Next
Get Client Latest Check
Built with