Get Journey Results

Overview and Purpose
Overview
The Get Journey Results API allows clients to retrieve the detailed results of a completed KYC journey. If a callback URL was provided during the journey configuration, the results are automatically sent to that URL. Alternatively, clients can use this API to fetch the journey results directly.
Purpose
The purpose of this API is to provide clients with comprehensive results of a user's KYC journey, including journey status,  document intelligence, face match and liveness, and any errors encountered. This information is crucial for clients to review and make informed decisions based on the KYC data.
API Details
Request ParametersInput: JOURNEY_ID and Authorization token to identify and authenticate the request.
Output: Includes journeyId, flowId, user data (consent, country, idType, document and face images), verification results (face match score, liveliness score, image quality, document intelligence), and any errors encountered.
API Request
PreProduction
curl --location 'https://api-preproduction.signzy.app/api/v3/otk-service/get-journey/1234556' \
--header 'Authorization: <Auth-token>' \
--header 'Content-Type: application/json' \
--data ''
curl --location 'https://api-preproduction.signzy.app/api/v3/otk-service/get-journey/1234556' \
--header 'Authorization: <Auth-token>' \
--header 'Content-Type: application/json' \
--data ''
﻿
API Response Structure
JSON
{
    "result": {
        "flow": {
            "flowId": "<flow ID>",
            "version": 1
        },
        "processingConfig": {
            "callbackUrl": "https://callback-url",
            "authKeyForCallback": "<auth-key>",
            "redirectTime": 10,
            "successRedirectUrl": "",
            "failureRedirectUrl": "",
            "journeyLinkValidity": 3600,
    
        },
        "capturedData": {
            "images": {
                "frontDoc": "https://persist.signzy.tech/sample1.jpeg",
                "backDoc": "https://persist.signzy.tech/sample2.jpeg",
                "selfie": "https://persist.signzy.tech/sample3.jpeg"
            },
            "consent": true,
            "country": "US", // country selected by user
            "idType": "Driving License" // document selected by user
        },
        "matchPercentage": {
        "dateOfBirthMatch": "NA",
        "addressMatch": "NA",
        "fullNameMatch": "NA"
    },
    
        "documentIntelligence": {
            "completeStatus": {
                "detailsOptical": {
                    "docType": "True",
                    "expiry": "True",
                    "imageQA": "False",
                    "mrz": "None",
                    "overallStatus": "True",
                    "pagesCount": 2,
                    "security": "True",
                    "text": "True",
                    "vds": "None"
                },
                "optical": "True",
                "overallStatus": "True", // Overall result of document intelligence
                "portrait": "None",
                "rfid": "None"
            },
            "imageQuality": {
                "result": false,
                "frontIdCheck": {
                    "ImageGlares": false,
                    "ImageFocus": true,
                    "ImageResolution": false,
                    "ImageColorness": "NA",
                    "Perspective": true,
                    "Bounds": true,
                    "Portrait": true,
                    "Brightness": "NA"
                },
                "backIdCheck": {
                    "ImageGlares": false,
                    "ImageFocus": true,
                    "ImageResolution": false,
                    "ImageColorness": "NA",
                    "Perspective": true,
                    "Bounds": true,
                    "Portrait": true,
                    "Brightness": "NA"
                }
            },
            "authenticityCheck": { // the number of checks vary from ID to ID
                "frontAuthenticityCheckList": {
                    "photoEmbedType": [
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "FACE_PRESENCE",
                            "Image": null,
                            "EtalonImage": null
                        }
                    ],
                    "IMAGE_PATTERN": [
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "BLANK",
                            "Image": "https://persist.signzy.tech/api/files/979758139/download/74e88976d2f34f31af205db4a14ec8d5f65cf348df5147a18e2a4bfa2ef27427.png",
                            "EtalonImage": "https://persist.signzy.tech/api/files/979758140/download/1a52df165f6945a78e53f15a38d7d43b6175b8acf95e44429bc574fab89c2009.png"
                        }
                    ]
                },
                "backAuthenticityCheckList": {
                    "IMAGE_PATTERN": [
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "BLANK",
                            "Image": "https://persist.signzy.tech/api/files/979758145/download/01ee3f2e4b47441793dbeab0fe855f3c2895a920592140e98e61dae206032380.png",
                            "EtalonImage": "https://persist.signzy.tech/api/files/979758146/download/95c43da026204281a5e799d97873026a05059bedc05043238999d3670a744ab5.png"
                        },
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "CONTACT_CHIP_CLASSIFICATION",
                            "Image": "https://persist.signzy.tech/api/files/979758144/download/426a5e427b7c4abea5d6f7ba7386272eb5b3396711e6448bb4b1fc9100f4ff96.png",
                            "EtalonImage": "https://persist.signzy.tech/api/files/979758147/download/1059678e44c9439b9c45bec2c95f54fdc68370993da64129a1aa62ee8d8e369e.png"
                        }
                    ]
                }
            },
            "graphicFields": {
                "fieldList": [
                    [
                        {
                            "fieldName": "Portrait",
                            "fieldType": "PORTRAIT",
                            "value": "https://persist.signzy.tech/sample6.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldName": "Signature",
                            "fieldType": "SIGNATURE",
                            "value": "https://persist.signzy.tech/sample7.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldName": "Ghost portrait",
                            "fieldType": "GHOST_PORTRAIT",
                            "value": "https://persist.signzy.tech/sample8.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldType": "SIGNATURE",
                            "value": "https://persist.signzy.tech/api/files/979758129/download/6350a71b93624d9ea44bd20e931ecae11b3e354d411d43c8b70715ca0b54a97c.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldType": "GHOST_PORTRAIT",
                            "value": "https://persist.signzy.tech/api/files/979758128/download/563086621ab1420ba0d9265facd2ad8661a0c75f2eaa49c3aabdeb558a64c3da.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldType": "CROPPED_DOCUMENT",
                            "value": "https://persist.signzy.tech/api/files/979758135/download/baa0ae2446c046f197e4c868700ced3a41ef5f21ec744d87a12b06ee40631fb1.png",
                            "source": "VISUAL",
                            "containerType": "DOCUMENT_IMAGE"
                        },
                        {
                            "fieldType": "CROPPED_DOCUMENT",
                            "value": "https://persist.signzy.tech/api/files/979758136/download/6961e7acd86741d7876302647f44f9b4b456d18f0cd0434fbb50ed3e208611b5.png",
                            "source": "VISUAL",
                            "containerType": "DOCUMENT_IMAGE"
                        }
                    ]
                ]
            ]
        },
        "predictedIdTypeFront": {
            "DocumentName": "United Arab Emirates - Resident Id Card (2021) (Golden Card) #2",
            "FDSIDList": {
                "ICAOCode": "ARE",
                "dCountryName": "United Arab Emirates",
                "dDescription": "Resident Identity Card",
                "dFormat": 0,
                "dMRZ": false,
                "dType": 224,
                "dYear": "2021",
                "isDeprecated": false
            },
            "P": 0.9670456647872925
        },
        "predictedIdTypeBack": {
            "DocumentName": "United Arab Emirates - Resident Id Card (2021) (Golden Card) Side B",
            "FDSIDList": {
                "ICAOCode": "ARE",
                "dCountryName": "United Arab Emirates",
                "dDescription": "Resident Identity Card",
                "dFormat": 0,
                "dMRZ": true,
                "dType": 224,
                "dYear": "2021",
                "isDeprecated": false
            },
            "P": 0.9594634771347045
        },
        "idExpired": "False",
        "extractedFields": {
            "RemainderTerm": "29",
            "DL Endorsed": "NONE",
            "Document Class Code": "IL",
            "RemainderTerm": "98",
            "Issuing State Name": "United Arab Emirates",
            "Age at Issue": "24",
            "Age": "26",
            "names": "John Doe",
            "Surname And Given Names": "اجو",
            "Final Checkdigit": "",
            "Nationality Code": "IND",
            "Date of Expiry Checkdigit": "1",
            "Date of Expiry": "dd/mm/yyyy",
            "Date of Birth Checkdigit": "7",
            "MRZ Strings": "xxxxxxxxxxx",
            "Issuing State Code": "ARE",
            "Document Number": "123456789",
            "Document Number Checkdigit": "0",
            "Sex": "ذكر",
            "Date of Birth": "dd/mm/yyyy",
            "Optional Data CheckDigit": "3",
            "Identity Card Number": "xxxxxxx",
            "Optional Data": "xxxxx",
            "Nationality": "India",
            "Years Since Issue": "1",
            "Date of Issue": "dd/mm/yyyy",
            "Place of Issue": "دبي",
            "Profession": "بدون عمل",
            "firstName": "John Doe",
            "Given Names": "John Doe",
            "lastName": "Doe",
            "Surname": "Doe",
            "MRZ Type": "ID-1"
        }
    },
    "selfieAnalysis": {
        "passiveLiveliness": {
            "status": "200",
            "liveness": true,
            "score": 1
        },
        "faceMatch": {
            "status": "success",
            "verified": true,
            "message": "Verification completed with positive result",
            "matchPercentage": "99.00%"
        }
    },
  

    "_id": "<unique db id>",
    "clientId": "<client Id>",
    "userId": "<user ID>",
    "journeyId": "<journey ID >",
    "currentStatus": "COMPLETED",
    "step": "COMPLETE",
    "message": "Journey Completed",
    "callbackSent": true,
    "mobileStatus": false,
      "userInfo": {
        "phoneNumber": "",
        "externalReferenceId": "",
        "dateOfBirth": "",
        "emailAddress": "",
        "name": {
            "firstName": "",
            "lastName": ""
        },
        "address": {
            "street": "",
            "street2": "",
            "city": "",
            "region": "",
            "postalCode": "",
            "country": ""
        },
        "id": {
            "idType": "",
            "country": ""
        }
    },
    "createdAt": 1721541339746,
    "startedAt": 1721541345038,
    "completedAt": 1721541398034,
    "updatedAt": "2024-07-21T05:56:38.041Z",
    "__v": 0
}
}
{
    "result": {
        "flow": {
            "flowId": "<flow ID>",
            "version": 1
        },
        "processingConfig": {
            "callbackUrl": "https://callback-url",
            "authKeyForCallback": "<auth-key>",
            "redirectTime": 10,
            "successRedirectUrl": "",
            "failureRedirectUrl": "",
            "journeyLinkValidity": 3600,
    
        },
        "capturedData": {
            "images": {
                "frontDoc": "https://persist.signzy.tech/sample1.jpeg",
                "backDoc": "https://persist.signzy.tech/sample2.jpeg",
                "selfie": "https://persist.signzy.tech/sample3.jpeg"
            },
            "consent": true,
            "country": "US", // country selected by user
            "idType": "Driving License" // document selected by user
        },
        "matchPercentage": {
        "dateOfBirthMatch": "NA",
        "addressMatch": "NA",
        "fullNameMatch": "NA"
    },
    
        "documentIntelligence": {
            "completeStatus": {
                "detailsOptical": {
                    "docType": "True",
                    "expiry": "True",
                    "imageQA": "False",
                    "mrz": "None",
                    "overallStatus": "True",
                    "pagesCount": 2,
                    "security": "True",
                    "text": "True",
                    "vds": "None"
                },
                "optical": "True",
                "overallStatus": "True", // Overall result of document intelligence
                "portrait": "None",
                "rfid": "None"
            },
            "imageQuality": {
                "result": false,
                "frontIdCheck": {
                    "ImageGlares": false,
                    "ImageFocus": true,
                    "ImageResolution": false,
                    "ImageColorness": "NA",
                    "Perspective": true,
                    "Bounds": true,
                    "Portrait": true,
                    "Brightness": "NA"
                },
                "backIdCheck": {
                    "ImageGlares": false,
                    "ImageFocus": true,
                    "ImageResolution": false,
                    "ImageColorness": "NA",
                    "Perspective": true,
                    "Bounds": true,
                    "Portrait": true,
                    "Brightness": "NA"
                }
            },
            "authenticityCheck": { // the number of checks vary from ID to ID
                "frontAuthenticityCheckList": {
                    "photoEmbedType": [
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "FACE_PRESENCE",
                            "Image": null,
                            "EtalonImage": null
                        }
                    ],
                    "IMAGE_PATTERN": [
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "BLANK",
                            "Image": "https://persist.signzy.tech/api/files/979758139/download/74e88976d2f34f31af205db4a14ec8d5f65cf348df5147a18e2a4bfa2ef27427.png",
                            "EtalonImage": "https://persist.signzy.tech/api/files/979758140/download/1a52df165f6945a78e53f15a38d7d43b6175b8acf95e44429bc574fab89c2009.png"
                        }
                    ]
                },
                "backAuthenticityCheckList": {
                    "IMAGE_PATTERN": [
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "BLANK",
                            "Image": "https://persist.signzy.tech/api/files/979758145/download/01ee3f2e4b47441793dbeab0fe855f3c2895a920592140e98e61dae206032380.png",
                            "EtalonImage": "https://persist.signzy.tech/api/files/979758146/download/95c43da026204281a5e799d97873026a05059bedc05043238999d3670a744ab5.png"
                        },
                        {
                            "ElementResult": true,
                            "ElementDiagnose": "PASS",
                            "ElementType": "CONTACT_CHIP_CLASSIFICATION",
                            "Image": "https://persist.signzy.tech/api/files/979758144/download/426a5e427b7c4abea5d6f7ba7386272eb5b3396711e6448bb4b1fc9100f4ff96.png",
                            "EtalonImage": "https://persist.signzy.tech/api/files/979758147/download/1059678e44c9439b9c45bec2c95f54fdc68370993da64129a1aa62ee8d8e369e.png"
                        }
                    ]
                }
            },
            "graphicFields": {
                "fieldList": [
                    [
                        {
                            "fieldName": "Portrait",
                            "fieldType": "PORTRAIT",
                            "value": "https://persist.signzy.tech/sample6.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldName": "Signature",
                            "fieldType": "SIGNATURE",
                            "value": "https://persist.signzy.tech/sample7.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldName": "Ghost portrait",
                            "fieldType": "GHOST_PORTRAIT",
                            "value": "https://persist.signzy.tech/sample8.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldType": "SIGNATURE",
                            "value": "https://persist.signzy.tech/api/files/979758129/download/6350a71b93624d9ea44bd20e931ecae11b3e354d411d43c8b70715ca0b54a97c.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldType": "GHOST_PORTRAIT",
                            "value": "https://persist.signzy.tech/api/files/979758128/download/563086621ab1420ba0d9265facd2ad8661a0c75f2eaa49c3aabdeb558a64c3da.png",
                            "source": "VISUAL",
                            "containerType": "VISUAL_GRAPHICS"
                        }
                    ],
                    [
                        {
                            "fieldType": "CROPPED_DOCUMENT",
                            "value": "https://persist.signzy.tech/api/files/979758135/download/baa0ae2446c046f197e4c868700ced3a41ef5f21ec744d87a12b06ee40631fb1.png",
                            "source": "VISUAL",
                            "containerType": "DOCUMENT_IMAGE"
                        },
                        {
                            "fieldType": "CROPPED_DOCUMENT",
                            "value": "https://persist.signzy.tech/api/files/979758136/download/6961e7acd86741d7876302647f44f9b4b456d18f0cd0434fbb50ed3e208611b5.png",
                            "source": "VISUAL",
                            "containerType": "DOCUMENT_IMAGE"
                        }
                    ]
                ]
            ]
        },
        "predictedIdTypeFront": {
            "DocumentName": "United Arab Emirates - Resident Id Card (2021) (Golden Card) #2",
            "FDSIDList": {
                "ICAOCode": "ARE",
                "dCountryName": "United Arab Emirates",
                "dDescription": "Resident Identity Card",
                "dFormat": 0,
                "dMRZ": false,
                "dType": 224,
                "dYear": "2021",
                "isDeprecated": false
            },
            "P": 0.9670456647872925
        },
        "predictedIdTypeBack": {
            "DocumentName": "United Arab Emirates - Resident Id Card (2021) (Golden Card) Side B",
            "FDSIDList": {
                "ICAOCode": "ARE",
                "dCountryName": "United Arab Emirates",
                "dDescription": "Resident Identity Card",
                "dFormat": 0,
                "dMRZ": true,
                "dType": 224,
                "dYear": "2021",
                "isDeprecated": false
            },
            "P": 0.9594634771347045
        },
        "idExpired": "False",
        "extractedFields": {
            "RemainderTerm": "29",
            "DL Endorsed": "NONE",
            "Document Class Code": "IL",
            "RemainderTerm": "98",
            "Issuing State Name": "United Arab Emirates",
            "Age at Issue": "24",
            "Age": "26",
            "names": "John Doe",
            "Surname And Given Names": "اجو",
            "Final Checkdigit": "",
            "Nationality Code": "IND",
            "Date of Expiry Checkdigit": "1",
            "Date of Expiry": "dd/mm/yyyy",
            "Date of Birth Checkdigit": "7",
            "MRZ Strings": "xxxxxxxxxxx",
            "Issuing State Code": "ARE",
            "Document Number": "123456789",
            "Document Number Checkdigit": "0",
            "Sex": "ذكر",
            "Date of Birth": "dd/mm/yyyy",
            "Optional Data CheckDigit": "3",
            "Identity Card Number": "xxxxxxx",
            "Optional Data": "xxxxx",
            "Nationality": "India",
            "Years Since Issue": "1",
            "Date of Issue": "dd/mm/yyyy",
            "Place of Issue": "دبي",
            "Profession": "بدون عمل",
            "firstName": "John Doe",
            "Given Names": "John Doe",
            "lastName": "Doe",
            "Surname": "Doe",
            "MRZ Type": "ID-1"
        }
    },
    "selfieAnalysis": {
        "passiveLiveliness": {
            "status": "200",
            "liveness": true,
            "score": 1
        },
        "faceMatch": {
            "status": "success",
            "verified": true,
            "message": "Verification completed with positive result",
            "matchPercentage": "99.00%"
        }
    },
  

    "_id": "<unique db id>",
    "clientId": "<client Id>",
    "userId": "<user ID>",
    "journeyId": "<journey ID >",
    "currentStatus": "COMPLETED",
    "step": "COMPLETE",
    "message": "Journey Completed",
    "callbackSent": true,
    "mobileStatus": false,
      "userInfo": {
        "phoneNumber": "",
        "externalReferenceId": "",
        "dateOfBirth": "",
        "emailAddress": "",
        "name": {
            "firstName": "",
            "lastName": ""
        },
        "address": {
            "street": "",
            "street2": "",
            "city": "",
            "region": "",
            "postalCode": "",
            "country": ""
        },
        "id": {
            "idType": "",
            "country": ""
        }
    },
    "createdAt": 1721541339746,
    "startedAt": 1721541345038,
    "completedAt": 1721541398034,
    "updatedAt": "2024-07-21T05:56:38.041Z",
    "__v": 0
}
}
﻿
Response Body Parameters
result object: 
Parameter Name
Type
Description
flow
Object
Object containing flow details.
flow.flowId
String
The unique identifier for the flow.
flow.version
Number
The version number of the flow.
processingConfig
Object
Object containing processing configuration details.
processingConfig.callbackUrl
String
The URL to which the callback data will be sent.
processingConfig.authKeyForCallback
String
The authentication key for the callback URL.
processingConfig.journeyLinkValidity
Number
The validity period of the journey link in seconds.
capturedData
Object
Object containing captured data details.
matchPercentage
Object
Object containing matching percentages between data extracted and user info prefilled
documentIntelligence
Object
Object containing document intelligence details.
selfieAnalysis
Object
Object containing selfie analysis details.
_id
String
Unique database ID.
clientId
String
ID of the client.
userId
String
ID of the user.
journeyId
String
ID of the journey.
currentStatus
String
Current status of the journey.: 
NOT STARTED
IN PROGRESS
COMPLETED
step
String
The step in the journey. Possible values are:
'INIT'
'CONSENT'
'DOC_SELECTION'
'DOC_FRONT'
'DOC_BACK'
'DOC_CHECK'
'FACE_CAPTURE'
'COMPLETE'
message
String
Message providing details about the journey status.
callbackSent
Boolean
Indicates if the callback was sent.
mobileStatus
Boolean
Indicates if the mobile status is active.
userInfo
object
Object containing all prefilled data given when creating journey
createdAt
Number
Timestamp of when the journey was created.
startedAt
Number
Timestamp of when the journey was started.
completedAt
Number
Timestamp of when the journey was completed.
updatedAt
String
Timestamp of the last update to the journey.
__v
Number
Related to database ID
result.capturedData object: 
Parameter Name
Type
Description
images.frontDoc
String
URL of the front side image of the document.
images.backDoc
String
URL of the back side image of the document.
images.selfie
String
URL of the selfie image.
consent
Boolean
Indicates if consent was given by the user.
country
String
Country selected by the user.
idType
String
Type of document selected by the user.
result.documentIntelligence object: 
completeStatus
Parameter Name
Type
Description
completeStatus
Object
Overall status and details of various checks performed on the document.
completeStatus.detailsOptical
Object
Detailed optical check results.
completeStatus.detailsOptical.docType
String
Status of document type verification.
True: Check  passed ,False: Check failed 
completeStatus.detailsOptical.expiry
String
Status of expiry date verification.
True: Check  passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.detailsOptical.imageQA
String
Status of image quality assessment.
True: Check  passed ,False: Check failed 
completeStatus.detailsOptical.mrz
String
Status of MRZ (Machine-Readable Zone) check.
True: Check  passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.detailsOptical.overallStatus
String
Overall status of optical checks.
True: Check  passed ,False: Check failed 
completeStatus.detailsOptical.pagesCount
Number
Number of pages in the document.
completeStatus.detailsOptical.security
String
Status of security features check.
True: Check  passed ,False: Check failed 
completeStatus.detailsOptical.text
String
Status of text verification.
True: Check  passed ,False: Check failed 
completeStatus.detailsOptical.vds
String
Status of VDS (Visible Digital Seal) check.
True: Check  passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.optical
String
Overall optical status.
True: Check  passed ,False: Check failed 
completeStatus.overallStatus
String
Overall status of document intelligence.
True: Check  passed ,False: Check failed 
This status serves as the primary indicator for the outcome of document intelligence
completeStatus.portrait
String
Status of portrait verification.
True: Check  passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.rfid
String
Status of RFID (Radio-Frequency Identification) check.
True: Check  passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
imageQuality
Parameter Name
Type
Description
imageQuality
Object
Results of image quality checks.
imageQuality.result
Boolean
Overall result of image quality assessment.
imageQuality.frontIdCheck
Object
Detailed results of front ID image quality checks.
imageQuality.frontIdCheck.ImageGlares
Boolean
Status of image glare check.
imageQuality.frontIdCheck.ImageFocus
Boolean
Status of image focus check.
imageQuality.frontIdCheck.ImageResolution
Boolean
Status of image resolution check.
imageQuality.frontIdCheck.ImageColorness
String
Status of image colorness check.
imageQuality.frontIdCheck.Perspective
Boolean
Status of image perspective check.
imageQuality.frontIdCheck.Bounds
Boolean
Status of image bounds check.
imageQuality.frontIdCheck.Portrait
Boolean
Status of portrait image check.
imageQuality.frontIdCheck.Brightness
String
Status of image brightness check.
authenticityCheck
Parameter Name
Type
Description
authenticityCheck
Object
Results of authenticity checks.
authenticityCheck.ocrSecurityText
Object
Results of OCR (Optical Character Recognition) security text check.
authenticityCheck.ocrSecurityText.ElementResult
Boolean
Result of OCR security text check.
authenticityCheck.ocrSecurityText.ElementDiagnose
String
Diagnosis of OCR security text check.
authenticityCheck.imagePattern
Object
Results of image pattern check.
authenticityCheck.imagePattern.ElementResult
Boolean
Result of image pattern check.
authenticityCheck.imagePattern.ElementDiagnose
String
Diagnosis of image pattern check.
authenticityCheck.imagePattern.ElementType
String
Type of image pattern check.
authenticityCheck.imagePattern.Image
String
URL of the image pattern check result.
authenticityCheck.imagePattern.EtalonImage
String
URL of the etalon image used for comparison.
authenticityCheck.photoEmbedType
Object
Results of photo embed type check.
authenticityCheck.photoEmbedType.ElementResult
Boolean
Result of photo embed type check.
authenticityCheck.photoEmbedType.ElementDiagnose
String
Diagnosis of photo embed type check.
authenticityCheck.photoEmbedType.ElementType
String
Type of photo embed type check.
graphicFields
Parameter Name
Type
Description
graphicFields
Object
Details of graphic fields extracted from the document.
graphicFields.fieldList
Array
List of extracted graphic fields.
graphicFields.fieldList[].fieldName
String
Name of the extracted field.
graphicFields.fieldList[].fieldType
String
Type of the extracted field.
graphicFields.fieldList[].value
String
Value of the extracted field.
graphicFields.fieldList[].source
String
Source of the extracted field.
graphicFields.fieldList[].containerType
String
Container type of the extracted field.
predictedIdTypeFront and predictedIdTypeBack
Parameter Name
Type
Description
predictedIdTypeFront
Object
Predicted ID type for the front side of the document.
predictedIdTypeFront.DocumentName
String
Predicted Document of the front id
predictedIdTypeFront.FDSISList
Object
This object contains the details of the front document
predictedIdTypeFront.FDSISList.ICAOCode
String
ICAO Code of the country
predictedIdTypeFront.FDSISList.dCountryName
String
Name of the country
predictedIdTypeFront.FDSISList.dDescription
String
Description of the Id
predictedIdTypeFront.FDSISList.dFormat
String
﻿
predictedIdTypeFront.FDSISList.dMRZ
Boolean
If mrz is present in the document
predictedIdTypeFront.FDSISList.dType
Number
Type of document
predictedIdTypeFront.FDSISList.dYear
String 
Year of issue
ipredictedIdTypeFront.FDSISList.sDeprecated
Boolean 
if this id is deprecated
predictedIdTypeFront.P
Float
Probability of likelihood of the predicted document
predictedIdTypeBack
Object
Predicted ID type for the back side of the document.
predictedIdTypeBack.DocumentName
String
Predicted Document of the back id
predictedIdTypeBack.FDSISList
Object
This object contains the details of the back document
predictedIdTypeBack.FDSISList.ICAOCode
String
ICAO Code of the country
predictedIdTypeBack.FDSISList.dCountryName
String
Name of the country
predictedIdTypeBack.FDSISList.dDescription
String
Description of the Id
predictedIdTypeBack.FDSISList.dFormat
Number
﻿
predictedIdTypeBack.FDSISList.dMRZ
Boolean
If mrz is present in the document
predictedIdTypeBack.FDSISList.dType
Number
Type of document
predictedIdTypeBack.FDSISList.dYear
String
Year of issue
ipredictedIdTypeBack.FDSISList.sDeprecated
Boolean
if this id is deprecated
predictedIdTypeBack.P
Float
Probability of likelihood of the predicted document
idExpired
Parameter Name
Type
Description
idExpired
String
Status indicating whether the ID has expired.
True: id is expired, False: id is not expired
extractedFields
Parameter Name
Type
Description
extractedFields
Object
Fields extracted from the document.
extractedFields.firstName
String
Extracted first name.
extractedFields.lastName
String
Extracted last name.
extractedFields.names
String
Extracted full name.
extractedFields.address
String
Extracted address.
extractedFields.number
String
Extracted ID number.
extractedFields.DOB
String
Extracted date of birth.
extractedFields.issuingState
String
Extracted issuing state.
extractedFields.expiryDate
String
Extracted expiry date.
extractedFields.nationality
String
Extracted nationality.
extractedFields.gender
String
Extracted gender.
extractedFields.documentName
String
Name of the document.
extractedFields.remainderterm
String
Remaining term of the document.
extractedFields.dlRestrictionCode
String
Driving license restriction code.
extractedFields.yearsSinceIssue
String
Number of years since the document was issued.
extractedFields.ageAtIssue
String
Age at the time of document issue.
extractedFields.age
String
Current age.
extractedFields.height
String
Height of the document holder.
extractedFields.weight
String
Weight of the document holder.
extractedFields.eyesColor
String
Eye color of the document holder.
extractedFields.dlClass
String
Class of the driving license.
extractedFields.dlEndorsed
String
Endorsements on the driving license.
extractedFields.dateOfIssue
String
Date of issue of the document.
extractedFields.dlIssType
String
Type of driving license issuance.
extractedFields.addressPostalCode
String
Postal code of the address.
extractedFields.addressJurisdictionCode
String
Jurisdiction code of the address.
extractedFields.addressCity
String
City of the address.
extractedFields.addressStreet
String
Street of the address.
extractedFields.documentDiscriminator
String
Document discriminator number.
﻿
selfieAnalysis Object
passiveLiveliness
Parameter Name
Type
Description
status
String
Status code of the passive liveliness check.
liveness
Boolean
Indicates if passive liveliness was detected.
True: liveness is positive, False: liveness is negative
This status serves as the primary indicator for the outcome of liveness check
score
Number
Score indicating the confidence level of passive liveliness detection.
faceMatch
Parameter Name
Type
Description
status
String
Status of the face match verification.
verified
Boolean
Indicates if the face match was verified.
True: face match is positive, False: face match is negative
This status serves as the primary indicator for the outcome of facematch between selfie and document portrait
message
String
Message providing additional details about the face match result.
matchPercentage
String
Percentage indicating how closely the selfie matches the ID photo.
﻿
By utilizing the Get Journey Results API, clients can efficiently retrieve and review detailed KYC journey results, ensuring compliance and making informed decisions based on accurate verification data.
﻿
﻿
﻿
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

