/ocr_passport

Endpoint

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

Purpose

Allows you to connect to the OCR_Card service, using the provider configured in the Progeny Console, to extract an image from a passport.

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 a task Id

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

Request Body

Name	Type	Description
passport_image*	String	The file path to an image of the passport page in PNG, JPEG, or JPG file format
extend_data	String	Set to true to retrieve the original response from the 3rd-party provider of the OCR_Card service

200: OK Success

{
    "id": "efe46711-b1d8-43f1-9d02-7a54c43b79a2"
}

400: Bad Request

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

Extract an image from a passport

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

{
    "id": 2188,
    "status": "SUCCESS",
    "result": {
        "status": 200,
        "data": {
            "document": {
                "is_valid": true,
                "is_expired": false,
                "dateOfBirth": "1991-9-24",
                "age": 30,
                "firstName": "VALERIA",
                "lastName": "PERFILOVA",
                "dateOfIssue": "None-None-None",
                "dateOfExpiry": "2023-9-25",
                "documentNumber": "XX008080",
                "sex": "F",
                "nationality": "UKRAINIAN",
                "portrait": "images/services/ocr_passport/9456633680.jpg",
                "portrait_url": "https://dev.progeny.tech/media/images/services/ocr_passport/9456633680.jpg"
            },
            "compare": true,
            "liveness": true
        }
    }
}