What is CheckpointID’s DVS?
The Document Verification Service (DVS):
By comparing barcode fields from the back of an ID with recognized fields from the ID’s front side, as well as comparing the ID’s face image with the anti-spoof checked selfie image, the document’s general level of trust is calculated. If our Web Library is used on the client side in conjunction with the DVS server, image preprocessing and a liveness check of the selfie image may also be performed prior to sending it to the DVS.
Where can I find my API keys for the DVS?
Email support@checkpointid.com for your credentials.
Authorization Key Example | |
Public Key: Private Key (Secret Key): Web Library Key: |
pk_fc565030-a890-4945-a490-e1841847951d sk_f7db9cee-8455-4f10-b772-571d31265b5b wlk_f7db9cee-8455-4f10-b772-571d31265b5b |
Options for DVS Integration
Simple Integration (via REST API)
Provide your own client code, simply send image data to the DVS service, and receive a verification response all via the DVS REST API. All image processing occurs on the DVS server. Anti-Spoofing of the selfie image is included on the server side, liveness check of selfie image not available.
Guidance re: implementation architecture for Simple Verification:
- Use the Secret Key (provided above) to send ID image(s) and a selfie image as a single API request from your backend server directly to the DVS server;
- Simply wait for a response from the DVS server while it performs verification of the data;
- Receive a Verification Response from the DVS that includes the results from the verification process including a general level of trust;
Enhanced Integration (via REST API)
Enhanced Integration enables increased efficiency of image processing by creating a cue which your backend application can send requests to, as opposed to the Simple Integration approach, where your application must simply wait on the initial request to receive a response.
Use the Public Key (provided above) to create a Verification Request and upload ID image(s) and selfie image to the DVS server;
The DVS server will return the request_id and status of the request you have just created. Use the request_id in your application logic;
Send the request_id and the Private key from your backend to the DVS server via the [Verify API] to receive the results of the verification process, including the general level of trust;
Receive the content and metadata from the image processing by sending your request_id via the Content API.
Web Library
CheckpointID Web Library for DVS provides client applications the ability to leverage built-in image capture tools. When using the Web Library, image preprocessing occurs locally within the client application, reducing the image data payload that is sent to the DVS server. This increases the efficiency of the service by eliminating the risk of sending erroneous images to the DVS and also removes the need for images to be passed to the server multiple times.
The Web library assists in the image capture process, performing a liveness check on the capture of the selfie image as well as providing immediate feedback re: image cropping and lighting. CheckpointID recommends using this pluggable JS library as the primary method of integrating our DVS into your application.
Prerequisites for Image Capture via Web Library:
Use a smartphone camera with at least 5 MP resolution;
Capture images in a well lit room;
Place the document on a uniform dark background while capturing image;
When capturing via a webcam on an iPhone, Safari is the only supported browser;
When capturing via a webcam on an Android device, Chrome is the only supported browser;
Library is approximately 10MB;
iOS (v. x.xx) / Android OS (v. x.xx);
There are 2 implementation architecture options available when utilizing the Web Library. Very important to note: Instead of sending the private key directly to the DVS as shown in the Simple Integration guidance re: implementation architecture, the Public Key must always be used when making requests from your client application. Do not share the Private Key in your client code or in a public repository (Github, etc).
Guidance re: implementation architecture when utilizing the Web Library:
Option A (Enhanced Integration)
• Option A is our preferred method of implementation because it enables increased efficiency by creating a cue which your backend application can send requests to, as opposed to option B, where your application must wait on the initial request;
Insert the Web Library Key (provided above) into the HTML/JS of your client application;
Use the Public Key (provided above) to create a Verification Request and upload ID image(s) and selfie image to the DVS server;
The DVS server will return the request_id and status of the request you have just created. Use the request_id in your application logic;
Send the request_id and the Private key from your backend to the DVS server via the Verify API to receive the results of the verification process, including the general level of trust;
Receive the content and metadata from the image processing by sending your request_id via the Content API.
Option B (Simple Integration)
Option B is the most simple way to integrate our DVS API, but it’s a little less efficient. If you ask us, we prefer Option A;
Insert the Web Library Key (provided above) into the HTML/JS of your client application;
Use the Secret Key (provided above) to send ID image(s) and a selfie image as a single API request directly to the DVS server;
Simply wait for a response from the DVS server while it performs verification of the data;
Receive a Verification Response from the DVS that includes the results from the verification process including a general level of trust.
Samples
DVS Hosting
For any of the integration methods above, the DVS server may be hosted on CheckpointID’s secure cloud environment or within a customer’s Private Cloud / On Premise deployment.
To learn more about CheckpointID’s secure cloud environment or how CheckpointID's DVS server can be deployed on premise / within your own Private Cloud, please reach out to us at support@checkpointid.com