Parameter Name	Type	Description
flow	Object	Object containing flow details.
flow.flowId	String	The unique identifier for the flow.
flow.version	Number	The version number of the flow.
processingConfig	Object	Object containing processing configuration details.
processingConfig.callbackUrl	String	The URL to which the callback data will be sent.
processingConfig.authKeyForCallback	String	The authentication key for the callback URL.
processingConfig.journeyLinkValidity	Number	The validity period of the journey link in seconds.
capturedData	Object	Object containing captured data details.
matchPercentage	Object	Object containing matching percentages between data extracted and user info prefilled
documentIntelligence	Object	Object containing document intelligence details.
selfieAnalysis	Object	Object containing selfie analysis details.
_id	String	Unique database ID.
clientId	String	ID of the client.
userId	String	ID of the user.
journeyId	String	ID of the journey.
currentStatus	String	Current status of the journey.: NOT STARTED IN PROGRESS COMPLETED
step	String	The step in the journey. Possible values are: 'INIT' 'CONSENT' 'DOC_SELECTION' 'DOC_FRONT' 'DOC_BACK' 'DOC_CHECK' 'FACE_CAPTURE' 'COMPLETE'
message	String	Message providing details about the journey status.
callbackSent	Boolean	Indicates if the callback was sent.
mobileStatus	Boolean	Indicates if the mobile status is active.
userInfo	object	Object containing all prefilled data given when creating journey
createdAt	Number	Timestamp of when the journey was created.
startedAt	Number	Timestamp of when the journey was started.
completedAt	Number	Timestamp of when the journey was completed.
updatedAt	String	Timestamp of the last update to the journey.
__v	Number	Related to database ID

