API Documentation

Photo ID Verification

4min

This service allows you verify different types of data using submitted images of a Photo ID as well as a selfie image of a user holding a photo ID. You can choose to just verify the validity and possesion of the ID document, or you can pass additional information such as name, address, and DOB and request that that data is verified alongside the ID.
If you have a BlueCheck domain token you can try out the API in the Swagger utility below. Just click the "Authorize" button and add in you domain token after the entering the "Bearer" prefix. If you do not have a domain token, you can ﻿register for one here.﻿
Field Reference
You can find descriptions for the fields used in the verification order, verification, data, and config objects used by the API. Click on the headings to expand the objects.
Field / Object
Description
status
There are three statuses:

New: The verification order has been created, but the images have nit yet been submitted and the order has not been billed.
Processing: The images have been submitted and the verification is now under way.
Completed: The verification process is finished.
uuid
A unique identifier for the order provided by BlueCheck. Can be used to look up the order using the Get method.
external_id
An identifier provided by the client. Used to link the order to client records.
notification_url
The url used for webhook notifications.
return_url
The url the user returns to after completing verification. Note: This is only if the verification is completed using the public url.
public_url
A url where the user can go to upload the documents needed to complete the verification.
type
The type of verification being performed, in this case "photo_id"
created_at
The time the verification orders was created.
updated_at
The time of the last update to the verification order.
﻿
﻿
uuid
A unique identifier for the verification provided by BlueCheck. Can be used to look up the order using the Get method.
workflow
The type of verification to be performed.
process
Either auto or manual, depending if human review was used during the verification process.
status
There are three statuses:

Waiting: The verification is waiting on additional information and or data from the user.
Pending: BlueCheck is currently processing the verification.
Approved: The verification has been completed and the data was verified.
Rejected: The verification has been completed but the data could not be verified.
Cancelled: If BlueCheck does not receive the data to complete the verification before the TTL time expires, the verification is cancelled and unable to be completed by the end user.
reason
If the verification fails, a reason is returned giving more info on why the user failed. 
expires_at
The timestamp when the verification will expire and no longer be able to be completed.
created_at
The timestamp when the verification was created.
updated_at
The timestamp for the last time the verification was updated.
﻿
﻿
email
The email of the user being verified. This field is always required.
phone
The phone number of the user being verified. Should be submitted in the +11234567890 format.
address
The address object. This object contains all of the fields composing the users full address.
line_1
The first line of the user's street address. Ex 123 Main Street.
line_2
Any additional street address information. Ex. Apt #12
city
The city of the user.
postal_code
The postal code or zip code of the user's address.
disctrict
The state, province, region, etc where the 
country
The name of the user's Country/
﻿
﻿
max_attempts
The maximum number of attempts the user has to submit data to complete the verification. 
checkups
The additional data fields that are to be verified. This endpoint supports name, address, and date of birth.
document_liveness
The threshold score required to pass BlueCheck's automated document livliness AI. The default is 0.8.
face_detection
The number of faces required to be detected by face BlueCheck's face detection AI. The default is 2 - we recommend using 2 or 3 here.
face_comparison
The number of matched faces required to pass BlueCheck's face comparison AI. The default is 2 - we recommend using 2 or 3 her
﻿
Try It Out
Loading...
Loading...
﻿
﻿

Field / Object	Description
status	There are three statuses: New: The verification order has been created, but the images have nit yet been submitted and the order has not been billed. Processing: The images have been submitted and the verification is now under way. Completed: The verification process is finished.
uuid	A unique identifier for the order provided by BlueCheck. Can be used to look up the order using the Get method.
external_id	An identifier provided by the client. Used to link the order to client records.
notification_url	The url used for webhook notifications.
return_url	The url the user returns to after completing verification. Note: This is only if the verification is completed using the public url.
public_url	A url where the user can go to upload the documents needed to complete the verification.
type	The type of verification being performed, in this case "photo_id"
created_at	The time the verification orders was created.
updated_at	The time of the last update to the verification order.


uuid	A unique identifier for the verification provided by BlueCheck. Can be used to look up the order using the Get method.
workflow	The type of verification to be performed.
process	Either auto or manual, depending if human review was used during the verification process.
status	There are three statuses: Waiting: The verification is waiting on additional information and or data from the user. Pending: BlueCheck is currently processing the verification. Approved: The verification has been completed and the data was verified. Rejected: The verification has been completed but the data could not be verified. Cancelled: If BlueCheck does not receive the data to complete the verification before the TTL time expires, the verification is cancelled and unable to be completed by the end user.
reason	If the verification fails, a reason is returned giving more info on why the user failed.
expires_at	The timestamp when the verification will expire and no longer be able to be completed.
created_at	The timestamp when the verification was created.
updated_at	The timestamp for the last time the verification was updated.


email	The email of the user being verified. This field is always required.
phone	The phone number of the user being verified. Should be submitted in the +11234567890 format.
address	The address object. This object contains all of the fields composing the users full address.
line_1	The first line of the user's street address. Ex 123 Main Street.
line_2	Any additional street address information. Ex. Apt #12
city	The city of the user.
postal_code	The postal code or zip code of the user's address.
disctrict	The state, province, region, etc where the
country	The name of the user's Country/


max_attempts	The maximum number of attempts the user has to submit data to complete the verification.
checkups	The additional data fields that are to be verified. This endpoint supports name, address, and date of birth.
document_liveness	The threshold score required to pass BlueCheck's automated document livliness AI. The default is 0.8.
face_detection	The number of faces required to be detected by face BlueCheck's face detection AI. The default is 2 - we recommend using 2 or 3 here.
face_comparison	The number of matched faces required to pass BlueCheck's face comparison AI. The default is 2 - we recommend using 2 or 3 her

Updated 22 Apr 2024

Did this page help you?

BlueCheck Documentation

Address Based Age Verification

Photo ID Verification

Field Reference

Verification Order

Verification

Data

Config

Try It Out