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

Create Check Request

POST
/service/checks

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Body Params application/json

Examples

Responses

🟢201201
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-sandbox.kycsolution.com/api/service/checks' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client": "5f87d422-b178-41fd-a8c4-b17003896e2a",
    "document": "eee5e326-b8f0-44c9-bd46-b84bac7098da",
    "live_photo": "d9fe6e57-bb3a-4561-80f6-e8ec5adc2d59"
}'
Response Response Example
{
    "result": {
        "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."
            }
        ],
        "client": {
            "id": "a5ac2059-39b2-43eb-9df9-e631b025d513"
        },
        "document": {
            "id": "6ef36d58-de7b-4b94-821d-315ef33a5c1d"
        },
        "live_photo": {
            "id": "dd386523-c92d-4e92-b961-8bcdb53f49eb"
        },
        "company": {
            "id": 1
        },
        "id": "2d6afa01-cfa3-4368-aec9-9950ef3fb365",
        "created_at": "2025-09-19T16:32:00.317Z",
        "updated_at": "2025-09-19T16:32:00.317Z",
        "deleted_at": null,
        "screening_results": [
            {
                "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": [],
                "check": {
                    "id": "2d6afa01-cfa3-4368-aec9-9950ef3fb365"
                },
                "id": "188247a3-b842-45db-9be4-a4baa9b68d9f",
                "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
View Live Photo
Next
Get Check Result
Built with