Progeny Docs
  • Welcome
  • Our solution
  • Use cases
  • API reference
    • Overview
    • /token/obtain
    • /register_face
    • /authenticate_face
    • /face_liveness
    • /ocr_card
    • /ocr_passport
    • /kyc_card
    • /kyc_passport
    • /background_check
    • /kyc_card_with_background_check
    • /kyc_passport_with_background_check
  • Frequently asked questions
Powered by GitBook
On this page
  • Get task Id
  • Extract an image from a driving license or ID

Was this helpful?

  1. API reference

/ocr_card

Previous/face_livenessNext/ocr_passport

Last updated 3 years ago

Was this helpful?

Endpoint

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

Purpose

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

Please refer to the section on 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/ocr_card/

Request Body

Name
Type
Description

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 provider of the OCR_Card service

{
    "id": "08bcb59c-c01c-42b9-b666-44df639cff78"
}
{
    "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

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

{
    // Response
}
{
    // Response
}
images