DocuVerify API

Get verification configs.

• Only a system, service or service_ext key can be used to get verification config.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

Returns the list of verification config or errors if any.

This API throw an error if something goes wrong.

Get verification config by tag or id.

• Only a system, service or service_ext key can be used to get verification config.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

Returns the verification config object or errors if any.

This API throw an error if something goes wrong.

Create verification config.

• Only a system, service or service_ext key can be used to create verification config.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

tag (required)

The tag of verification config.

tenantId (required)

ID of tenant

name (optional)

The name of verification config. default will be "no-name"

face_liveness (conditional)

The config array of face_liveness.

Optional - if face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

face_compare (conditional)

The config array of face_compare.

Optional - if face_liveness or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

dl_verify (conditional)

The config array of dl_verify.

Optional - if face_liveness or face_compare or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

ssn_verify (conditional)

The config array of ssn_verify.

Optional - if face_liveness or face_compare or dl_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

person_verify (conditional)

The config array of person_verify.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

dl_authenticate (conditional)

The config array of dl_authenticate.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

ppt_authenticate (conditional)

The config array of ppt_authenticate.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

document_liveness (conditional)

The config array of document_liveness.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

idcard_authenticate (conditional)

The config array of idcard_authenticate.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or ppt_authenticate or id_capture or face_rekognition is provided, can be empty.

id_capture (conditional)

The config array of id_capture.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or ppt_authenticate or idcard_authenticate or face_rekognition is provided, can be empty.

face_rekognition (conditional)

The config array of face_rekognition.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture is provided, can be empty.

Returns

Returns the created verification config and errors if any.

This API throw an error if something goes wrong.

Request body contains below fields to create verification config.

{
    "tenantId": "string required",   // ID of tenant
    "tag": "string required",   // string, allows alphanumeric characters, underscore & hyphen.
    "name": "string",   // string, default will be "no-name".
    "face_liveness": [],        // array, optional if face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "face_compare": [],         // array, optional if face_liveness or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "dl_verify": [],            // array, optional if face_liveness or face_compare or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "ssn_verify": []            // array, optional if face_liveness or face_compare or dl_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "person_verify": []            // array, optional if face_liveness or face_compare or person_search or dl_verify or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "person_search": []            // array, optional if face_liveness or face_compare or person_verify or dl_verify or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "dl_authenticate": []       // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "ppt_authenticate": []      // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "document_liveness": []     // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or idcard_authenticate or face_rekognition is provided, can be empty.
    "idcard_authenticate": []   // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or face_rekognition is provided, can be empty.
    "id_capture": []            // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or ppt_authenticate or idcard_authenticate or face_rekognition is provided, can be empty.
    "face_rekognition": []      // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture is provided, can be empty.
}

valid object for face_liveness array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "min_confidence": 0.7,                 // number optional
    "min_quality": 0.5,                    // number optional
    "selfieCaptureMode": "string",         // string optional - auto | manualWithFaceDetection
    "pipeline": "string",                  // string optional
    "other_pipelines": {
       "authentication": "string",         // string optional
       "registration": "string",           // string optional
       "doc_enrollment": "string"          // string optional
    }
}

valid object for face_compare array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0.7,					// number required
    "other_confidence": {
        "authentication": 0.9,				// number optional, 0-1
        "doc_enrollment": 0.7				// number optional, 0-1
    }
}

valid object for key face_rekognition array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0.7,                 // number required
}

valid object for key dl_verify array is:

{
    "verifier": "string",                    // string, required, tag of verifier
    "skip": false,                           // boolean, optional, default false
    "debug": false,                          // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "include_states": ["NY", "NJ"],         // array of string
    "exclude_states": ["AL", "AK"],         // array of string
    "dob_match_required": true,              // boolean optional
    "first_name_exact_match_required": true, // boolean optional
    "first_name_fuzzy_match_required": true, // boolean optional
    "last_name_exact_match_required": true,  // boolean optional
    "last_name_fuzzy_match_required": true,  // boolean optional
    "middle_name_exact_match_required": true,// boolean optional
    "middle_name_fuzzy_match_required": true,// boolean optional
    "doc_category_match_required": true,     // boolean optional
    "doi_match_required": true               // boolean optional
    "doe_match_required": true               // boolean optional
    "person_sex_match_required": true        // boolean optional
    "person_height_match_required": true     // boolean optional
    "person_eye_color_match_required": true  // boolean optional
    "address_match_required": true           // boolean optional
    "city_match_required": true              // boolean optional
    "state_match_required": true             // boolean optional
    "zip_match_required": true               // boolean optional
    "dl_number_match_required": true,        // boolean optional
    "weights": {
       "dob_match_required": 0,              // number optional
       "first_name_exact_match_required": 0, // number optional
       "first_name_fuzzy_match_required": 0, // number optional
       "last_name_exact_match_required": 0,  // number optional
       "last_name_fuzzy_match_required": 0,  // number optional
       "middle_name_exact_match_required": 0,// number optional
       "middle_name_fuzzy_match_required": 0,// number optional
       "doc_category_match_required": 0,     // number optional
       "doi_match_required": 0,              // number optional
       "doe_match_required": 0,              // number optional
       "person_sex_match_required": 0,       // number optional
       "person_height_match_required": 0,    // number optional
       "person_eye_color_match_required": 0, // number optional
       "address_match_required": 0,          // number optional
       "city_match_required": 0,             // number optional
       "state_match_required": 0,            // number optional
       "zip_match_required": 0,              // number optional
       "dl_number_match_required": 0         // number optional
    } // optional
}

