/kyc_card

Compare an image extracted from a ID to a selfie image

Endpoint

https://be.progeny.tech/api/v3/services/kyc_card/

Purpose

Allows you to connect to the Liveness, Face Compare, and OCR_Card services, using the providers configured in the Progeny Console, to extract an image from a driving license or ID and compare it to a selfie image.

Please refer to the section on images for guidance before posting. For the best results, we recommend a maximum height of 1080px.

Sample request and response

Get task Id

POST https://be.progeny.tech/api/v3/services/kyc_card/

Request Body

Name	Type	Description
selfie_image*	String	The file path to an image of the user's face in PNG, JPEG, or JPG file format
front_id*	String	Scanned Image of user's ID (front) in PNG, JPEG or JPG file format
back_id*	String	Scanned Image of user's ID (back) in PNG, JPEG, or JPG file format
extend_data	String	Set to true to retrieve the original response from the 3rd-party providers of Liveness, Face Compare, and OCR_Card services

200: OK Success

{
    "id": "08bcb59c-c01c-42b9-b666-44df639cff78"
}

400: Bad Request Image is missing or not in the correct format

{
    "selfie_image": [
        "No file was submitted."
    ],
    "front_id": [
        "No file was submitted."
    ],
    "back_id": [
        "No file was submitted."
    ],
    "extend_data": [
        "This field is required."
    ]
}

Extract an image from a driving license or ID and compare it to a selfie image

GET https://be.progeny.tech/api/v3/services/task/?id={{task_id}}

Path Parameters

Name	Type	Description
id	String	The task Id you obtained from your POST request

200: OK Success

{
    "document": {
        "is_valid": true,
        "is_expired": false,
        "full_name": "ERIKA MUSTERMANN",
        "date_of_birth": "1983-08-12",
        "card_number": "L01XM00CH",
        "country": "Germany",
        "gender": "",
        "marital_status": "",
        "occupation": "",
        "religion": "",
        "portrait": "images/services/ocr_card/1795633768.jpg",
        "portrait_url": "https://be.progeny.tech/media/images/services/ocr_card/1795633768.jpg"
    },
    "compare": true,
    "liveness": true
}

400: Bad Request Image does not meet requirements

{
    "selfie_image": [
        "No file was submitted."
    ],
    "front_id": [
        "No file was submitted."
    ],
    "back_id": [
        "No file was submitted."
    ],
    "extend_data": [
        "This field is required."
    ]
}