Progeny Docs
Search…
/kyc
Compare an image extracted from a passport or ID to a selfie image

Endpoint

1
https://be.progeny.tech/api/v2/kyc
Copied!

Purpose

Allows you to compare an image extracted from a passport or ID 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 for a passport

1
curl 'https://be.progeny.tech/api/v2/kyc/'
2
-H 'Authorization: Bearer <access_token>'
3
-F document_type=passport
4
-F selfie_image=@<selfie_image>
5
-F passport_image=@<passport_image>
Copied!

Sample request for an ID

1
curl 'https://be.progeny.tech/api/v2/kyc/'
2
-H 'Authorization: Bearer <access_token>'
3
-F document_type=id
4
-F selfie_image=@<selfie_image>
5
-F front_id=@<front_id_image>
6
-F back_id=@<back_id_image>
Copied!

Path parameters for a passport

Parameter
Type
Comments
document_type
string
The type of document you are comparing the selfie image to. For a passport, this must be passport. For an ID, this must be id
selfie_image
string
The file path to an image of the user's face in PNG, JPEG, or JPG file format
passport_image
string
For a passport, the file path to an image of the user's face in PNG, JPEG, or JPG file format
front_id
string
For an ID, the file path to the image on the user's face on the front of the document in PNG, JPEG, or JPG file format
back_id
string
For an ID, the file path to the image on the user's face on the back of the document in PNG, JPEG, or JPG file format

Successful response

Response
Description
is_valid
true - the uploaded document is a valid passport or ID
false - the uploaded document is not a valid passport or ID
is_expired
true - the uploaded document has expired
false - the uploaded document has not expired
liveness": true/false
true - the uploaded image represents a live human being as opposed to a fake representation
false - the uploaded image represents a fake representation as opposed to a live human being

Unsuccessful response

Response
Description
Resolution
Bad POST
A required parameter is missing from the request or invalid parameter syntax
Check the request to make sure the images for your desired document type passport/ID are present in the request.
Check the syntax against the sample response

Sample response for an ID

1
{
2
"document": {
3
"Issuing State Code": "AUS",
4
"Document Number": "U0996738",
5
"Date of Expiry": "2011-12-25",
6
"Date of Issue": "2008-12-25",
7
"Date of Birth": "1979-06-07",
8
"Place of Birth": "MELBOURNE",
9
"Surname": "CITIZEN",
10
"Given Names": "JANE",
11
"Nationality": "UTO",
12
"Sex": "F",
13
"Authority": "AUSTRALIA",
14
"Surname and Given Names": "CITIZEN JANE",
15
"Nationality Code": "UTO",
16
"MRZ Strings With Correct CheckSums": "P<AUSCITIZEN<<JANE<<<<<<<<<<<<<<<<<<<<<<<<<<^U0996738<2UTO7906075F1112256<50013871L<<<<68",
17
"Age": "41",
18
"is_valid": true,
19
"is_expired": false,
20
},
21
"liveness": true
22
}
Copied!
Last modified 11mo ago
Copy link
Contents