Parameter Name	Type	Description
images.frontDoc	String	URL of the front side image of the document.
images.backDoc	String	URL of the back side image of the document.
images.selfie	String	URL of the selfie image.
consent	Boolean	Indicates if consent was given by the user.
country	String	Country selected by the user.
idType	String	Type of document selected by the user.

Parameter Name	Type	Description
completeStatus	Object	Overall status and details of various checks performed on the document.
completeStatus.detailsOptical	Object	Detailed optical check results.
completeStatus.detailsOptical.docType	String	Status of document type verification. True: Check passed ,False: Check failed
completeStatus.detailsOptical.expiry	String	Status of expiry date verification. True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.detailsOptical.imageQA	String	Status of image quality assessment. True: Check passed ,False: Check failed
completeStatus.detailsOptical.mrz	String	Status of MRZ (Machine-Readable Zone) check. True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.detailsOptical.overallStatus	String	Overall status of optical checks. True: Check passed ,False: Check failed
completeStatus.detailsOptical.pagesCount	Number	Number of pages in the document.
completeStatus.detailsOptical.security	String	Status of security features check. True: Check passed ,False: Check failed
completeStatus.detailsOptical.text	String	Status of text verification. True: Check passed ,False: Check failed
completeStatus.detailsOptical.vds	String	Status of VDS (Visible Digital Seal) check. True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.optical	String	Overall optical status. True: Check passed ,False: Check failed
completeStatus.overallStatus	String	Overall status of document intelligence. True: Check passed ,False: Check failed This status serves as the primary indicator for the outcome of document intelligence
completeStatus.portrait	String	Status of portrait verification. True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)
completeStatus.rfid	String	Status of RFID (Radio-Frequency Identification) check. True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)

