CypherFace provides secure APIs to extract data from credit/debit cards and driving licenses using OCR and facial detection, returning encrypted results to protect sensitive data.
🧾 Step-by-Step Integration Flow
📤 Upload Image (Card or DL)
To extract card or driving license details, you must first upload the corresponding image to our secure storage service
You can obtain the upload link by making a request to:
/api/img/generate-url/
In your request, specify the type of document by setting the type field to either "card" or "dl". The response will include a secure upload link along with an image key.
Extract Details from card(debit, credit) or DL
Once the image is uploaded successfully using the provided link, you can initiate the data extraction process by calling one of the following APIs:
POST /api/card/extract/ – to extract credit/debit card details
POST /api/dl/extract/ – to extract driving license details
🔑 Important: IMAGE KEY
To extract card or driving license (DL) details, you need to pass the imageKey in the extraction API request.
This imageKey is the new image key returned by the image upload URL generation API (/api/img/generate-url/). It may differ from the original file name you provided, so always use the imageKey value returned in the response of the upload link generation request.
Failing to use the correct imageKey will result in the system being unable to locate the uploaded image.
For enhanced data privacy and security, all extracted details are returned in encrypted format. To decrypt the data, you will need your merchant-specific encryption key. If you do not have access to this key, please contact the CypherFace support team.