valid object for key ssn_verify array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "min_confidence": 0                    // number optional
    "first_name_match_confidence": 0       // number optional
    "last_name_match_confidence": 0        // number optional
    "ssn_match_confidence": 0              // number optional
    "dob_match_confidence": 0              // number optional
    "age_match_confidence": 0              // number optional
    "address_match_confidence": 0          // number optional
    "identity_verified": true              // boolean optional
}

valid object for key person_verify array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0                    // number optional
    "first_name_match_confidence": 0       // number optional
    "last_name_match_confidence": 0        // number optional
    "ssn_match_confidence": 0              // number optional
    "dob_match_confidence": 0              // number optional
    "age_match_confidence": 0              // number optional
    "address_match_confidence": 0          // number optional
    "identity_verified": true              // boolean optional
}

valid object for key person_search array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0                    // number optional
}

valid object for key dl_authenticate array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "action_code": 0,                      // number, optional
    "document_type": "00",                 // string, optional 00 - License, 01- License/Passport, 11 - Passport
    "document_front_liveness": 0.5,        // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "document_back_liveness": 0.5,         // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "face_assertion_score": 0.5            // number optional - null/missing or 0.0 means DO NOT perform liveness check
}

valid object for key ppt_authenticate array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "action_code": 0,                      // number, optional
    "document_type": "11",                 // string, optional 00 - License, 01- License/Passport, 11 - Passport
    "document_front_liveness": 0.5,        // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "face_assertion_score": 0.7            // number optional - null/missing or 0.0 means DO NOT perform liveness check
}

valid object for key document_liveness array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "min_confidence": 0.5                  // number required
}

valid object for key idcard_authenticate array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "action_code": 0,                      // number, optional
    "document_type": "00",                 // string, optional 00 - License, 01- License/Passport, 11 - Passport
    "document_front_liveness": 0.5,        // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "document_back_liveness": 0.5,         // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "face_assertion_score": 0.5            // number optional - null/missing or 0.0 means DO NOT perform liveness check
}

valid object using pii_retention_off/pii_retention_ttl for key id_capture array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "expireSessionInMin": 10080,           // number optional
    "abandonSessionInMin": 60,             // number optional
    "fraudDetectFailureBypass": true,      // boolean optional
    "pii_retention_off": false,            // number optional
    "pii_retention_ttl": 0,                // number optional - (missing or 0 value means 7 days by default), -1 means throw away on session poll, number greater than 0 this indicates PII will be discarded after defined number of seconds)
    "checks": [
        "document_liveness_front",
        "document_liveness_back",
        "selfie_liveness",
        "face_compare",
        "fraud_detection"
    ],
    "conditions": [                        // array optional
        {
             "module": "string"            // string - "firstname check" / "lastname check" / "dob check"
             "criteria": "string"          // string - "eq", "neq" or "fuzzyMatch"
             "minMatchScore": number       // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100
             "matchCommonAliases": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default
             "ignoreMiddleNames": boolean  // optional if firstname check or lastname check module is passed - value will be boolean and false by default
        }
    ],
    "autoDetectTimeout": 40,                // number optional
    "postTimeoutCaptureMode": "none",       // string optional (default: "none") - "none", "manual", or "auto"
    "autoCaptureCountdownSeconds": 10,      // number optional - seconds to wait for auto-capture
    "autoCaptureCountdownVisible": true,    // boolean optional - show countdown UX
    "useV1BlinkIdVerify": true              // boolean optional
    "maxRetries": 2,                        // number optional - (default = 2, min = 0, max = 4)
    "bypassConfig": [
        {
            "criteria": "string",           // string
            "enabled": "boolean"            // boolean - true or false
        }
    ]
 }

