Documents
Create verification jobs through the API to analyze identities without going through Trust Swiftly's UI. Use the document status API to retrieve the results.
The documents endpoint is useful for customers looking to control the branding experience or have asynchronous tasks to verify an identity. Use the below API to create a job to verify an ID document such as a DL or Passport. Ensure you have a template and workflow setup for the document to verify.
Create Document Verification Job
POSThttps://{sub-domain}.trustswiftly.com/api/verify/document
Request Header
Multi-part Form Parameters
*Make sure the user is already created with the template_id assigned to them.
{
"success": true,
"doc_id": "313237"
}{
'error_type' => 'api_template_error',
'error_message' => 'Invalid templateId provided.',
}
{
'error_type' => 'api_user_error',
'error_message' => 'User Not Found'
}
curl --request POST \
--url https://{sub-domain}.trustswiftly.com/api/verify/document \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--header 'User-Agent: insomnium/1.0' \
--form template_id=tmpl_MTA \
--form user_id=645 \
--form 'verify_image=@C:\Users\123\photo5827714315489229223.jpg'Get Status of Document Verification Job
The document status can be checked using polling via the below endpoint or can await a webhook for completion status. Typically, response times require a few seconds to analyze the document.
POSThttps://{sub-domain}.trustswiftly.com/api/verify/document/status
Request Header
Request Body JSON
{
"success": true,
"doc_id": "31323933",
"document_status": "Success",
"document_data": {
"id": 1293,
"name": "11/example@gmail.com_#11.jpg",
"status": 1,
"content": {
"url": "https://sub-domain.trustswiftly.com/image/11?expires=11&signature=11",
"hash": "a1efcda2122a20dda6d9ea89be9c62ac",
"name": "11/example@gmail.com_#11.jpg",
"size": 218545,
"time": 1726768308,
"type": "image/jpeg",
"doc_type": "General process",
"mrz_data": [],
"exif_data": [],
"extension": "jpg",
"ai_analysis": {
"name_match": {
"full_name": false,
"last_name": false
},
"selfie_check": true,
"internet_detection": false,
"internet_detection_location": {
"guess_labels": [
"document"
]
}
},
"doc_type_id": 23,
"dlp_analysis": {
"info_types": [
{
"name": "US_STATE",
"quote": "***",
"likelihood": "VERY_LIKELY"
},
{
"name": "US_DRIVERS_LICENSE_NUMBER",
"quote": "***",
"likelihood": "LIKELY"
},
{
"name": "CREDIT_CARD_NUMBER",
"quote": "***",
"likelihood": "POSSIBLE"
},
{
"name": "DATE",
"quote": "08-29-1911",
"likelihood": "LIKELY"
},
{
"name": "DATE_OF_BIRTH",
"quote": "08-29-1911",
"likelihood": "LIKELY"
},
{
"name": "PERSON_NAME",
"quote": "Joe CHAMI",
"likelihood": "LIKELY"
},
{
"name": "FIRST_NAME",
"quote": "Joe",
"likelihood": "LIKELY"
},
{
"name": "LAST_NAME",
"quote": "CHAMI",
"likelihood": "LIKELY"
},
{
"name": "PERSON_NAME",
"quote": "PAYNE",
"likelihood": "LIKELY"
},
{
"name": "LAST_NAME",
"quote": "PAYNE",
"likelihood": "LIKELY"
},
{
"name": "STREET_ADDRESS",
"quote": "111 PAYNE AVE EXAMPLE,MI 12345-1111",
"likelihood": "LIKELY"
},
{
"name": "DATE",
"quote": "09-01-2017",
"likelihood": "LIKELY"
},
{
"name": "DATE",
"quote": "08-29-2021",
"likelihood": "LIKELY"
},
{
"name": "DATE",
"quote": "01-21-2011",
"likelihood": "LIKELY"
},
{
"name": "GENDER",
"quote": "***",
"likelihood": "POSSIBLE"
}
]
},
"photoshopped": false,
"original_name": "photo5827714315489229223_rotated.jpg",
"valid_address": [],
"dl_id_lookup_id": "",
"face_annotation": {
"joyLikelihood": "VERY_UNLIKELY",
"angerLikelihood": "VERY_UNLIKELY",
"sorrowLikelihood": "VERY_UNLIKELY",
"blurredLikelihood": "VERY_UNLIKELY",
"headwearLikelihood": "VERY_UNLIKELY",
"surpriseLikelihood": "VERY_UNLIKELY",
"underExposedLikelihood": "VERY_UNLIKELY"
},
"dl_id_lookup_data": "",
"temporary_storage": "oss",
"document_processor": {
"Sex": {
"value": "M",
"confidence": 100
},
"age": {
"value": 50,
"confidence": 100
},
"Height": {
"value": "170 cm",
"confidence": 100
},
"Status": {
"value": "Ok",
"confidence": 100
},
"Address": {
"value": "123 PAYNE AVE,EXAMPLE, MI 12345-1111",
"confidence": 100
},
"DL Class": {
"value": "O",
"confidence": 100
},
"Position": {
"value": {
"x1": -3,
"x2": 696,
"y1": 11,
"y2": 1034
},
"confidence": 100
},
"Full Name": {
"value": "Joe CHAMI",
"confidence": 100
},
"Eyes Color": {
"value": "Brown",
"confidence": 100
},
"DL Endorsed": {
"value": "NONE",
"confidence": 100
},
"countryName": {
"value": "United States",
"confidence": 100
},
"Address City": {
"value": "EXAMPLE",
"confidence": 100
},
"documentName": {
"value": "Driver Licence",
"confidence": 100
},
"Address State": {
"value": "Michigan",
"confidence": 100
},
"Date of Birth": {
"value": "1911-08-29",
"confidence": 100
},
"Date of Issue": {
"value": "2012-09-01",
"confidence": 100
},
"Document Name": {
"value": "United States-Driver Licence",
"confidence": 100
},
"Revision Date": {
"value": "2011-01-11",
"confidence": 100
},
"Address Street": {
"value": "123 PAYNE AVE",
"confidence": 100
},
"Date of Expiry": {
"value": "2050-08-29",
"confidence": 100
},
"Document Number": {
"value": "111",
"confidence": 100
},
"Portrait Position": {
"value": {
"x1": 26,
"x2": 283,
"y1": 167,
"y2": 509
},
"confidence": 100
},
"Issuing State Code": {
"value": "USA",
"confidence": 100
},
"Issuing State Name": {
"value": "United States",
"confidence": 100
},
"Address Postal Code": {
"value": "12345-1111",
"confidence": 100
},
"DL Restriction Code": {
"value": "NONE",
"confidence": 100
},
"Document Discriminator": {
"value": "11",
"confidence": 100
},
"Address Jurisdiction Code": {
"value": "MI",
"confidence": 100
}
},
"valid_user_address": []
},
"created_at": "2024-09-19T17:51:46.000000Z"
}
}{
"error_type": "invalid_document_id",
"error_message": "Invalid Document Id"
}
{ "success": false, "doc_id": "31323930", "document_status": "Failed", "reason": null }
curl --request POST \
--url https://{sub-domain}.trustswiftly.com/api/verify/document/status \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnium/1.0' \
--data '{
"doc_id": "31323930",
"user_id": "645"
}'Last updated