Parameter Name	Type	Description
imageQuality	Object	Results of image quality checks.
imageQuality.result	Boolean	Overall result of image quality assessment.
imageQuality.frontIdCheck	Object	Detailed results of front ID image quality checks.
imageQuality.frontIdCheck.ImageGlares	Boolean	Status of image glare check.
imageQuality.frontIdCheck.ImageFocus	Boolean	Status of image focus check.
imageQuality.frontIdCheck.ImageResolution	Boolean	Status of image resolution check.
imageQuality.frontIdCheck.ImageColorness	String	Status of image colorness check.
imageQuality.frontIdCheck.Perspective	Boolean	Status of image perspective check.
imageQuality.frontIdCheck.Bounds	Boolean	Status of image bounds check.
imageQuality.frontIdCheck.Portrait	Boolean	Status of portrait image check.
imageQuality.frontIdCheck.Brightness	String	Status of image brightness check.

Parameter Name	Type	Description
authenticityCheck	Object	Results of authenticity checks.
authenticityCheck.ocrSecurityText	Object	Results of OCR (Optical Character Recognition) security text check.
authenticityCheck.ocrSecurityText.ElementResult	Boolean	Result of OCR security text check.
authenticityCheck.ocrSecurityText.ElementDiagnose	String	Diagnosis of OCR security text check.
authenticityCheck.imagePattern	Object	Results of image pattern check.
authenticityCheck.imagePattern.ElementResult	Boolean	Result of image pattern check.
authenticityCheck.imagePattern.ElementDiagnose	String	Diagnosis of image pattern check.
authenticityCheck.imagePattern.ElementType	String	Type of image pattern check.
authenticityCheck.imagePattern.Image	String	URL of the image pattern check result.
authenticityCheck.imagePattern.EtalonImage	String	URL of the etalon image used for comparison.
authenticityCheck.photoEmbedType	Object	Results of photo embed type check.
authenticityCheck.photoEmbedType.ElementResult	Boolean	Result of photo embed type check.
authenticityCheck.photoEmbedType.ElementDiagnose	String	Diagnosis of photo embed type check.
authenticityCheck.photoEmbedType.ElementType	String	Type of photo embed type check.