valid object using piiRetentionConfig for key id_capture array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "expireSessionInMin": 10080,           // number optional
    "abandonSessionInMin": 60,             // number optional
    "fraudDetectFailureBypass": true,      // boolean optional
    "piiRetentionConfig": [
        {
            "status": "SUCCESS",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": 300
            }
        },
        {
            "status": "FAILED",
            "value": {
                "pii_retention_off": true
            }
        },
        {
            "status": "NOT_PERFORMED",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": 0
            }
        },
        {
            "status": "REVIEW",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": -1
            }
        },
        {
            "status": "ABANDONED",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": 86400
            }
        }
    ],
    "checks": [
        "document_liveness_front",
        "document_liveness_back",
        "selfie_liveness",
        "face_compare",
        "fraud_detection"
    ],
    "conditions": [                        // array optional
        {
             "module": "string"            // string - "firstname check" / "lastname check" / "dob check"
             "criteria": "string"          // string - "eq", "neq" or "fuzzyMatch"
             "minMatchScore": number       // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100
             "matchCommonAliases": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default
             "ignoreMiddleNames": boolean  // optional if firstname check or lastname check module is passed - value will be boolean and false by default
        }
    ],
    "autoDetectTimeout": 40,                // number optional
    "postTimeoutCaptureMode": "none",       // string optional (default: "none") - "none", "manual", or "auto"
    "autoCaptureCountdownSeconds": 10,      // number optional - seconds to wait for auto-capture
    "autoCaptureCountdownVisible": true,    // boolean optional - show countdown UX
    "bypassConfigJS": "string",             // string optional - JavaScript code for custom bypass logic
    "enableManualReview": false,            // boolean optional - enable manual review for the capture session
    "useV1BlinkIdVerify": true              // boolean optional
    "maxRetries": 2,                        // number optional - (default = 2, min = 0, max = 4)
    "bypassConfig": [
        {
            "criteria": "string",           // string
            "enabled": "boolean"            // boolean - true or false
        }
    ]
 }

Update verification config.

• Only a system, service or service_ext key can be used to update verification config.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

name (optional)

The name of verification config. default will be "no-name"

face_liveness (conditional)

The config array of face_liveness.

Optional - if face_compare or dl_verify or ssn_verify or person_verify or person_search ordl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

face_compare (conditional)

The config array of face_compare.

Optional - if face_liveness or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

dl_verify (conditional)

The config array of dl_verify.

Optional - if face_liveness or face_compare or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

ssn_verify (conditional)

The config array of ssn_verify.

Optional - if face_liveness or face_compare or dl_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

person_verify (conditional)

The config array of person_verify.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

dl_authenticate (conditional)

The config array of dl_authenticate.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or ppt_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

ppt_authenticate (conditional)

The config array of ppt_authenticate.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

document_liveness (conditional)

The config array of document_liveness.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or idcard_authenticate or id_capture or face_rekognition is provided, can be empty.

idcard_authenticate (conditional)

The config array of idcard_authenticate.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or ppt_authenticate or id_capture or face_rekognition is provided, can be empty.

id_capture (conditional)

The config array of id_capture.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or ppt_authenticate or idcard_authenticate or face_rekognition is provided, can be empty.

face_rekognition (conditional)

The config array of face_rekognition.

Optional - if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture is provided, can be empty.

Returns

Returns the verification config object if the verification config object is updated successfully.

This API throws an error if something goes wrong.

Request body contains below fields to update verification config.

{
    "name": "string required",   // string.
    "face_liveness": [],        // array, optional if face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "face_compare": [],         // array, optional if face_liveness or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "dl_verify": [],            // array, optional if face_liveness or face_compare or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "ssn_verify": []            // array, optional if face_liveness or face_compare or dl_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "person_verify": []            // array, optional if face_liveness or face_compare or person_search or dl_verify or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "person_search": []            // array, optional if face_liveness or face_compare or person_verify or dl_verify or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "dl_authenticate": []       // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or ppt_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "ppt_authenticate": []      // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or idcard_authenticate or face_rekognition is provided, can be empty.
    "document_liveness": []     // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or idcard_authenticate or face_rekognition is provided, can be empty.
    "idcard_authenticate": []   // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or face_rekognition is provided, can be empty.
    "id_capture": []            // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or document_liveness or ppt_authenticate or idcard_authenticate or face_rekognition is provided, can be empty.
    "face_rekognition": []      // array, optional if face_liveness or face_compare or dl_verify or ssn_verify or person_verify or person_search or dl_authenticate or ppt_authenticate or document_liveness or idcard_authenticate or id_capture is provided, can be empty.
}

valid object for face_liveness array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "min_confidence": 0.7,                 // number optional
    "min_quality": 0.5,                    // number optional
    "selfieCaptureMode": "string",         // string optional - auto | manualWithFaceDetection
    "pipeline": "string",                  // string optional
    "other_pipelines": {
       "authentication": "string",         // string optional
       "registration": "string",           // string optional
       "doc_enrollment": "string"          // string optional
    }
}

valid object for face_compare array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "default_min_confidence": 0.6,         // number optional
    "authentication_min_confidence": 0.9,  // number optional
    "doc_enrollment_min_confidence: 0.6    // number optional
}

valid object for key face_rekognition array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0.7,                 // number required
}

valid object for key dl_verify array is:

