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 Check Result

GET
/service/checks

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 -g --request GET 'https://api-sandbox.kycsolution.com/api/service/checks?id=35748684-5227-44c5-933a-301816cb6ae7' \
--header 'X-API-Key: <api-key>'
Response Response Example
{
    "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
                },
                {
                    "id": "bb95ada7-8ba2-4ae3-86c7-1316dd74cfb5",
                    "mime_type": "image/jpeg",
                    "file_name": "6586785d-690b-42d5-b7d7-bba88a7f6346-document.jpg",
                    "side": 1,
                    "created_at": "2025-09-19T02:40:28.962Z",
                    "updated_at": "2025-09-19T02:40:28.962Z",
                    "deleted_at": null
                }
            ]
        },
        "live_photo": {
            "id": "dd386523-c92d-4e92-b961-8bcdb53f49eb",
            "mime_type": "image/jpeg",
            "file_name": "b419ec8a-e5a7-41b9-ae9f-28203cc688db-photo.jpg",
            "created_at": "2025-09-19T02:40:46.908Z",
            "updated_at": "2025-09-19T02:40:46.908Z",
            "deleted_at": null
        },
        "screening_results": [
            {
                "id": "188247a3-b842-45db-9be4-a4baa9b68d9f",
                "first_name": [
                    "Charlie",
                    "James"
                ],
                "last_name": [
                    "Kirk"
                ],
                "middle_name": [],
                "full_name": [
                    "Чарли Кирк",
                    "Charlie Kirk",
                    "チャーリー・カーク",
                    "查理·科克",
                    "צ'ארלי קירק",
                    "تشارلي كيرك"
                ],
                "alias": [
                    "Charles J. Kirk",
                    "Charles Kirk",
                    "Charles James Kirk"
                ],
                "dob": [
                    "1993-10-14"
                ],
                "note": [
                    "American political activist and radio talk show host"
                ],
                "topic": [
                    "poi",
                    "Person of interest"
                ],
                "birth_place": [
                    "Arlington Heights"
                ],
                "address": [],
                "social_security_number": [],
                "religion": [],
                "death_date": [],
                "education": [
                    "Harper College",
                    "Wheeling High School",
                    "Leadership Institute"
                ],
                "citizenship": [
                    "us"
                ],
                "wikidata_id": [
                    "Q30121972"
                ],
                "gender": [
                    "male"
                ],
                "country": [],
                "classification": [],
                "position": [],
                "created_at": "2025-09-19T16:32:02.821Z",
                "updated_at": "2025-09-19T16:32:02.821Z"
            }
        ]
    }
}
Modified at 2025-11-27 20:03:00
Previous
Create Check Request
Next
Get Checks List
Built with