Parameter Name	Type	Description
graphicFields	Object	Details of graphic fields extracted from the document.
graphicFields.fieldList	Array	List of extracted graphic fields.
graphicFields.fieldList[].fieldName	String	Name of the extracted field.
graphicFields.fieldList[].fieldType	String	Type of the extracted field.
graphicFields.fieldList[].value	String	Value of the extracted field.
graphicFields.fieldList[].source	String	Source of the extracted field.
graphicFields.fieldList[].containerType	String	Container type of the extracted field.

Parameter Name	Type	Description
predictedIdTypeFront	Object	Predicted ID type for the front side of the document.
predictedIdTypeFront.DocumentName	String	Predicted Document of the front id
predictedIdTypeFront.FDSISList	Object	This object contains the details of the front document
predictedIdTypeFront.FDSISList.ICAOCode	String	ICAO Code of the country
predictedIdTypeFront.FDSISList.dCountryName	String	Name of the country
predictedIdTypeFront.FDSISList.dDescription	String	Description of the Id
predictedIdTypeFront.FDSISList.dFormat	String
predictedIdTypeFront.FDSISList.dMRZ	Boolean	If mrz is present in the document
predictedIdTypeFront.FDSISList.dType	Number	Type of document
predictedIdTypeFront.FDSISList.dYear	String	Year of issue
ipredictedIdTypeFront.FDSISList.sDeprecated	Boolean	if this id is deprecated
predictedIdTypeFront.P	Float	Probability of likelihood of the predicted document
predictedIdTypeBack	Object	Predicted ID type for the back side of the document.
predictedIdTypeBack.DocumentName	String	Predicted Document of the back id
predictedIdTypeBack.FDSISList	Object	This object contains the details of the back document
predictedIdTypeBack.FDSISList.ICAOCode	String	ICAO Code of the country
predictedIdTypeBack.FDSISList.dCountryName	String	Name of the country
predictedIdTypeBack.FDSISList.dDescription	String	Description of the Id
predictedIdTypeBack.FDSISList.dFormat	Number
predictedIdTypeBack.FDSISList.dMRZ	Boolean	If mrz is present in the document
predictedIdTypeBack.FDSISList.dType	Number	Type of document
predictedIdTypeBack.FDSISList.dYear	String	Year of issue
ipredictedIdTypeBack.FDSISList.sDeprecated	Boolean	if this id is deprecated
predictedIdTypeBack.P	Float	Probability of likelihood of the predicted document