{
    "verifier": "string",                    // string, required, tag of verifier
    "skip": false,                           // boolean, optional, default false
    "debug": false,                          // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "include_states": ["NY", "NJ"],         // array of string
    "exclude_states": ["AL", "AK"],         // array of string
    "dob_match_required": true,              // boolean optional
    "first_name_exact_match_required": true, // boolean optional
    "first_name_fuzzy_match_required": true, // boolean optional
    "last_name_exact_match_required": true,  // boolean optional
    "last_name_fuzzy_match_required": true,  // boolean optional
    "middle_name_exact_match_required": true,// boolean optional
    "middle_name_fuzzy_match_required": true,// boolean optional
    "doc_category_match_required": true,     // boolean optional
    "doi_match_required": true               // boolean optional
    "doe_match_required": true               // boolean optional
    "person_sex_match_required": true        // boolean optional
    "person_height_match_required": true     // boolean optional
    "person_eye_color_match_required": true  // boolean optional
    "address_match_required": true           // boolean optional
    "city_match_required": true              // boolean optional
    "state_match_required": true             // boolean optional
    "zip_match_required": true               // boolean optional
    "dl_number_match_required": true,        // boolean optional
    "weights": {
       "dob_match_required": 0,              // number optional
       "first_name_exact_match_required": 0, // number optional
       "first_name_fuzzy_match_required": 0, // number optional
       "last_name_exact_match_required": 0,  // number optional
       "last_name_fuzzy_match_required": 0,  // number optional
       "middle_name_exact_match_required": 0,// number optional
       "middle_name_fuzzy_match_required": 0,// number optional
       "doc_category_match_required": 0,     // number optional
       "doi_match_required": 0,              // number optional
       "doe_match_required": 0,              // number optional
       "person_sex_match_required": 0,       // number optional
       "person_height_match_required": 0,    // number optional
       "person_eye_color_match_required": 0, // number optional
       "address_match_required": 0,          // number optional
       "city_match_required": 0,             // number optional
       "state_match_required": 0,            // number optional
       "zip_match_required": 0,              // number optional
       "dl_number_match_required": 0         // number optional
    } // optional
}

valid object for key ssn_verify array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "min_confidence": 0                    // number optional
    "first_name_match_confidence": 0       // number optional
    "last_name_match_confidence": 0        // number optional
    "ssn_match_confidence": 0              // number optional
    "dob_match_confidence": 0              // number optional
    "age_match_confidence": 0              // number optional
    "address_match_confidence": 0          // number optional
    "identity_verified": true              // boolean optional
}

valid object for key person_verify array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0                    // number optional
    "first_name_match_confidence": 0       // number optional
    "last_name_match_confidence": 0        // number optional
    "ssn_match_confidence": 0              // number optional
    "dob_match_confidence": 0              // number optional
    "age_match_confidence": 0              // number optional
    "address_match_confidence": 0          // number optional
    "identity_verified": true              // boolean optional
}

valid object for key person_search array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "min_confidence": 0                    // number optional
}

valid object for key dl_authenticate array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "action_code": 0,                      // number, optional
    "document_type": "00",                 // string, optional 00 - License, 01- License/Passport, 11 - Passport
    "document_front_liveness": 0.5,        // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "document_back_liveness": 0.5,         // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "face_assertion_score": 0.5            // number optional - null/missing or 0.0 means DO NOT perform liveness check
}

valid object for key ppt_authenticate array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "action_code": 0,                      // number, optional
    "document_type": "11",                 // string, optional 00 - License, 01- License/Passport, 11 - Passport
    "document_front_liveness": 0.5,        // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "face_assertion_score": 0.5            // number optional - null/missing or 0.0 means DO NOT perform liveness check
}

valid object for key document_liveness array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "min_confidence": 0.5                  // number required
}

valid object for key idcard_authenticate array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "action_code": 0,                      // number, optional
    "document_type": "00",                 // string, optional 00 - License, 01- License/Passport, 11 - Passport
    "document_front_liveness": 0.5,        // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "document_back_liveness": 0.5,         // number optional - null/missing or 0.0 means DO NOT perform liveness check
    "face_assertion_score": 0.5            // number optional - null/missing or 0.0 means DO NOT perform liveness check
}

valid object using pii_retention_off/pii_retention_ttl for key id_capture array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "expireSessionInMin": 10080,           // number optional
    "abandonSessionInMin": 60,             // number optional
    "fraudDetectFailureBypass": true,      // boolean optional
    "pii_retention_off": false,            // number optional
    "pii_retention_ttl": 0,                // number optional - (missing or 0 value means 7 days by default), -1 means throw away on session poll, number greater than 0 this indicates PII will be discarded after defined number of seconds)
    "checks": [
        "document_liveness_front",
        "document_liveness_back",
        "selfie_liveness",
        "face_compare",
        "fraud_detection"
    ],
    "conditions": [                        // array optional
        {
             "module": "string"            // string - "firstname check" / "lastname check" / "dob check"
             "criteria": "string"          // string - "eq", "neq" or "fuzzyMatch"
             "minMatchScore": number       // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100
             "matchCommonAliases": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default
             "ignoreMiddleNames": boolean  // optional if firstname check or lastname check module is passed - value will be boolean and false by default
        }
    ],
    "autoDetectTimeout": 40,                // number optional
    "postTimeoutCaptureMode": "none",       // string optional (default: "none") - "none", "manual", or "auto"
    "autoCaptureCountdownSeconds": 10,      // number optional - seconds to wait for auto-capture
    "autoCaptureCountdownVisible": true,    // boolean optional - show countdown UX
    "bypassConfigJS": "string",            // string optional - JavaScript code for custom bypass logic
    "enableManualReview": false,           // boolean optional - enable manual review for the capture session
    "useV1BlinkIdVerify": true             // boolean optional
    "maxRetries": 2,                       // number optional - (default = 2, min = 0, max = 4)
    "bypassConfig": [
        {
            "criteria": "string",          // string
            "enabled": "boolean"           // boolean - true or false
        }
    ]
 }

