/ocr_passport
Endpoint
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 |
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 |
Last updated