https://be.progeny.tech/api/v2/kyc
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.
curl 'https://be.progeny.tech/api/v2/kyc/'-H 'Authorization: Bearer <access_token>'-F document_type=passport-F selfie_image=@<selfie_image>-F passport_image=@<passport_image>
curl 'https://be.progeny.tech/api/v2/kyc/'-H 'Authorization: Bearer <access_token>'-F document_type=id-F selfie_image=@<selfie_image>-F front_id=@<front_id_image>-F back_id=@<back_id_image>
Parameter | Type | Comments |
document_type | string | The type of document you are comparing the selfie image to. For a passport, this must be |
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 |
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 |
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 |
{"document": {"Issuing State Code": "AUS","Document Number": "U0996738","Date of Expiry": "2011-12-25","Date of Issue": "2008-12-25","Date of Birth": "1979-06-07","Place of Birth": "MELBOURNE","Surname": "CITIZEN","Given Names": "JANE","Nationality": "UTO","Sex": "F","Authority": "AUSTRALIA","Surname and Given Names": "CITIZEN JANE","Nationality Code": "UTO","MRZ Strings With Correct CheckSums": "P<AUSCITIZEN<<JANE<<<<<<<<<<<<<<<<<<<<<<<<<<^U0996738<2UTO7906075F1112256<50013871L<<<<68","Age": "41","is_valid": true,"is_expired": false,},"liveness": true}