valid object using piiRetentionConfig for key id_capture array is:

{
    "verifier": "string",                  // string, required, tag of verifier
    "skip": false,                         // boolean, optional, default false
    "debug": false,                        // boolean, optional, default false
    "returnRawData": false,                // boolean optional
    "expireSessionInMin": 10080,           // number optional
    "abandonSessionInMin": 60,             // number optional
    "fraudDetectFailureBypass": true,      // boolean optional
    "piiRetentionConfig": [
        {
            "status": "SUCCESS",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": 300
            }
        },
        {
            "status": "FAILED",
            "value": {
                "pii_retention_off": true
            }
        },
        {
            "status": "NOT_PERFORMED",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": 0
            }
        },
        {
            "status": "REVIEW",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": -1
            }
        },
        {
            "status": "ABANDONED",
            "value": {
                "pii_retention_off": false,
                "pii_retention_ttl": 86400
            }
        }
    ],
    "checks": [
        "document_liveness_front",
        "document_liveness_back",
        "selfie_liveness",
        "face_compare",
        "fraud_detection"
    ],
    "conditions": [                        // array optional
        {
             "module": "string"            // string - "firstname check" / "lastname check" / "dob check"
             "criteria": "string"          // string - "eq", "neq" or "fuzzyMatch"
             "minMatchScore": number       // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100
             "matchCommonAliases": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default
             "ignoreMiddleNames": boolean  // optional if firstname check or lastname check module is passed - value will be boolean and false by default
        }
    ],
    "autoDetectTimeout": 40,                // number optional
    "postTimeoutCaptureMode": "none",       // string optional (default: "none") - "none", "manual", or "auto"
    "autoCaptureCountdownSeconds": 10,      // number optional - seconds to wait for auto-capture
    "autoCaptureCountdownVisible": true,    // boolean optional - show countdown UX
    "useV1BlinkIdVerify": true              // boolean optional
    "maxRetries": 2,                        // number optional - (default = 2, min = 0, max = 4)
    "bypassConfig": [
        {
            "criteria": "string",           // string
            "enabled": "boolean"            // boolean - true or false
        }
    ]
 }

Permanently deletes a verification config. It cannot be undone.

• Only a system, service or service_ext key can be used to delete verification config.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

No content.

This API throw an error if something goes wrong.

Get document verifiers.

• Only a system, service or service_ext key can be used to get document verifiers.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

Returns the list of document verifiers or errors if any.

This API throw an error if something goes wrong.

Get document verifier by tag or id.

• Only a system, service or service_ext key can be used to get document verifier.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

Returns the document verifier object or errors if any.

This API throw an error if something goes wrong.

Create document verifier.

• Only a system, service or service_ext key can be used to create document verifier.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

name (required)

The name of document verifier.

tag (required)

The tag of document verifier.

type (required)

The type of document verifier ['aamva', 'socure', 'idrnd', 'face_compare_msft', 'face_compare_1k', 'basic_ocr', 'mitek_agent', 'mitek_auto', 'tracers', 'authenticid', 'veridas', 'microblink', 'rekognition'].

connectorUrl (required)

The connector url of document verifier. It must be valid RFC 3986 URI.

config (required, can be empty)

The config of document verifier.

Returns

Returns the created document verifier and errors if any.

This API throw an error if something goes wrong.

We are supporting below mentioned verifier types:

['aamva', 'socure', 'idrnd', 'face_compare_msft', 'face_compare_1k', 'basic_ocr', 'mitek_agent', 'mitek_auto', 'tracers', 'authenticid', 'veridas', 'microblink', 'rekognition']

General Request body contains below fields to create document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "string required",
    "connectorUrl": "string required",
    "config": required, can be empty
}

Request body contains below fields to create 'aamva' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "aamva",
    "connectorUrl": "string required",
    "config": {
      "primaryAuthUrl": "string",
      "primaryDLDVUrl": "string",
      "secondaryAuthUrl": "string",
      "secondaryDLDVUrl": "string",
      "valueFreeDldvPrimaryUrl": "string",
      "valueFreeDldvSecondaryUrl": "string",
      "certPath": "string",
      "passphrase": "string",
      "messageOriginatorId": "string",
      "messageDestinationId": "string"
    }
}

Request body contains below fields to create 'socure' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "socure",
    "connectorUrl": "string required",
    "config": {
      "apiKey": "string",
      "url": "string"
    }
}

Request body contains below fields to create 'idrnd' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "idrnd",
    "connectorUrl": "string required",
    "config": {
      "apiKey": "string",
      "url": "string",
      "documentLivenessCheckAPI": "string",
      "documentApiKey": "string",
      "calibration": "string"                          // optional - SOFT | REGULAR | HARDENED
    }
}