Parameter Name	Type	Description
idExpired	String	Status indicating whether the ID has expired. True: id is expired, False: id is not expired

Parameter Name	Type	Description
extractedFields	Object	Fields extracted from the document.
extractedFields.firstName	String	Extracted first name.
extractedFields.lastName	String	Extracted last name.
extractedFields.names	String	Extracted full name.
extractedFields.address	String	Extracted address.
extractedFields.number	String	Extracted ID number.
extractedFields.DOB	String	Extracted date of birth.
extractedFields.issuingState	String	Extracted issuing state.
extractedFields.expiryDate	String	Extracted expiry date.
extractedFields.nationality	String	Extracted nationality.
extractedFields.gender	String	Extracted gender.
extractedFields.documentName	String	Name of the document.
extractedFields.remainderterm	String	Remaining term of the document.
extractedFields.dlRestrictionCode	String	Driving license restriction code.
extractedFields.yearsSinceIssue	String	Number of years since the document was issued.
extractedFields.ageAtIssue	String	Age at the time of document issue.
extractedFields.age	String	Current age.
extractedFields.height	String	Height of the document holder.
extractedFields.weight	String	Weight of the document holder.
extractedFields.eyesColor	String	Eye color of the document holder.
extractedFields.dlClass	String	Class of the driving license.
extractedFields.dlEndorsed	String	Endorsements on the driving license.
extractedFields.dateOfIssue	String	Date of issue of the document.
extractedFields.dlIssType	String	Type of driving license issuance.
extractedFields.addressPostalCode	String	Postal code of the address.
extractedFields.addressJurisdictionCode	String	Jurisdiction code of the address.
extractedFields.addressCity	String	City of the address.
extractedFields.addressStreet	String	Street of the address.
extractedFields.documentDiscriminator	String	Document discriminator number.

Parameter Name	Type	Description
status	String	Status code of the passive liveliness check.
liveness	Boolean	Indicates if passive liveliness was detected. True: liveness is positive, False: liveness is negative This status serves as the primary indicator for the outcome of liveness check
score	Number	Score indicating the confidence level of passive liveliness detection.

Parameter Name	Type	Description
status	String	Status of the face match verification.
verified	Boolean	Indicates if the face match was verified. True: face match is positive, False: face match is negative This status serves as the primary indicator for the outcome of facematch between selfie and document portrait
message	String	Message providing additional details about the face match result.
matchPercentage	String	Percentage indicating how closely the selfie matches the ID photo.

Create Journey Link

Identity Verify - Lite

Get Journey Results

Overview and Purpose

Overview

Purpose

API Details

API Request

API Response Structure

Response Body Parameters

result object:

result.documentIntelligence object:

completeStatus

imageQuality

authenticityCheck

graphicFields

predictedIdTypeFront and predictedIdTypeBack

idExpired

extractedFields

﻿

selfieAnalysis Object

passiveLiveliness

faceMatch

Getting help