Request body contains below fields to create 'face_compare_msft' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "face_compare_msft",
    "connectorUrl": "string required",
    "config": {
      "accounts": [{
         "apiKey": "string",
         "url": "string",
         "urlVerify": "string"
      }],
      "retryCount": "number",
      "returnFaceId": "boolean",
      "returnFaceLandmarks": "boolean",
      "detectionModel": "string",
      "recognitionModel": "string",
      "returnFaceAttributes": "string"
      "faceIdTimeToLive": "number"
    }
}

Request body contains below fields to create 'tracers' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "tracers",
    "connectorUrl": "string required",
    "config": {
      "apName": "string",
      "apPassword": "string",
      "searchType": "string",
      "url": "string",
      "verifyType": "string",
      "verifyUrl": "string",
      "personSearchType": "string",
      "personSearchUrl": "string"
    }
}

Request body contains below fields to create 'authenticid' document verifier.

• Notes:

Steps to add certificate (cfweb_cert, cfweb_key):

• Open https://jsonformatter.org/json-stringify-online link
• Copy and paste the certificate content
• Click on the "JSON stringify" Button
• Copy stringified content and Add that content respective values of cfweb_cert | cfweb_key

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "authenticid",
    "connectorUrl": "string required",
    "config": {
      "airAccessKey": "string",
      "airSecretToken": "string",
      "airAPI": "string",
      "faceAPI": "string",
      "faceAPIKey": "string",
      "documentLivenessCheckAPI": "string",
      "document_share_session_enabled": boolean,
      "accountCode": "string for scan-sessions",
      "cfweb_url": "string for scan-sessions",
      "cfweb_cert": "string for scan-sessions",
      "cfweb_key": "string for scan-sessions",
      "cfweb_channelConfiguration": {
        "enableSelfieCapture": boolean for scan-sessions,
        "enableFarSelfie": boolean for scan-sessions,
        "requestExpiryTimeInMin": number for scan-sessions,
        "reviewScreenFront": boolean for scan-sessions,
        "reviewScreenBack": boolean for scan-sessions,
        "frontCaptureMode": "string for scan-sessions",
        "backCaptureMode": "string for scan-sessions",
        "transactionExpiryTimeInMin": number for scan-sessions,
        "frontCaptureAttempt": "number for scan-sessions",
        "backCaptureAttempt": "number for scan-sessions",
        "selfieCaptureAttempt": "number for scan-sessions",
        "transactionAttempts": "number for scan-sessions",
        "frontSetManualTimeout": number for scan-sessions,
        "backSetManualTimeout": number for scan-sessions
      },
      "cfweb_channelResponse": [ //  for scan-sessions
        "DQL_Classification_DocumentClassName",
        "DQL_Classification_DocumentIssuerCode",
        "DQL_Classification_DocumentIssuerCountry",
        "DQL_Classification_DocumentIssuerCountryCode",
        "DQL_Classification_DocumentName",
        "DQL_Classification_DocumentSeries",
        "DQL_Classification_IssuerName",
        "DQL_Classification_Type",
        "DQL_Final_Address_Result",
        "DQL_Final_BirthDate_Result",
        "DQL_Final_DocumentNumber_Result",
        "DQL_Final_ExpirationDate_Result",
        "DQL_Final_IssueDate_Result",
        "DQL_ExpiredID_Result",
        "DQL_Final_AddressCity_Result",
        "DQL_Final_AddressLine1_Result",
        "DQL_Final_AddressState_Result",
        "DQL_Final_FirstName_Result",
        "DQL_Final_GivenName_Result",
        "DQL_Final_MiddleName_Result",
        "DQL_Final_Sex_Result",
        "DQL_Final_Surname_Result",
        "ImageFront",
        "ImageBack",
        "ImageSelfie",
        "ImageLiveness"
      ]
    }
}

Request body contains below fields to create 'veridas' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "veridas",
    "connectorUrl": "string required",
    "config": {
      "clientUrl": "string",
      "clientId": "string",
      "clientSecretKey": "string",
      "apiUrl": "string",
      "apiKey": "string",
      "faceAPIKey": "string",
      "tokenConfiguration": {
      		"dl": {"flowId":"document_selfie","documentType":"XX","seldocTypeFilter":["DrivingLicense"],"confirm":true,"scores":false},
      		"ppt": {"flowId":"document_selfie","documentType":"XX_Passport_YYYY","seldocTypeFilter":["Passport"],"confirm":true,"scores":false},
      		"idcard": {"flowId":"document_selfie","documentType":"XX","seldocTypeFilter":["IDCard"],"confirm":true,"scores":false}
      },
      "keepTransaction": boolean,
      "document_share_session_enabled": boolean,
    }
}

Request body contains below fields to create 'microblink' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "microblink",
    "connectorUrl": "string required",
    "config": {
      "license": "string required",
      "clientId": "string required",
      "clientSecret": "string required",
      "verifierUrl": "string required",
      "verifierUrlV2": "string required",
      "document_share_session_enabled": boolean required
    }
}

Request body contains below fields to create 'rekognition' document verifier.

{
    "name": "string required",
    "tag": "string required [a-z,A-Z,_,-,0-9]",
    "type": "rekognition",
    "connectorUrl": "string required",
    "config": {
      "awsAccessKey": "string",
      "awsSecretKey": "string",
      "awsRegion": "string"
    }
}

Update document verifier.

• Only a system, service or service_ext key can be used to update document verifier.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

name (optional)

The name of document verifier.

connectorUrl (optional)

The connector url of document verifier.

config (optional)

The config of document verifier.

Returns

Returns the document verifier object if the document verifier object is updated successfully.

This API throws an error if something goes wrong.

Request body contains below fields to update document verifier.

{
    "name": "string optional",
    "connectorUrl": "string optional",
    "config": {}    // optional, json object, will replace full config object if provided.
}

Permanently deletes a document verifier. It cannot be undone.

• Only a system or service or service_ext key can be used to delete document verifier.
• Key must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

No content.

This API throw an error if something goes wrong.

This endpoint returns available service keys. The license you are using must be of authLevel 'system'

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

Returns array with service keys

This endpoint resets service key for given keyId. Deletes current one and recreates a new one. The license you are using must be of authLevel 'system'

Parameters

keyId (required)

The keyId of service key to reset

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Returns

Returns re-created service key

create session.

• Only system, service, service_ext, app or app_ext license can be used to create session.
• License must be authorized for community.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

data (required)

The ECDSA string of data.

Returns

Returns the data of sessionId & url.

This API throw an error if something goes wrong.

Request body contains 'data' field with encrypted object below

{
    "dvcID": "string required",
    "sessionRequest": {
        "tenantDNS": "string required  eg: 'idpass.1kosmos.net'",
        "communityName": "string required eg: 'default'",
        "documentType": "string required eg 'dl_object | ppt_object | idcard_object'",
        "userUID": "string optional",
        "did": "string optional",
        "user": {uid, username, firstname, lastname, dob},
        "expireSessionInMin": "number optional",
        "abandonSessionInMin": "number optional",
        "workflowMetadata": {
            "wfInstanceId": "string optional",
            "workflowId": "string optional",
            // any other key-value pairs allowed
        }
    }
}

• did should be optional
• either userUID should be given OR user object with (any one field uid, username, firstname, lastname, dob) should be given.
• workflowMetadata is optional, can include wfInstanceId, workflowId, and any other properties related to workflow.

check session status.

• any valid license key can be used to check session status.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

data (required)

The ECDSA string of data.

Returns

Returns the ECDSA encrypted data of liveid, dl and public key.

This API throw an error if something goes wrong.

Request body contains 'data' field with encrypted object below

{
    "dvcID": "string required",
    "sessionId": "string required",
    "includeMetadata": "boolean optional - default value is false",
    "alwaysReturnAssets": "boolean optional - default value is false",
    "granularStatus": "boolean optional - default value is false; when true, returns the actual session status (PENDING vs INPROGRESS) without legacy masking"
}

• any valid license key can be used to create verification config.

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

data (required)

The ECDSA string of data.

Returns

Returns the ECDSA encrypted data of docId, docType & certifications json and public key.

This API throw an error if something goes wrong.

Request body contains 'data' field with encrypted object below:

{
    "dvcID": "string required",
    "verifications": ["person_search"],
    "document": {
        "id": "string required",
        "type": "string required",
        "firstName": "string",
        "lastName": "string",
        "dob": "YYYYMMDD",
        "street": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "ssn": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "age": "string"
    }
}

Verify document.

• any valid license key can be used to verify document

Headers

licensekey (required)

License key encrypted with ECDSA

requestid (required)

JSON string encrypted with ECDSA which should contain "appid" (string), "uuid" (string), "deviceId" (string), "did" (string) and "ts" (number) representing epoch timestamp in seconds - it shouldn't be more or less than 'environment.allowed_time_span' seconds from now

publickey (required)

Public key

Request Body

data (required)

The ECDSA string of data.

Returns

Returns the ECDSA encrypted data of docId, docType & certifications json and public key.

This API throw an error if something goes wrong.

Request body contains 'data' field with encrypted object below: for specific document attributes check individual connectors requirements/validations

{
    "dvcID": "string required",
    "verifications": "string array required - ['dl_verify', 'face_liveness', 'face_compare', 'ssn_verify', 'person_verify', 'dl_authenticate', 'ppt_authenticate', 'idcard_authenticate', 'document_liveness']",
    "document": {
        "id": "string required",
        "type": "string required"
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'dl_verify'.

{
    "dvcID": "string required",
    "verifications": ["dl_verify"],
    "document": {
        "id": "string required",
        "type": "string required",,
        "category": "string",
        "proofedBy": "string",
        "firstName": "string",
        "lastName": "string",
        "dob": "string",
        "doe": "string",
        "documentType": "string required",
        "documentId": "string",
        "middleName": "string",
        "familyName": "string",
        "gender": "string",
        "height": "string",
        "eyeColor": "string",
        "street": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "country": "string required",
        "doi": "string",
        "suffixName": "string",
        "nameSuffix": "string"
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'face_liveness'.

{
    "dvcID": "string required",
    "verifications": ["face_liveness"],
    "document": {
        "id": "string required",
        "type": "string required",
        "liveId": "string optional",             // base64
        "liveIdUrl": "string optional"           // presigned Image url
        "purpose": "string optional"             // authentication | registration | doc_enrollment
        "metaHeaders": {
             "operatingSystem": "string optional"    // IOS | ANDROID | DESKTOP | UNKNOWN
             "calibration": "string optional"        // SOFT | REGULAR | HARDENED
        }
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'face_compare'.

For the face_compare, you need either image1/image1Url and image2/image2Url for comparison or liveId/liveIdUrl along with image2/image2Url.

If both liveId/liveIdUrl and image1/image1Url are provided, the comparison will prioritize image1/image1Url with image2/image2Url.

{
    "dvcID": "string required",
    "verifications": ["face_compare"],
    "document": {
        "id": "string required",
        "type": "string required",
        "liveId": "string optional"         // base64
        "image1": "string optional",        // base64
        "image2": "string optional",        // base64
        "liveIdUrl": "string optional",     // presigned Image url
        "image1Url": "string optional",     // presigned Image url
        "image2Url": "string optional",     // presigned Image url
        "purpose": "string"                 // optional authentication || doc_enrollment
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'ssn_verify'.

{
    "dvcID": "string required",
    "verifications": ["ssn_verify"],
    "document": {
        "id": "string required",
        "type": "string required",
        "firstName": "string",
        "lastName": "string - it's required if you are passing firstName",
        "dob": "date - supported format ['yyyyMMdd', 'yyyy/MM/dd', 'yyyy-MM-dd']",
        "street": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "ssn": "string",
        "country": "string"
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'person_verify'.

{
    "dvcID": "string required",
    "verifications": ["person_verify"],
    "document": {
        "id": "string required",
        "type": "string required",
        "firstName": "string required",
        "lastName": "string required",
        "dob": "date required - supported YYYYMMDD",
        "street": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "ssn": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'dl_authenticate'.

{
    "dvcID": "string required",
    "verifications": ["dl_authenticate"],
    "document": {
        "id": "string required",
        "type": "string required - dl",          // case-insensitive
        "front_image": "string optional",        // base64
        "back_image": "string optional",         // base64
        "barcode_image": "string optional",      // base64
        "front_image_flash": "string",           // base64
        "front_image_url": "string optional",    // presigned Image url
        "back_image_url": "string optional",     // presigned Image url
        "barcode_image_url": "string optional",  // presigned Image url
        "front_image_flash_url": "string"        // presigned Image url
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'ppt_authenticate'.

{
    "dvcID": "string required",
    "verifications": ["ppt_authenticate"],
    "document": {
        "id": "string required",
        "type": "string required - ppt",         // case-insensitive
        "front_image": "string optional",        // base64
        "front_image_url": "string optional"     // presigned Image url
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'idcard_authenticate'.

{
    "dvcID": "string required",
    "verifications": ["idcard_authenticate"],
    "document": {
        "id": "string required",
        "type": "string required - idcard",      // case-insensitive
        "front_image": "string optional",        // base64
        "back_image": "string optional",         // base64
        "barcode_image": "string optional",      // base64
        "front_image_flash": "string",           // base64
        "front_image_url": "string optional",    // presigned Image url
        "back_image_url": "string optional",     // presigned Image url
        "barcode_image_url": "string optional",  // presigned Image url
        "front_image_flash_url": "string"        // presigned Image url
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Request body contains below fields to verify 'document_liveness'.

{
    "dvcID": "string required",
    "verifications": ["document_liveness"],
    "document": {
        "id": "string required",
        "type": "string required ",
        "image": "string optional",              // base64
        "imageUrl": "string optional"            // presigned Image url
    },
    "event_info": {
         "ipAddress": "",
         "userAgent": "",
         "session_id": "",
         "mobile_session_id": "",
         "mobile_document_id": "",
         "wfInstanceId": "",
         "workflowId": "",
    } // optional
}

Get base64 string from Image.

Request Body

image (required)

The image key is type of string.

Returns

Returns the base64 string.

This API throw an error if something goes wrong. A common source of error is public or private key is not valid.

Encrypt and decrypt the data string by public key and private key.

Parameters

method (optional)

The method parameter is type of enum. Default value is encrypt.

This parameter only accepts following values

encrypt, decrypt

Request Body

dataStr (required)

The dataStr key is type of string.

publicKey (required)

The publicKey is type of string.

privateKey (required)

The privateKey is type of string.

Returns

Returns the encrypted/decrypted string.

This API throw an error if something goes wrong. A common source of error is public or private key is not valid.

Provide details regarding the environments.

Returns

Returns an environment object

Get healthz

Returns

Returns a healthz object

• ``version = <git-tag>.<commit-id>.<dob>``

• ``git-tag``: When code is compiled from a git-tag, this must carry the tag name. This should match one of the git tags.
• ``commit-id``: This is the git-commit-id. eg: When code is built from this, the hex code, in the end, is the commit it.
• ``dob``: Date Of Build. This is epoc-time-in-se conds that tell the time when the build was created.
• ​if the code is not built from a git-tag, then the ``version =<commit-id>.<dob>``

Get system's public key.

Returns

Returns a public key object

Get all service directories.

Returns

Returns all service directories.

Get well known config

Returns

Returns an object.