{
"openapi": "3.0.0",
"info": {
"title": "DocuVerify services",
"version": "2.0.0",
"license": {}
},
"paths": {
"/.well-known": {
"get": {
"summary": "Get well known config.",
"description": "Get well known config
\n\n| **Returns** |\n|-------------|\nReturns an object.\n",
"tags": [
"Well Known config"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WellKnownResponse"
},
"example": {
"journeyTypes": [
{
"label": "KYC with Face Comparison",
"description": "Verifies the user's identity by matching a live selfie with their government-issued ID.",
"value": "KYC_WITH_FACE_COMPARISON"
},
{
"label": "Document verification only",
"description": "Authenticates identity by checking the validity and authenticity of a government-issued document.",
"value": "DOCUMENT_VERIFICATION_ONLY"
}
],
"documentsList": [
{
"country": "AFGHANISTAN",
"region": "NONE",
"documentType": "ID"
}
],
"dataRetention": [
{
"label": "Discard data immediately",
"value": {
"pii_retention_off": true
}
},
{
"label": "Discard data after caller retrieves result",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": -1
}
},
{
"label": "Discard data after specified time",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
}
],
"dataComparisonAttributes": [
{
"label": "First Name Check",
"module": "firstname check",
"criteriaOptions": [
{
"value": "eq",
"ignoreMiddleNames": false
},
{
"value": "fuzzyMatch",
"minMatchScore": {
"min": 70,
"max": 100,
"default": 85
},
"ignoreMiddleNames": false
}
]
},
{
"label": "Last Name Check",
"module": "lastname check",
"criteriaOptions": [
{
"value": "eq",
"ignoreMiddleNames": false
},
{
"value": "fuzzyMatch",
"minMatchScore": {
"min": 70,
"max": 100,
"default": 85
},
"ignoreMiddleNames": false
}
]
},
{
"label": "DOB Check",
"module": "dob check",
"criteriaOptions": [
{
"value": "eq"
}
]
}
],
"usecase": {
"contexts": [
{
"label": "Remote Verification",
"value": "REMOTE"
},
{
"label": "In-Person Verification",
"value": "IN_PERSON"
}
],
"documentVerificationPolicy": [
{
"label": "Permissive",
"description": "Permissive policy means lower FRR and higher FAR",
"value": "PERMISSIVE"
},
{
"label": "Standard (Recommended)",
"description": "Standard policy means balanced FAR and FRR",
"value": "STANDARD"
},
{
"label": "Strict",
"description": "Strict policy means higher FRR and lower FAR",
"value": "STRICT"
},
{
"label": "Very strict",
"description": "Very Strict policy means even higher FRR than Strict policy, with lower FAR",
"value": "VERY_STRICT"
}
]
},
"retryCount": {
"maxValue": 4,
"defaultValue": 2
},
"selfieRetryCount": {
"maxValue": 10,
"defaultValue": 3
},
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"livenessLevels": [
{
"label": "Regular",
"description": "Targets more convenience with acceptable level of security.",
"value": "REGULAR"
},
{
"label": "Soft",
"description": "Achieves lower errors in classifying legitimate users.",
"value": "SOFT"
},
{
"label": "Hardened",
"description": "Represents the tightest security.",
"value": "HARDENED"
}
],
"faceMatchingScore": 50,
"selfieCaptureModes": [
{
"label": "Auto",
"description": "Automatically capture the selfie when a face is detected, without any user intervention.",
"value": "auto"
},
{
"label": "Manual with Face Detection",
"description": "Displays a capture button, only displays when face is not detected.",
"value": "manualWithFaceDetection"
}
]
}
}
}
}
}
}
},
"/verify": {
"post": {
"summary": "Verify document.",
"description": "Verify document.
\n- any valid license key can be used to verify document\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### data (required)\nThe ECDSA string of data.\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the ECDSA encrypted data of docId, docType & certifications json and public key.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verify"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "Request body contains 'data' field with encrypted object below: for specific document attributes check individual connectors requirements/validations\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": \"string array required - ['dl_verify', 'face_liveness', 'face_compare', 'ssn_verify', 'person_verify', 'dl_authenticate', 'ppt_authenticate', 'idcard_authenticate', 'document_liveness']\",\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\"\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'dl_verify'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"dl_verify\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\",,\n \"category\": \"string\",\n \"proofedBy\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"dob\": \"string\",\n \"doe\": \"string\",\n \"documentType\": \"string required\",\n \"documentId\": \"string\",\n \"middleName\": \"string\",\n \"familyName\": \"string\",\n \"gender\": \"string\",\n \"height\": \"string\",\n \"eyeColor\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zipCode\": \"string\",\n \"country\": \"string required\",\n \"doi\": \"string\",\n \"suffixName\": \"string\",\n \"nameSuffix\": \"string\"\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'face_liveness'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"face_liveness\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\",\n \"liveId\": \"string optional\", // base64\n \"liveIdUrl\": \"string optional\" // presigned Image url\n \"purpose\": \"string optional\" // authentication | registration | doc_enrollment\n \"metaHeaders\": {\n \"operatingSystem\": \"string optional\" // IOS | ANDROID | DESKTOP | UNKNOWN\n \"calibration\": \"string optional\" // SOFT | REGULAR | HARDENED\n }\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'face_compare'.
\nFor the face_compare, you need either image1/image1Url and image2/image2Url for comparison or liveId/liveIdUrl along with image2/image2Url.
\nIf both liveId/liveIdUrl and image1/image1Url are provided, the comparison will prioritize image1/image1Url with image2/image2Url.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"face_compare\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\",\n \"liveId\": \"string optional\" // base64\n \"image1\": \"string optional\", // base64\n \"image2\": \"string optional\", // base64\n \"liveIdUrl\": \"string optional\", // presigned Image url\n \"image1Url\": \"string optional\", // presigned Image url\n \"image2Url\": \"string optional\", // presigned Image url\n \"purpose\": \"string\" // optional authentication || doc_enrollment\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'ssn_verify'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"ssn_verify\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\",\n \"firstName\": \"string\",\n \"lastName\": \"string - it's required if you are passing firstName\",\n \"dob\": \"date - supported format ['yyyyMMdd', 'yyyy/MM/dd', 'yyyy-MM-dd']\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zipCode\": \"string\",\n \"ssn\": \"string\",\n \"country\": \"string\"\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'person_verify'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"person_verify\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\",\n \"firstName\": \"string required\",\n \"lastName\": \"string required\",\n \"dob\": \"date required - supported YYYYMMDD\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zipCode\": \"string\",\n \"ssn\": \"string\",\n \"country\": \"string\",\n \"phone\": \"string\",\n \"email\": \"string\",\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'dl_authenticate'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"dl_authenticate\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required - dl\", // case-insensitive\n \"front_image\": \"string optional\", // base64\n \"back_image\": \"string optional\", // base64\n \"barcode_image\": \"string optional\", // base64\n \"front_image_flash\": \"string\", // base64\n \"front_image_url\": \"string optional\", // presigned Image url\n \"back_image_url\": \"string optional\", // presigned Image url\n \"barcode_image_url\": \"string optional\", // presigned Image url\n \"front_image_flash_url\": \"string\" // presigned Image url\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'ppt_authenticate'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"ppt_authenticate\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required - ppt\", // case-insensitive\n \"front_image\": \"string optional\", // base64\n \"front_image_url\": \"string optional\" // presigned Image url\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'idcard_authenticate'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"idcard_authenticate\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required - idcard\", // case-insensitive\n \"front_image\": \"string optional\", // base64\n \"back_image\": \"string optional\", // base64\n \"barcode_image\": \"string optional\", // base64\n \"front_image_flash\": \"string\", // base64\n \"front_image_url\": \"string optional\", // presigned Image url\n \"back_image_url\": \"string optional\", // presigned Image url\n \"barcode_image_url\": \"string optional\", // presigned Image url\n \"front_image_flash_url\": \"string\" // presigned Image url\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n\nRequest body contains below fields to verify 'document_liveness'.\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"document_liveness\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required \",\n \"image\": \"string optional\", // base64\n \"imageUrl\": \"string optional\" // presigned Image url\n },\n \"event_info\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"session_id\": \"\",\n \"mobile_session_id\": \"\",\n \"mobile_document_id\": \"\",\n \"wfInstanceId\": \"\",\n \"workflowId\": \"\",\n } // optional\n}\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/verifier/community/{communityId}": {
"put": {
"summary": "Create document verifier",
"description": "Create document verifier.
\n- Only a **system**, **service** or **service_ext** key can be used to create document verifier.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### name (required)\nThe name of document verifier.\n\n
\n### tag (required)\nThe tag of document verifier.\n\n
\n### type (required)\nThe type of document verifier ['aamva', 'socure', 'idrnd', 'face_compare_msft', 'face_compare_1k', 'basic_ocr', 'mitek_agent', 'mitek_auto', 'tracers', 'authenticid', 'veridas', 'microblink', 'rekognition'].\n\n
\n### connectorUrl (required)\nThe connector url of document verifier. It must be valid RFC 3986 URI.\n\n
\n### config (required, can be empty)\nThe config of document verifier.\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the created document verifier and errors if any.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verifier"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "We are supporting below mentioned verifier types:\n```\n['aamva', 'socure', 'idrnd', 'face_compare_msft', 'face_compare_1k', 'basic_ocr', 'mitek_agent', 'mitek_auto', 'tracers', 'authenticid', 'veridas', 'microblink', 'rekognition']\n```\n\nGeneral Request body contains below fields to create document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"string required\",\n \"connectorUrl\": \"string required\",\n \"config\": required, can be empty\n}\n```\n\nRequest body contains below fields to create 'aamva' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"aamva\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"primaryAuthUrl\": \"string\",\n \"primaryDLDVUrl\": \"string\",\n \"secondaryAuthUrl\": \"string\",\n \"secondaryDLDVUrl\": \"string\",\n \"valueFreeDldvPrimaryUrl\": \"string\",\n \"valueFreeDldvSecondaryUrl\": \"string\",\n \"certPath\": \"string\",\n \"passphrase\": \"string\",\n \"messageOriginatorId\": \"string\",\n \"messageDestinationId\": \"string\"\n }\n}\n```\n\nRequest body contains below fields to create 'socure' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"socure\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"apiKey\": \"string\",\n \"url\": \"string\"\n }\n}\n```\n\nRequest body contains below fields to create 'idrnd' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"idrnd\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"apiKey\": \"string\",\n \"url\": \"string\",\n \"documentLivenessCheckAPI\": \"string\",\n \"documentApiKey\": \"string\",\n \"calibration\": \"string\" // optional - SOFT | REGULAR | HARDENED\n }\n}\n```\n\nRequest body contains below fields to create 'face_compare_msft' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"face_compare_msft\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"accounts\": [{\n \"apiKey\": \"string\",\n \"url\": \"string\",\n \"urlVerify\": \"string\"\n }],\n \"retryCount\": \"number\",\n \"returnFaceId\": \"boolean\",\n \"returnFaceLandmarks\": \"boolean\",\n \"detectionModel\": \"string\",\n \"recognitionModel\": \"string\",\n \"returnFaceAttributes\": \"string\"\n \"faceIdTimeToLive\": \"number\"\n }\n}\n```\n\nRequest body contains below fields to create 'tracers' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"tracers\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"apName\": \"string\",\n \"apPassword\": \"string\",\n \"searchType\": \"string\",\n \"url\": \"string\",\n \"verifyType\": \"string\",\n \"verifyUrl\": \"string\",\n \"personSearchType\": \"string\",\n \"personSearchUrl\": \"string\"\n }\n}\n```\n\nRequest body contains below fields to create 'authenticid' document verifier.\n- **Notes**:
\nSteps to add certificate (cfweb_cert, cfweb_key):\n - Open https://jsonformatter.org/json-stringify-online link\n - Copy and paste the certificate content\n - Click on the \"JSON stringify\" Button\n - Copy stringified content and Add that content respective values of cfweb_cert | cfweb_key\n\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"authenticid\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"airAccessKey\": \"string\",\n \"airSecretToken\": \"string\",\n \"airAPI\": \"string\",\n \"faceAPI\": \"string\",\n \"faceAPIKey\": \"string\",\n \"documentLivenessCheckAPI\": \"string\",\n \"document_share_session_enabled\": boolean,\n \"accountCode\": \"string for scan-sessions\",\n \"cfweb_url\": \"string for scan-sessions\",\n \"cfweb_cert\": \"string for scan-sessions\",\n \"cfweb_key\": \"string for scan-sessions\",\n \"cfweb_channelConfiguration\": {\n \"enableSelfieCapture\": boolean for scan-sessions,\n \"enableFarSelfie\": boolean for scan-sessions,\n \"requestExpiryTimeInMin\": number for scan-sessions,\n \"reviewScreenFront\": boolean for scan-sessions,\n \"reviewScreenBack\": boolean for scan-sessions,\n \"frontCaptureMode\": \"string for scan-sessions\",\n \"backCaptureMode\": \"string for scan-sessions\",\n \"transactionExpiryTimeInMin\": number for scan-sessions,\n \"frontCaptureAttempt\": \"number for scan-sessions\",\n \"backCaptureAttempt\": \"number for scan-sessions\",\n \"selfieCaptureAttempt\": \"number for scan-sessions\",\n \"transactionAttempts\": \"number for scan-sessions\",\n \"frontSetManualTimeout\": number for scan-sessions,\n \"backSetManualTimeout\": number for scan-sessions\n },\n \"cfweb_channelResponse\": [ // for scan-sessions\n \"DQL_Classification_DocumentClassName\",\n \"DQL_Classification_DocumentIssuerCode\",\n \"DQL_Classification_DocumentIssuerCountry\",\n \"DQL_Classification_DocumentIssuerCountryCode\",\n \"DQL_Classification_DocumentName\",\n \"DQL_Classification_DocumentSeries\",\n \"DQL_Classification_IssuerName\",\n \"DQL_Classification_Type\",\n \"DQL_Final_Address_Result\",\n \"DQL_Final_BirthDate_Result\",\n \"DQL_Final_DocumentNumber_Result\",\n \"DQL_Final_ExpirationDate_Result\",\n \"DQL_Final_IssueDate_Result\",\n \"DQL_ExpiredID_Result\",\n \"DQL_Final_AddressCity_Result\",\n \"DQL_Final_AddressLine1_Result\",\n \"DQL_Final_AddressState_Result\",\n \"DQL_Final_FirstName_Result\",\n \"DQL_Final_GivenName_Result\",\n \"DQL_Final_MiddleName_Result\",\n \"DQL_Final_Sex_Result\",\n \"DQL_Final_Surname_Result\",\n \"ImageFront\",\n \"ImageBack\",\n \"ImageSelfie\",\n \"ImageLiveness\"\n ]\n }\n}\n```\n\nRequest body contains below fields to create 'veridas' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"veridas\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"clientUrl\": \"string\",\n \"clientId\": \"string\",\n \"clientSecretKey\": \"string\",\n \"apiUrl\": \"string\",\n \"apiKey\": \"string\",\n \"faceAPIKey\": \"string\",\n \"tokenConfiguration\": {\n \t\t\"dl\": {\"flowId\":\"document_selfie\",\"documentType\":\"XX\",\"seldocTypeFilter\":[\"DrivingLicense\"],\"confirm\":true,\"scores\":false},\n \t\t\"ppt\": {\"flowId\":\"document_selfie\",\"documentType\":\"XX_Passport_YYYY\",\"seldocTypeFilter\":[\"Passport\"],\"confirm\":true,\"scores\":false},\n \t\t\"idcard\": {\"flowId\":\"document_selfie\",\"documentType\":\"XX\",\"seldocTypeFilter\":[\"IDCard\"],\"confirm\":true,\"scores\":false}\n },\n \"keepTransaction\": boolean,\n \"document_share_session_enabled\": boolean,\n }\n}\n```\n\nRequest body contains below fields to create 'microblink' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"microblink\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"license\": \"string required\",\n \"clientId\": \"string required\",\n \"clientSecret\": \"string required\",\n \"verifierUrl\": \"string required\",\n \"verifierUrlV2\": \"string required\",\n \"document_share_session_enabled\": boolean required\n }\n}\n```\n\nRequest body contains below fields to create 'rekognition' document verifier.\n```\n{\n \"name\": \"string required\",\n \"tag\": \"string required [a-z,A-Z,_,-,0-9]\",\n \"type\": \"rekognition\",\n \"connectorUrl\": \"string required\",\n \"config\": {\n \"awsAccessKey\": \"string\",\n \"awsSecretKey\": \"string\",\n \"awsRegion\": \"string\"\n }\n}\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVerifierRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVerifierResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"summary": "Get document verifiers",
"description": "Get document verifiers.
\n- Only a **system**, **service** or **service_ext** key can be used to get document verifiers.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the list of document verifiers or errors if any.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verifier"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetVerifiersResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Document verifiers are Not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/verifier/community/{communityId}/{id_or_tag}": {
"patch": {
"summary": "Update document verifier",
"description": "Update document verifier.
\n- Only a **system**, **service** or **service_ext** key can be used to update document verifier.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### name (optional)\nThe name of document verifier.\n\n
\n### connectorUrl (optional)\nThe connector url of document verifier.\n\n
\n### config (optional)\nThe config of document verifier.\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the document verifier object if the document verifier object is updated successfully.
\nThis API throws an error if something goes wrong.\n",
"tags": [
"Verifier"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "id_or_tag",
"in": "path",
"description": "Document verifier id or tag.",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
}
],
"requestBody": {
"description": "Request body contains below fields to update document verifier.\n```\n{\n \"name\": \"string optional\",\n \"connectorUrl\": \"string optional\",\n \"config\": {} // optional, json object, will replace full config object if provided.\n}\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateVerifierRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateVerifierResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"summary": "Get document verifier by tag or id",
"description": "Get document verifier by tag or id.
\n- Only a **system**, **service** or **service_ext** key can be used to get document verifier.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the document verifier object or errors if any.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verifier"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "id_or_tag",
"in": "path",
"description": "Document verifier id or tag.",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
}
],
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetVerifierResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Document verifier is not found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"summary": "Delete document verifier",
"description": "Permanently deletes a document verifier. It cannot be undone.
\n- Only a **system** or **service** or **service_ext** key can be used to delete document verifier.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Returns** |\n|----------------------------------------------|\n\nNo content.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verifier"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "id_or_tag",
"in": "path",
"description": "Document verifier id or tag.",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/verificationConfig/community/{communityId}": {
"put": {
"summary": "Create verification config",
"description": "Create verification config.
\n- Only a **system**, **service** or **service_ext** key can be used to create verification config.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### tag (required)\nThe tag of verification config.\n\n### tenantId (required)\nID of tenant\n\n### name (optional)\nThe name of verification config. default will be \"no-name\"\n\n
\n### face_liveness (conditional)\nThe config array of face_liveness.
\nOptional - 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.\n\n
\n### face_compare (conditional)\nThe config array of face_compare.
\nOptional - 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.\n\n
\n### dl_verify (conditional)\nThe config array of dl_verify.
\nOptional - 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.\n\n
\n### ssn_verify (conditional)\nThe config array of ssn_verify.
\nOptional - 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.\n\n
\n### person_verify (conditional)\nThe config array of person_verify.
\nOptional - 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.\n\n
\n### dl_authenticate (conditional)\nThe config array of dl_authenticate.
\nOptional - 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.\n\n
\n### ppt_authenticate (conditional)\nThe config array of ppt_authenticate.
\nOptional - 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.\n\n
\n### document_liveness (conditional)\nThe config array of document_liveness.
\nOptional - 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.\n\n
\n### idcard_authenticate (conditional)\nThe config array of idcard_authenticate.
\nOptional - 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.\n\n
\n### id_capture (conditional)\nThe config array of id_capture.
\nOptional - 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.\n\n
\n### face_rekognition (conditional)\nThe config array of face_rekognition.
\nOptional - 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.\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the created verification config and errors if any.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verification Config"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "Request body contains below fields to create verification config.\n```\n{\n \"tenantId\": \"string required\", // ID of tenant\n \"tag\": \"string required\", // string, allows alphanumeric characters, underscore & hyphen.\n \"name\": \"string\", // string, default will be \"no-name\".\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n}\n```\n\nvalid object for **face_liveness** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"min_confidence\": 0.7, // number optional\n \"min_quality\": 0.5, // number optional\n \"selfieCaptureMode\": \"string\", // string optional - auto | manualWithFaceDetection\n \"pipeline\": \"string\", // string optional\n \"other_pipelines\": {\n \"authentication\": \"string\", // string optional\n \"registration\": \"string\", // string optional\n \"doc_enrollment\": \"string\" // string optional\n }\n}\n```\n\nvalid object for **face_compare** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0.7,\t\t\t\t\t// number required\n \"other_confidence\": {\n \"authentication\": 0.9,\t\t\t\t// number optional, 0-1\n \"doc_enrollment\": 0.7\t\t\t\t// number optional, 0-1\n }\n}\n```\n\n\nvalid object for key **face_rekognition** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0.7, // number required\n}\n```\n\nvalid object for key **dl_verify** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"include_states\": [\"NY\", \"NJ\"], // array of string\n \"exclude_states\": [\"AL\", \"AK\"], // array of string\n \"dob_match_required\": true, // boolean optional\n \"first_name_exact_match_required\": true, // boolean optional\n \"first_name_fuzzy_match_required\": true, // boolean optional\n \"last_name_exact_match_required\": true, // boolean optional\n \"last_name_fuzzy_match_required\": true, // boolean optional\n \"middle_name_exact_match_required\": true,// boolean optional\n \"middle_name_fuzzy_match_required\": true,// boolean optional\n \"doc_category_match_required\": true, // boolean optional\n \"doi_match_required\": true // boolean optional\n \"doe_match_required\": true // boolean optional\n \"person_sex_match_required\": true // boolean optional\n \"person_height_match_required\": true // boolean optional\n \"person_eye_color_match_required\": true // boolean optional\n \"address_match_required\": true // boolean optional\n \"city_match_required\": true // boolean optional\n \"state_match_required\": true // boolean optional\n \"zip_match_required\": true // boolean optional\n \"dl_number_match_required\": true, // boolean optional\n \"weights\": {\n \"dob_match_required\": 0, // number optional\n \"first_name_exact_match_required\": 0, // number optional\n \"first_name_fuzzy_match_required\": 0, // number optional\n \"last_name_exact_match_required\": 0, // number optional\n \"last_name_fuzzy_match_required\": 0, // number optional\n \"middle_name_exact_match_required\": 0,// number optional\n \"middle_name_fuzzy_match_required\": 0,// number optional\n \"doc_category_match_required\": 0, // number optional\n \"doi_match_required\": 0, // number optional\n \"doe_match_required\": 0, // number optional\n \"person_sex_match_required\": 0, // number optional\n \"person_height_match_required\": 0, // number optional\n \"person_eye_color_match_required\": 0, // number optional\n \"address_match_required\": 0, // number optional\n \"city_match_required\": 0, // number optional\n \"state_match_required\": 0, // number optional\n \"zip_match_required\": 0, // number optional\n \"dl_number_match_required\": 0 // number optional\n } // optional\n}\n```\n\nvalid object for key **ssn_verify** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"min_confidence\": 0 // number optional\n \"first_name_match_confidence\": 0 // number optional\n \"last_name_match_confidence\": 0 // number optional\n \"ssn_match_confidence\": 0 // number optional\n \"dob_match_confidence\": 0 // number optional\n \"age_match_confidence\": 0 // number optional\n \"address_match_confidence\": 0 // number optional\n \"identity_verified\": true // boolean optional\n}\n```\n\nvalid object for key **person_verify** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0 // number optional\n \"first_name_match_confidence\": 0 // number optional\n \"last_name_match_confidence\": 0 // number optional\n \"ssn_match_confidence\": 0 // number optional\n \"dob_match_confidence\": 0 // number optional\n \"age_match_confidence\": 0 // number optional\n \"address_match_confidence\": 0 // number optional\n \"identity_verified\": true // boolean optional\n}\n```\n\nvalid object for key **person_search** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0 // number optional\n}\n```\n\nvalid object for key **dl_authenticate** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"action_code\": 0, // number, optional\n \"document_type\": \"00\", // string, optional 00 - License, 01- License/Passport, 11 - Passport\n \"document_front_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"document_back_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"face_assertion_score\": 0.5 // number optional - null/missing or 0.0 means DO NOT perform liveness check\n}\n```\n\nvalid object for key **ppt_authenticate** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"action_code\": 0, // number, optional\n \"document_type\": \"11\", // string, optional 00 - License, 01- License/Passport, 11 - Passport\n \"document_front_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"face_assertion_score\": 0.7 // number optional - null/missing or 0.0 means DO NOT perform liveness check\n}\n```\n\nvalid object for key **document_liveness** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"min_confidence\": 0.5 // number required\n}\n```\n\nvalid object for key **idcard_authenticate** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"action_code\": 0, // number, optional\n \"document_type\": \"00\", // string, optional 00 - License, 01- License/Passport, 11 - Passport\n \"document_front_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"document_back_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"face_assertion_score\": 0.5 // number optional - null/missing or 0.0 means DO NOT perform liveness check\n}\n```\n\nvalid object using **pii_retention_off/pii_retention_ttl** for key **id_capture** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"expireSessionInMin\": 10080, // number optional\n \"abandonSessionInMin\": 60, // number optional\n \"fraudDetectFailureBypass\": true, // boolean optional\n \"pii_retention_off\": false, // number optional\n \"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)\n \"checks\": [\n \"document_liveness_front\",\n \"document_liveness_back\",\n \"selfie_liveness\",\n \"face_compare\",\n \"fraud_detection\"\n ],\n \"conditions\": [ // array optional\n {\n \"module\": \"string\" // string - \"firstname check\" / \"lastname check\" / \"dob check\"\n \"criteria\": \"string\" // string - \"eq\", \"neq\" or \"fuzzyMatch\"\n \"minMatchScore\": number // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100\n \"matchCommonAliases\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n \"ignoreMiddleNames\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n }\n ],\n \"autoDetectTimeout\": 40, // number optional\n \"postTimeoutCaptureMode\": \"none\", // string optional (default: \"none\") - \"none\", \"manual\", or \"auto\"\n \"autoCaptureCountdownSeconds\": 10, // number optional - seconds to wait for auto-capture\n \"autoCaptureCountdownVisible\": true, // boolean optional - show countdown UX\n \"useV1BlinkIdVerify\": true // boolean optional\n \"maxRetries\": 2, // number optional - (default = 2, min = 0, max = 4)\n \"bypassConfig\": [\n {\n \"criteria\": \"string\", // string\n \"enabled\": \"boolean\" // boolean - true or false\n }\n ]\n }\n```\n\nvalid object using **piiRetentionConfig** for key **id_capture** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"expireSessionInMin\": 10080, // number optional\n \"abandonSessionInMin\": 60, // number optional\n \"fraudDetectFailureBypass\": true, // boolean optional\n \"piiRetentionConfig\": [\n {\n \"status\": \"SUCCESS\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": 300\n }\n },\n {\n \"status\": \"FAILED\",\n \"value\": {\n \"pii_retention_off\": true\n }\n },\n {\n \"status\": \"NOT_PERFORMED\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": 0\n }\n },\n {\n \"status\": \"REVIEW\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": -1\n }\n },\n {\n \"status\": \"ABANDONED\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": 86400\n }\n }\n ],\n \"checks\": [\n \"document_liveness_front\",\n \"document_liveness_back\",\n \"selfie_liveness\",\n \"face_compare\",\n \"fraud_detection\"\n ],\n \"conditions\": [ // array optional\n {\n \"module\": \"string\" // string - \"firstname check\" / \"lastname check\" / \"dob check\"\n \"criteria\": \"string\" // string - \"eq\", \"neq\" or \"fuzzyMatch\"\n \"minMatchScore\": number // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100\n \"matchCommonAliases\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n \"ignoreMiddleNames\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n }\n ],\n \"autoDetectTimeout\": 40, // number optional\n \"postTimeoutCaptureMode\": \"none\", // string optional (default: \"none\") - \"none\", \"manual\", or \"auto\"\n \"autoCaptureCountdownSeconds\": 10, // number optional - seconds to wait for auto-capture\n \"autoCaptureCountdownVisible\": true, // boolean optional - show countdown UX\n \"bypassConfigJS\": \"string\", // string optional - JavaScript code for custom bypass logic\n \"enableManualReview\": false, // boolean optional - enable manual review for the capture session\n \"useV1BlinkIdVerify\": true // boolean optional\n \"maxRetries\": 2, // number optional - (default = 2, min = 0, max = 4)\n \"bypassConfig\": [\n {\n \"criteria\": \"string\", // string\n \"enabled\": \"boolean\" // boolean - true or false\n }\n ]\n }\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVerificationConfigRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVerificationConfigResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"summary": "Get verification configs",
"description": "Get verification configs.
\n- Only a **system**, **service** or **service_ext** key can be used to get verification config.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the list of verification config or errors if any.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verification Config"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"in": "query",
"name": "pattern",
"description": "Optional substring to filter verification configs by name (case-insensitive). Treated as a literal string, not a regex pattern. Max 250 characters.",
"required": false,
"schema": {
"type": "string",
"maxLength": 250,
"example": "my-config"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetVerificationConfigsResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Verification config are not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/verificationConfig/community/{communityId}/{id_or_tag}": {
"patch": {
"summary": "Update verification config",
"description": "Update verification config.
\n- Only a **system**, **service** or **service_ext** key can be used to update verification config.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### name (optional)\nThe name of verification config. default will be \"no-name\"\n\n
\n### face_liveness (conditional)\nThe config array of face_liveness.
\nOptional - 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.\n\n
\n### face_compare (conditional)\nThe config array of face_compare.
\nOptional - 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.\n\n
\n### dl_verify (conditional)\nThe config array of dl_verify.
\nOptional - 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.\n\n
\n### ssn_verify (conditional)\nThe config array of ssn_verify.
\nOptional - 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.\n\n
\n### person_verify (conditional)\nThe config array of person_verify.
\nOptional - 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.\n\n
\n### dl_authenticate (conditional)\nThe config array of dl_authenticate.
\nOptional - 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.\n\n
\n### ppt_authenticate (conditional)\nThe config array of ppt_authenticate.
\nOptional - 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.\n\n
\n### document_liveness (conditional)\nThe config array of document_liveness.
\nOptional - 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.\n\n
\n### idcard_authenticate (conditional)\nThe config array of idcard_authenticate.
\nOptional - 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.\n\n
\n### id_capture (conditional)\nThe config array of id_capture.
\nOptional - 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.\n\n
\n### face_rekognition (conditional)\nThe config array of face_rekognition.
\nOptional - 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.\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the verification config object if the verification config object is updated successfully.
\nThis API throws an error if something goes wrong.\n",
"tags": [
"Verification Config"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "id_or_tag",
"in": "path",
"description": "Verification config id or tag.",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "Request body contains below fields to update verification config.\n```\n{\n \"name\": \"string required\", // string.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n \"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.\n}\n```\n\nvalid object for **face_liveness** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"min_confidence\": 0.7, // number optional\n \"min_quality\": 0.5, // number optional\n \"selfieCaptureMode\": \"string\", // string optional - auto | manualWithFaceDetection\n \"pipeline\": \"string\", // string optional\n \"other_pipelines\": {\n \"authentication\": \"string\", // string optional\n \"registration\": \"string\", // string optional\n \"doc_enrollment\": \"string\" // string optional\n }\n}\n```\n\nvalid object for **face_compare** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"default_min_confidence\": 0.6, // number optional\n \"authentication_min_confidence\": 0.9, // number optional\n \"doc_enrollment_min_confidence: 0.6 // number optional\n}\n```\n\nvalid object for key **face_rekognition** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0.7, // number required\n}\n```\nvalid object for key **dl_verify** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"include_states\": [\"NY\", \"NJ\"], // array of string\n \"exclude_states\": [\"AL\", \"AK\"], // array of string\n \"dob_match_required\": true, // boolean optional\n \"first_name_exact_match_required\": true, // boolean optional\n \"first_name_fuzzy_match_required\": true, // boolean optional\n \"last_name_exact_match_required\": true, // boolean optional\n \"last_name_fuzzy_match_required\": true, // boolean optional\n \"middle_name_exact_match_required\": true,// boolean optional\n \"middle_name_fuzzy_match_required\": true,// boolean optional\n \"doc_category_match_required\": true, // boolean optional\n \"doi_match_required\": true // boolean optional\n \"doe_match_required\": true // boolean optional\n \"person_sex_match_required\": true // boolean optional\n \"person_height_match_required\": true // boolean optional\n \"person_eye_color_match_required\": true // boolean optional\n \"address_match_required\": true // boolean optional\n \"city_match_required\": true // boolean optional\n \"state_match_required\": true // boolean optional\n \"zip_match_required\": true // boolean optional\n \"dl_number_match_required\": true, // boolean optional\n \"weights\": {\n \"dob_match_required\": 0, // number optional\n \"first_name_exact_match_required\": 0, // number optional\n \"first_name_fuzzy_match_required\": 0, // number optional\n \"last_name_exact_match_required\": 0, // number optional\n \"last_name_fuzzy_match_required\": 0, // number optional\n \"middle_name_exact_match_required\": 0,// number optional\n \"middle_name_fuzzy_match_required\": 0,// number optional\n \"doc_category_match_required\": 0, // number optional\n \"doi_match_required\": 0, // number optional\n \"doe_match_required\": 0, // number optional\n \"person_sex_match_required\": 0, // number optional\n \"person_height_match_required\": 0, // number optional\n \"person_eye_color_match_required\": 0, // number optional\n \"address_match_required\": 0, // number optional\n \"city_match_required\": 0, // number optional\n \"state_match_required\": 0, // number optional\n \"zip_match_required\": 0, // number optional\n \"dl_number_match_required\": 0 // number optional\n } // optional\n}\n```\n\nvalid object for key **ssn_verify** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"min_confidence\": 0 // number optional\n \"first_name_match_confidence\": 0 // number optional\n \"last_name_match_confidence\": 0 // number optional\n \"ssn_match_confidence\": 0 // number optional\n \"dob_match_confidence\": 0 // number optional\n \"age_match_confidence\": 0 // number optional\n \"address_match_confidence\": 0 // number optional\n \"identity_verified\": true // boolean optional\n}\n```\n\nvalid object for key **person_verify** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0 // number optional\n \"first_name_match_confidence\": 0 // number optional\n \"last_name_match_confidence\": 0 // number optional\n \"ssn_match_confidence\": 0 // number optional\n \"dob_match_confidence\": 0 // number optional\n \"age_match_confidence\": 0 // number optional\n \"address_match_confidence\": 0 // number optional\n \"identity_verified\": true // boolean optional\n}\n```\n\nvalid object for key **person_search** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"min_confidence\": 0 // number optional\n}\n```\n\nvalid object for key **dl_authenticate** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"action_code\": 0, // number, optional\n \"document_type\": \"00\", // string, optional 00 - License, 01- License/Passport, 11 - Passport\n \"document_front_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"document_back_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"face_assertion_score\": 0.5 // number optional - null/missing or 0.0 means DO NOT perform liveness check\n}\n```\n\nvalid object for key **ppt_authenticate** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"action_code\": 0, // number, optional\n \"document_type\": \"11\", // string, optional 00 - License, 01- License/Passport, 11 - Passport\n \"document_front_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"face_assertion_score\": 0.5 // number optional - null/missing or 0.0 means DO NOT perform liveness check\n}\n```\n\nvalid object for key **document_liveness** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"min_confidence\": 0.5 // number required\n}\n```\n\nvalid object for key **idcard_authenticate** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"action_code\": 0, // number, optional\n \"document_type\": \"00\", // string, optional 00 - License, 01- License/Passport, 11 - Passport\n \"document_front_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"document_back_liveness\": 0.5, // number optional - null/missing or 0.0 means DO NOT perform liveness check\n \"face_assertion_score\": 0.5 // number optional - null/missing or 0.0 means DO NOT perform liveness check\n}\n```\n\nvalid object using **pii_retention_off/pii_retention_ttl** for key **id_capture** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"expireSessionInMin\": 10080, // number optional\n \"abandonSessionInMin\": 60, // number optional\n \"fraudDetectFailureBypass\": true, // boolean optional\n \"pii_retention_off\": false, // number optional\n \"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)\n \"checks\": [\n \"document_liveness_front\",\n \"document_liveness_back\",\n \"selfie_liveness\",\n \"face_compare\",\n \"fraud_detection\"\n ],\n \"conditions\": [ // array optional\n {\n \"module\": \"string\" // string - \"firstname check\" / \"lastname check\" / \"dob check\"\n \"criteria\": \"string\" // string - \"eq\", \"neq\" or \"fuzzyMatch\"\n \"minMatchScore\": number // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100\n \"matchCommonAliases\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n \"ignoreMiddleNames\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n }\n ],\n \"autoDetectTimeout\": 40, // number optional\n \"postTimeoutCaptureMode\": \"none\", // string optional (default: \"none\") - \"none\", \"manual\", or \"auto\"\n \"autoCaptureCountdownSeconds\": 10, // number optional - seconds to wait for auto-capture\n \"autoCaptureCountdownVisible\": true, // boolean optional - show countdown UX\n \"bypassConfigJS\": \"string\", // string optional - JavaScript code for custom bypass logic\n \"enableManualReview\": false, // boolean optional - enable manual review for the capture session\n \"useV1BlinkIdVerify\": true // boolean optional\n \"maxRetries\": 2, // number optional - (default = 2, min = 0, max = 4)\n \"bypassConfig\": [\n {\n \"criteria\": \"string\", // string\n \"enabled\": \"boolean\" // boolean - true or false\n }\n ]\n }\n```\n\nvalid object using **piiRetentionConfig** for key **id_capture** array is:\n```\n{\n \"verifier\": \"string\", // string, required, tag of verifier\n \"skip\": false, // boolean, optional, default false\n \"debug\": false, // boolean, optional, default false\n \"returnRawData\": false, // boolean optional\n \"expireSessionInMin\": 10080, // number optional\n \"abandonSessionInMin\": 60, // number optional\n \"fraudDetectFailureBypass\": true, // boolean optional\n \"piiRetentionConfig\": [\n {\n \"status\": \"SUCCESS\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": 300\n }\n },\n {\n \"status\": \"FAILED\",\n \"value\": {\n \"pii_retention_off\": true\n }\n },\n {\n \"status\": \"NOT_PERFORMED\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": 0\n }\n },\n {\n \"status\": \"REVIEW\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": -1\n }\n },\n {\n \"status\": \"ABANDONED\",\n \"value\": {\n \"pii_retention_off\": false,\n \"pii_retention_ttl\": 86400\n }\n }\n ],\n \"checks\": [\n \"document_liveness_front\",\n \"document_liveness_back\",\n \"selfie_liveness\",\n \"face_compare\",\n \"fraud_detection\"\n ],\n \"conditions\": [ // array optional\n {\n \"module\": \"string\" // string - \"firstname check\" / \"lastname check\" / \"dob check\"\n \"criteria\": \"string\" // string - \"eq\", \"neq\" or \"fuzzyMatch\"\n \"minMatchScore\": number // required if fuzzyMatch criteria is passed - value will be in range of 0 - 100\n \"matchCommonAliases\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n \"ignoreMiddleNames\": boolean // optional if firstname check or lastname check module is passed - value will be boolean and false by default\n }\n ],\n \"autoDetectTimeout\": 40, // number optional\n \"postTimeoutCaptureMode\": \"none\", // string optional (default: \"none\") - \"none\", \"manual\", or \"auto\"\n \"autoCaptureCountdownSeconds\": 10, // number optional - seconds to wait for auto-capture\n \"autoCaptureCountdownVisible\": true, // boolean optional - show countdown UX\n \"useV1BlinkIdVerify\": true // boolean optional\n \"maxRetries\": 2, // number optional - (default = 2, min = 0, max = 4)\n \"bypassConfig\": [\n {\n \"criteria\": \"string\", // string\n \"enabled\": \"boolean\" // boolean - true or false\n }\n ]\n }\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateVerificationConfigRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateVerificationConfigResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Verification config not found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"summary": "Get verification config by tag or id",
"description": "Get verification config by tag or id.
\n- Only a **system**, **service** or **service_ext** key can be used to get verification config.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the verification config object or errors if any.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verification Config"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "id_or_tag",
"in": "path",
"description": "Verification config id or tag.",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetVerificationConfigResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Verification config is not found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"summary": "Delete verification config by tag or id",
"description": "Permanently deletes a verification config. It cannot be undone.
\n- Only a **system**, **service** or **service_ext** key can be used to delete verification config.\n- Key must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Returns** |\n|----------------------------------------------|\n\nNo content.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verification Config"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"in": "path",
"name": "communityId",
"description": "ID of community",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "id_or_tag",
"in": "path",
"description": "Verification config id or tag.",
"required": true,
"schema": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/servicekeys": {
"get": {
"summary": "Get service keys",
"description": "This endpoint returns available service keys.\nThe license you are using must be of authLevel 'system'\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns array with service keys\n",
"tags": [
"Service Key"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceKeysResponse"
}
}
}
},
"400": {
"description": "Invalid request"
},
"401": {
"description": "Unauthorized"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/servicekey/{keyId}": {
"delete": {
"summary": "Reset Service Key",
"description": "This endpoint resets service key for given keyId. Deletes current one and recreates a new one.\nThe license you are using must be of authLevel 'system'\n\n| **Parameters** |\n|----------------------------------------------|\n\n### keyId (required)\nThe keyId of service key to reset\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns re-created service key\n",
"tags": [
"Service Key"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"name": "keyId",
"in": "path",
"description": "keyId of service key to reset",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceKeysResponse"
}
}
}
},
"400": {
"description": "Invalid request"
},
"401": {
"description": "Unauthorized"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/sd": {
"get": {
"summary": "Get all service directories.",
"description": "Get all service directories.\n\n| **Returns** |\n|-------------------------------------------|\n\nReturns all service directories.\n",
"tags": [
"Service Directory"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetServiceComponentsResponse"
}
}
}
}
}
}
},
"/publickeys": {
"get": {
"summary": "Get system's public key.",
"description": "Get system's public key.\n\n| **Returns** |\n|-------------------------------------------|\n\nReturns a public key object\n",
"tags": [
"Public Key"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicKeyResponse"
}
}
}
},
"401": {
"description": "Invalid ECDSA signature / ID found."
}
}
}
},
"/person/search": {
"post": {
"summary": "Search person.",
"description": "- any valid license key can be used to create verification config.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### data (required)\nThe ECDSA string of data.\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the ECDSA encrypted data of docId, docType & certifications json and public key.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Verify"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "Request body contains 'data' field with encrypted object below:\n\n```\n{\n \"dvcID\": \"string required\",\n \"verifications\": [\"person_search\"],\n \"document\": {\n \"id\": \"string required\",\n \"type\": \"string required\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"dob\": \"YYYYMMDD\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zipCode\": \"string\",\n \"ssn\": \"string\",\n \"country\": \"string\",\n \"phone\": \"string\",\n \"email\": \"string\",\n \"age\": \"string\"\n }\n}\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/healthz": {
"get": {
"summary": "Get healthz.",
"description": "Get healthz
\n\n\n| **Returns** |\n|-------------------------------------------|\n\nReturns a healthz object\n - ```version = ..```
\n\n - ```git-tag```: When code is compiled from a git-tag, this must carry the tag name. This should match one of the git tags.\n - ```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.\n - ```dob```: Date Of Build. This is epoc-time-in-se\tconds that tell the time when the build was created.\n - \u200bif the code is not built from a git-tag, then the ```version =\ufffc.```\n",
"tags": [
"Healthz"
],
"responses": {
"200": {
"description": "Success\n\n```\n{\n \"status\": \"all services operational\",\n \"publicKey\": \"string\" //same as /publickeys endpoint,\n \"code\": \"200\",\n \"version\": \"\" //as defined above\n}\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthzResponse"
}
}
}
}
}
}
},
"/environment": {
"get": {
"description": "Provide details regarding the environments.\n| **Returns** |\n|-------------------------------------------|\n\nReturns an environment object\n",
"tags": [
"Environment"
],
"security": [
{
"license": []
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/ecdsa_helper/{method}": {
"post": {
"summary": "Encrypt and decrypt the data string by public key and private key.",
"description": "Encrypt and decrypt the data string by public key and private key.\n\n| **Parameters** |\n|----------------------------------------------|\n\n### method (optional)\nThe method parameter is type of enum. Default value is encrypt.
\nThis parameter only accepts following values
\n **encrypt**, **decrypt**\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n\n### dataStr (required)\nThe dataStr key is type of string.\n\n
\n### publicKey (required)\nThe publicKey is type of string.\n\n
\n### privateKey (required)\nThe privateKey is type of string.\n\n| **Returns** |\n|-------------------------------------------|\n\nReturns the encrypted/decrypted string.
\nThis API throw an error if something goes wrong. A common source of error is public or private key is not valid.\n",
"tags": [
"ECDSA Helper"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcdsaEncryptDecryptRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "method",
"schema": {
"type": "string",
"enum": [
"encrypt",
"decrypt"
],
"default": "encrypt"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcdsaEncryptDecryptResponse"
}
}
}
}
}
}
},
"/document_share_session/create": {
"post": {
"summary": "create session.",
"description": "create session.
\n- Only **system**, **service**, **service_ext**, **app** or **app_ext** license can be used to create session.\n- License must be authorized for community.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### data (required)\nThe ECDSA string of data.\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the data of sessionId & url.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Session"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "Request body contains 'data' field with encrypted object below\n```\n{\n \"dvcID\": \"string required\",\n \"sessionRequest\": {\n \"tenantDNS\": \"string required eg: 'idpass.1kosmos.net'\",\n \"communityName\": \"string required eg: 'default'\",\n \"documentType\": \"string required eg 'dl_object | ppt_object | idcard_object'\",\n \"userUID\": \"string optional\",\n \"did\": \"string optional\",\n \"user\": {uid, username, firstname, lastname, dob},\n \"expireSessionInMin\": \"number optional\",\n \"abandonSessionInMin\": \"number optional\",\n \"workflowMetadata\": {\n \"wfInstanceId\": \"string optional\",\n \"workflowId\": \"string optional\",\n // any other key-value pairs allowed\n }\n }\n}\n```\n- did should be optional\n- either userUID should be given OR user object with (any one field uid, username, firstname, lastname, dob) should be given.\n- workflowMetadata is optional, can include wfInstanceId, workflowId, and any other properties related to workflow.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentShareSessionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentShareSessionResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/document_share_session/result": {
"post": {
"summary": "check session status.",
"description": "check session status.
\n- any valid license key can be used to check session status.\n\n\n| **Headers** |\n|----------------------------------------------|\n\n### licensekey (required)\nLicense key encrypted with ECDSA\n\n### requestid (required)\nJSON 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\n\n### publickey (required)\nPublic key\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n### data (required)\nThe ECDSA string of data.\n\n\n| **Returns** |\n|----------------------------------------------|\n\nReturns the ECDSA encrypted data of liveid, dl and public key.
\nThis API throw an error if something goes wrong.\n",
"tags": [
"Session"
],
"security": [
{
"keyId": []
},
{
"keySecret": []
},
{
"license": []
}
],
"parameters": [
{
"name": "licensekey",
"in": "header",
"description": "License key encrypted with ECDSA / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "requestid",
"in": "header",
"description": "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 / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
},
{
"name": "publickey",
"in": "header",
"description": "Public Key / Try Authorize 🔒",
"required": true,
"schema": {
"type": "string",
"example": "Do not enter anything, use 'Authorize' fields"
}
}
],
"requestBody": {
"description": "Request body contains 'data' field with encrypted object below\n```\n{\n \"dvcID\": \"string required\",\n \"sessionId\": \"string required\",\n \"includeMetadata\": \"boolean optional - default value is false\",\n \"alwaysReturnAssets\": \"boolean optional - default value is false\",\n \"granularStatus\": \"boolean optional - default value is false; when true, returns the actual session status (PENDING vs INPROGRESS) without legacy masking\"\n}\n```\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checkSessionStatusRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checkSessionStatusResponse"
}
}
}
},
"400": {
"description": "Bad Request, Validation errors."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/base64fromimage": {
"post": {
"summary": "Get base64 string from Image.",
"description": "Get base64 string from Image.\n\n\n| **Request Body** |\n|----------------------------------------------|\n\n\n### image (required)\nThe image key is type of string.\n\n| **Returns** |\n|-------------------------------------------|\n\nReturns the base64 string.
\nThis API throw an error if something goes wrong. A common source of error is public or private key is not valid.\n",
"tags": [
"Base64 Helper"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Base64FromImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Base64FromImageResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"PublicKeyResponse": {
"type": "object",
"properties": {
"publicKey": {
"type": "string"
}
},
"example": {
"publicKey": ""
}
},
"HealthzResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"code": {
"type": "string"
},
"version": {
"type": "string"
}
},
"example": {
"status": "all services operational",
"publicKey": "//same as /publickeys endpoint",
"code": "200",
"version": "xxxx.xxxx.xxxx"
}
},
"EcdsaEncryptDecryptRequest": {
"type": "object",
"properties": {
"dataStr": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"privateKey": {
"type": "string"
}
},
"example": {
"dataStr": "Hey, This is example data string.",
"publicKey": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx=",
"privateKey": "xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx="
}
},
"EcdsaEncryptDecryptResponse": {
"type": "object",
"properties": {
"publicKey": {
"type": "string"
},
"data": {
"type": "array"
}
},
"example": {
"data": "xxxxxxxxxxxxxxxxxxxx",
"publicKey": "xxxxxxxxxxxxxxxxxxxx"
}
},
"Base64FromImageRequest": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
},
"Base64FromImageResponse": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxx"
},
"ServiceKeysResponse": {
"type": "array",
"description": "Service keys array",
"items": {
"type": "object",
"required": [
"tag",
"keyId",
"keySecret",
"type"
],
"properties": {
"tag": {
"type": "string",
"description": "service ecdsa"
},
"keyId": {
"type": "string",
"description": "ecdsa publicKey"
},
"keySecret": {
"type": "string",
"description": "ecdsa private key"
},
"type": {
"type": "string",
"description": "default = ecdsa | hawk"
}
},
"example": {
"tag": "xxxxx",
"keyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"keySecret": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"type": "xxxxx"
}
}
},
"CreateVerifierRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"type": {
"type": "string"
},
"connectorUrl": {
"type": "string"
},
"config": {
"type": "object"
}
},
"example": {
"name": "xxxxx",
"tag": "xxxxxx",
"type": "xxxxxxxx",
"connectorUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"config": {}
}
},
"CreateVerifierResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"type": {
"type": "string"
},
"connectorUrl": {
"type": "string"
},
"config": {
"type": "object"
}
},
"example": {
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"name": "xxxxx",
"tag": "xxxxxx",
"connectorUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"type": "xxxxxxxx",
"config": {}
}
},
"UpdateVerifierRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"connectorUrl": {
"type": "string"
},
"config": {
"type": "object"
}
},
"example": {
"name": "xxxxx",
"connectorUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"config": {}
}
},
"UpdateVerifierResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"type": {
"type": "string"
},
"connectorUrl": {
"type": "string"
},
"config": {
"type": "object"
}
},
"example": {
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"name": "xxxxx",
"tag": "xxxxxx",
"type": "xxxxxxxx",
"connectorUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"config": {}
}
},
"GetVerifiersResponse": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"type": {
"type": "string"
},
"connectorUrl": {
"type": "string"
},
"config": {
"type": "object"
}
}
}
}
},
"example": {
"list": [
{
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"name": "xxxxx",
"tag": "xxxxxx",
"type": "xxxxxxxx",
"connectorUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"config": {}
}
]
}
},
"GetVerifierResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"type": {
"type": "string"
},
"connectorUrl": {
"type": "string"
},
"config": {
"type": "object"
}
},
"example": {
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"name": "xxxxx",
"tag": "xxxxxx",
"type": "xxxxxxxx",
"connectorUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"config": {}
}
},
"CreateVerificationConfigRequest": {
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
},
"face_liveness": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"min_quality": {
"type": "number"
},
"selfieCaptureMode": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"other_pipelines": {
"type": "object",
"properties": {
"authentication": {
"type": "string"
},
"registration": {
"type": "string"
},
"doc_enrollment": {
"type": "string"
}
}
}
}
}
},
"face_compare": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"other_confidence": {
"type": "object",
"properties": {
"authentication": {
"type": "number"
},
"doc_enrollment": {
"type": "number"
}
}
}
}
}
},
"face_rekognition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"dl_verify": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"include_states": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_states": {
"type": "array",
"items": {
"type": "string"
}
},
"dob_match_required": {
"type": "boolean"
},
"first_name_exact_match_required": {
"type": "boolean"
},
"first_name_fuzzy_match_required": {
"type": "boolean"
},
"last_name_exact_match_required": {
"type": "boolean"
},
"last_name_fuzzy_match_required": {
"type": "boolean"
},
"middle_name_exact_match_required": {
"type": "boolean"
},
"middle_name_fuzzy_match_required": {
"type": "boolean"
},
"doc_category_match_required": {
"type": "boolean"
},
"doi_match_required": {
"type": "boolean"
},
"doe_match_required": {
"type": "boolean"
},
"person_sex_match_required": {
"type": "boolean"
},
"person_height_match_required": {
"type": "boolean"
},
"person_eye_color_match_required": {
"type": "boolean"
},
"address_match_required": {
"type": "boolean"
},
"city_match_required": {
"type": "boolean"
},
"state_match_required": {
"type": "boolean"
},
"zip_match_required": {
"type": "boolean"
},
"dl_number_match_required": {
"type": "boolean"
},
"weights": {
"type": "object",
"properties": {
"dob_match_required": {
"type": "number"
},
"first_name_exact_match_required": {
"type": "number"
},
"first_name_fuzzy_match_required": {
"type": "number"
},
"last_name_exact_match_required": {
"type": "number"
},
"last_name_fuzzy_match_required": {
"type": "number"
},
"middle_name_exact_match_required": {
"type": "number"
},
"middle_name_fuzzy_match_required": {
"type": "number"
},
"doc_category_match_required": {
"type": "number"
},
"doi_match_required": {
"type": "number"
},
"doe_match_required": {
"type": "number"
},
"person_sex_match_required": {
"type": "number"
},
"person_height_match_required": {
"type": "number"
},
"person_eye_color_match_required": {
"type": "number"
},
"address_match_required": {
"type": "number"
},
"city_match_required": {
"type": "number"
},
"state_match_required": {
"type": "number"
},
"zip_match_required": {
"type": "number"
},
"dl_number_match_required": {
"type": "number"
}
}
}
}
}
},
"ssn_verify": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture object configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDetectTimeout": {
"type": "number"
},
"postTimeoutCaptureMode": {
"type": "string"
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"matchCommonAliases": {
"type": "boolean"
},
"ignoreMiddleNames": {
"type": "boolean"
}
}
}
},
"bypassConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"criteria": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"tenantId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tag": "xxxxxx",
"name": "xxxxx",
"face_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.7,
"min_quality": 0.5,
"selfieCaptureMode": "auto",
"pipeline": "aaa",
"other_pipelines": {
"authentication": "xxx",
"registration": "yyy",
"doc_enrollment": "zzz"
}
}
],
"face_compare": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7,
"other_confidence": {
"authentication": 0.7,
"doc_enrollment": 0.7
}
}
],
"face_rekognition": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7
}
],
"dl_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"include_states": [
"xx",
"xx"
],
"exclude_states": [
"xx",
"xx"
],
"dob_match_required": false,
"first_name_exact_match_required": true,
"first_name_fuzzy_match_required": true,
"last_name_exact_match_required": true,
"last_name_fuzzy_match_required": true,
"middle_name_exact_match_required": true,
"middle_name_fuzzy_match_required": true,
"doc_category_match_required": true,
"doi_match_required": true,
"doe_match_required": true,
"person_sex_match_required": true,
"person_height_match_required": true,
"person_eye_color_match_required": true,
"address_match_required": true,
"city_match_required": true,
"state_match_required": true,
"zip_match_required": true,
"dl_number_match_required": true,
"weights": {
"dob_match_required": 0,
"first_name_exact_match_required": 0,
"first_name_fuzzy_match_required": 0,
"last_name_exact_match_required": 0,
"last_name_fuzzy_match_required": 0,
"middle_name_exact_match_required": 0,
"middle_name_fuzzy_match_required": 0,
"doc_category_match_required": 0,
"doi_match_required": 0,
"doe_match_required": 0,
"person_sex_match_required": 0,
"person_height_match_required": 0,
"person_eye_color_match_required": 0,
"address_match_required": 0,
"city_match_required": 0,
"state_match_required": 0,
"zip_match_required": 0,
"dl_number_match_required": 0
}
}
],
"ssn_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_search": [
{
"verifier": "xxxx",
"skip": false,
"debug": true
}
],
"dl_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "11",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"ppt_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"document_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.5
}
],
"idcard_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"id_capture": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"fraudDetectFailureBypass": true,
"piiRetentionConfig": [
{
"status": "SUCCESS",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
},
{
"status": "FAILED",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 300
}
},
{
"status": "NOT_PERFORMED",
"value": {
"pii_retention_off": true
}
},
{
"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"
],
"autoDetectTimeout": 40,
"postTimeoutCaptureMode": "none",
"autoCaptureCountdownSeconds": 10,
"autoCaptureCountdownVisible": true,
"bypassConfigJS": "return true;",
"enableManualReview": false,
"useV1BlinkIdVerify": false,
"maxRetries": 2,
"bypassConfig": [
{
"criteria": "result.barcode.addressDetailedInfo.jurisdiction === \"NU\"",
"enabled": true
}
],
"conditions": [
{
"module": "firstname check",
"criteria": "fuzzyMatch",
"minMatchScore": 50,
"matchCommonAliases": false,
"ignoreMiddleNames": false
},
{
"module": "lastname check",
"criteria": "eq",
"ignoreMiddleNames": false
},
{
"module": "dob check",
"criteria": "eq"
}
]
}
]
}
},
"CreateVerificationConfigResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
},
"face_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"min_quality": {
"type": "number"
},
"selfieCaptureMode": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"other_pipelines": {
"type": "object",
"properties": {
"authentication": {
"type": "string"
},
"registration": {
"type": "string"
},
"doc_enrollment": {
"type": "string"
}
}
}
}
}
},
"face_compare": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"other_confidence": {
"type": "object",
"properties": {
"authentication": {
"type": "number"
},
"doc_enrollment": {
"type": "number"
}
}
}
}
}
},
"face_rekognition": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"dl_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"include_states": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_states": {
"type": "array",
"items": {
"type": "string"
}
},
"dob_match_required": {
"type": "boolean"
},
"first_name_exact_match_required": {
"type": "boolean"
},
"first_name_fuzzy_match_required": {
"type": "boolean"
},
"last_name_exact_match_required": {
"type": "boolean"
},
"last_name_fuzzy_match_required": {
"type": "boolean"
},
"middle_name_exact_match_required": {
"type": "boolean"
},
"middle_name_fuzzy_match_required": {
"type": "boolean"
},
"doc_category_match_required": {
"type": "boolean"
},
"doi_match_required": {
"type": "boolean"
},
"doe_match_required": {
"type": "boolean"
},
"person_sex_match_required": {
"type": "boolean"
},
"person_height_match_required": {
"type": "boolean"
},
"person_eye_color_match_required": {
"type": "boolean"
},
"address_match_required": {
"type": "boolean"
},
"city_match_required": {
"type": "boolean"
},
"state_match_required": {
"type": "boolean"
},
"zip_match_required": {
"type": "boolean"
},
"dl_number_match_required": {
"type": "boolean"
},
"weights": {
"type": "object",
"properties": {
"dob_match_required": {
"type": "number"
},
"first_name_exact_match_required": {
"type": "number"
},
"first_name_fuzzy_match_required": {
"type": "number"
},
"last_name_exact_match_required": {
"type": "number"
},
"last_name_fuzzy_match_required": {
"type": "number"
},
"middle_name_exact_match_required": {
"type": "number"
},
"middle_name_fuzzy_match_required": {
"type": "number"
},
"doc_category_match_required": {
"type": "number"
},
"doi_match_required": {
"type": "number"
},
"doe_match_required": {
"type": "number"
},
"person_sex_match_required": {
"type": "number"
},
"person_height_match_required": {
"type": "number"
},
"person_eye_color_match_required": {
"type": "number"
},
"address_match_required": {
"type": "number"
},
"city_match_required": {
"type": "number"
},
"state_match_required": {
"type": "number"
},
"zip_match_required": {
"type": "number"
},
"dl_number_match_required": {
"type": "number"
}
}
}
}
}
},
"ssn_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDetectTimeout": {
"type": "number"
},
"postTimeoutCaptureMode": {
"type": "string"
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"matchCommonAliases": {
"type": "boolean"
},
"ignoreMiddleNames": {
"type": "boolean"
}
}
}
},
"bypassConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"criteria": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tenantId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tag": "xxxxxx",
"name": "xxxxxx",
"face_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.7,
"min_quality": 0.5,
"selfieCaptureMode": "auto",
"pipeline": "aaa",
"other_pipelines": {
"authentication": "xxx",
"registration": "yyy",
"doc_enrollment": "zzz"
}
}
],
"face_compare": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7,
"other_confidence": {
"authentication": 0.7,
"doc_enrollment": 0.7
}
}
],
"face_rekognition": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7
}
],
"dl_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"include_states": [
"xx",
"xx"
],
"exclude_states": [
"xx",
"xx"
],
"dob_match_required": false,
"first_name_exact_match_required": true,
"first_name_fuzzy_match_required": true,
"last_name_exact_match_required": true,
"last_name_fuzzy_match_required": true,
"middle_name_exact_match_required": true,
"middle_name_fuzzy_match_required": true,
"doc_category_match_required": true,
"doi_match_required": true,
"doe_match_required": true,
"person_sex_match_required": true,
"person_height_match_required": true,
"person_eye_color_match_required": true,
"address_match_required": true,
"city_match_required": true,
"state_match_required": true,
"zip_match_required": true,
"dl_number_match_required": true,
"weights": {
"dob_match_required": 0,
"first_name_exact_match_required": 0,
"first_name_fuzzy_match_required": 0,
"last_name_exact_match_required": 0,
"last_name_fuzzy_match_required": 0,
"middle_name_exact_match_required": 0,
"middle_name_fuzzy_match_required": 0,
"doc_category_match_required": 0,
"doi_match_required": 0,
"doe_match_required": 0,
"person_sex_match_required": 0,
"person_height_match_required": 0,
"person_eye_color_match_required": 0,
"address_match_required": 0,
"city_match_required": 0,
"state_match_required": 0,
"zip_match_required": 0,
"dl_number_match_required": 0
}
}
],
"ssn_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_search": [
{
"verifier": "xxxx",
"skip": false,
"debug": true
}
],
"dl_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "11",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"ppt_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"document_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.5
}
],
"idcard_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"id_capture": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"fraudDetectFailureBypass": true,
"piiRetentionConfig": [
{
"status": "SUCCESS",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
},
{
"status": "FAILED",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 300
}
},
{
"status": "NOT_PERFORMED",
"value": {
"pii_retention_off": true
}
},
{
"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"
],
"autoDetectTimeout": 40,
"postTimeoutCaptureMode": "none",
"autoCaptureCountdownSeconds": 10,
"autoCaptureCountdownVisible": true,
"bypassConfigJS": "return true;",
"enableManualReview": false,
"useV1BlinkIdVerify": false,
"maxRetries": 2,
"bypassConfig": [
{
"criteria": "result.barcode.addressDetailedInfo.jurisdiction === \"NU\"",
"enabled": true
}
],
"conditions": [
{
"module": "firstname check",
"criteria": "fuzzyMatch",
"minMatchScore": 50,
"matchCommonAliases": false,
"ignoreMiddleNames": false
},
{
"module": "lastname check",
"criteria": "eq",
"ignoreMiddleNames": false
},
{
"module": "dob check",
"criteria": "eq"
}
]
}
]
}
},
"UpdateVerificationConfigRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"face_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"min_quality": {
"type": "number"
},
"selfieCaptureMode": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"other_pipelines": {
"type": "object",
"properties": {
"authentication": {
"type": "string"
},
"registration": {
"type": "string"
},
"doc_enrollment": {
"type": "string"
}
}
}
}
}
},
"face_compare": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"other_confidence": {
"type": "object",
"properties": {
"authentication": {
"type": "number"
},
"doc_enrollment": {
"type": "number"
}
}
}
}
}
},
"face_rekognition": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"dl_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"include_states": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_states": {
"type": "array",
"items": {
"type": "string"
}
},
"dob_match_required": {
"type": "boolean"
},
"first_name_exact_match_required": {
"type": "boolean"
},
"first_name_fuzzy_match_required": {
"type": "boolean"
},
"last_name_exact_match_required": {
"type": "boolean"
},
"last_name_fuzzy_match_required": {
"type": "boolean"
},
"middle_name_exact_match_required": {
"type": "boolean"
},
"middle_name_fuzzy_match_required": {
"type": "boolean"
},
"doc_category_match_required": {
"type": "boolean"
},
"doi_match_required": {
"type": "boolean"
},
"doe_match_required": {
"type": "boolean"
},
"person_sex_match_required": {
"type": "boolean"
},
"person_height_match_required": {
"type": "boolean"
},
"person_eye_color_match_required": {
"type": "boolean"
},
"address_match_required": {
"type": "boolean"
},
"city_match_required": {
"type": "boolean"
},
"state_match_required": {
"type": "boolean"
},
"zip_match_required": {
"type": "boolean"
},
"dl_number_match_required": {
"type": "boolean"
},
"weights": {
"type": "object",
"properties": {
"dob_match_required": {
"type": "number"
},
"first_name_exact_match_required": {
"type": "number"
},
"first_name_fuzzy_match_required": {
"type": "number"
},
"last_name_exact_match_required": {
"type": "number"
},
"last_name_fuzzy_match_required": {
"type": "number"
},
"middle_name_exact_match_required": {
"type": "number"
},
"middle_name_fuzzy_match_required": {
"type": "number"
},
"doc_category_match_required": {
"type": "number"
},
"doi_match_required": {
"type": "number"
},
"doe_match_required": {
"type": "number"
},
"person_sex_match_required": {
"type": "number"
},
"person_height_match_required": {
"type": "number"
},
"person_eye_color_match_required": {
"type": "number"
},
"address_match_required": {
"type": "number"
},
"city_match_required": {
"type": "number"
},
"state_match_required": {
"type": "number"
},
"zip_match_required": {
"type": "number"
},
"dl_number_match_required": {
"type": "number"
}
}
}
}
}
},
"ssn_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDetectTimeout": {
"type": "number"
},
"postTimeoutCaptureMode": {
"type": "string"
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"matchCommonAliases": {
"type": "boolean"
},
"ignoreMiddleNames": {
"type": "boolean"
}
}
}
},
"bypassConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"criteria": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"name": "xxxxxx",
"face_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.7,
"min_quality": 0.5,
"selfieCaptureMode": "auto",
"pipeline": "aaa",
"other_pipelines": {
"authentication": "xxx",
"registration": "yyy",
"doc_enrollment": "zzz"
}
}
],
"face_compare": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7,
"other_confidence": {
"authentication": 0.7,
"doc_enrollment": 0.7
}
}
],
"face_rekognition": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7
}
],
"dl_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"include_states": [
"xx",
"xx"
],
"exclude_states": [
"xx",
"xx"
],
"dob_match_required": false,
"first_name_exact_match_required": true,
"first_name_fuzzy_match_required": true,
"last_name_exact_match_required": true,
"last_name_fuzzy_match_required": true,
"middle_name_exact_match_required": true,
"middle_name_fuzzy_match_required": true,
"doc_category_match_required": true,
"doi_match_required": true,
"doe_match_required": true,
"person_sex_match_required": true,
"person_height_match_required": true,
"person_eye_color_match_required": true,
"address_match_required": true,
"city_match_required": true,
"state_match_required": true,
"zip_match_required": true,
"dl_number_match_required": true,
"weights": {
"dob_match_required": 0,
"first_name_exact_match_required": 0,
"first_name_fuzzy_match_required": 0,
"last_name_exact_match_required": 0,
"last_name_fuzzy_match_required": 0,
"middle_name_exact_match_required": 0,
"middle_name_fuzzy_match_required": 0,
"doc_category_match_required": 0,
"doi_match_required": 0,
"doe_match_required": 0,
"person_sex_match_required": 0,
"person_height_match_required": 0,
"person_eye_color_match_required": 0,
"address_match_required": 0,
"city_match_required": 0,
"state_match_required": 0,
"zip_match_required": 0,
"dl_number_match_required": 0
}
}
],
"ssn_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_search": [
{
"verifier": "xxxx",
"skip": false,
"debug": true
}
],
"dl_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "11",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"ppt_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"document_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.5
}
],
"idcard_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"id_capture": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"fraudDetectFailureBypass": true,
"piiRetentionConfig": [
{
"status": "SUCCESS",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
},
{
"status": "FAILED",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 300
}
},
{
"status": "NOT_PERFORMED",
"value": {
"pii_retention_off": true
}
},
{
"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"
],
"autoDetectTimeout": 40,
"postTimeoutCaptureMode": "none",
"autoCaptureCountdownSeconds": 10,
"autoCaptureCountdownVisible": true,
"bypassConfigJS": "return true;",
"enableManualReview": false,
"useV1BlinkIdVerify": false,
"maxRetries": 2,
"bypassConfig": [
{
"criteria": "result.barcode.addressDetailedInfo.jurisdiction === \"NU\"",
"enabled": true
}
],
"conditions": [
{
"module": "firstname check",
"criteria": "fuzzyMatch",
"minMatchScore": 50,
"matchCommonAliases": false,
"ignoreMiddleNames": false
},
{
"module": "lastname check",
"criteria": "eq",
"ignoreMiddleNames": false
},
{
"module": "dob check",
"criteria": "eq"
}
]
}
]
}
},
"UpdateVerificationConfigResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
},
"face_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"min_quality": {
"type": "number"
},
"selfieCaptureMode": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"other_pipelines": {
"type": "object",
"properties": {
"authentication": {
"type": "string"
},
"registration": {
"type": "string"
},
"doc_enrollment": {
"type": "string"
}
}
}
}
}
},
"face_compare": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"other_confidence": {
"type": "object",
"properties": {
"authentication": {
"type": "number"
},
"doc_enrollment": {
"type": "number"
}
}
}
}
}
},
"face_rekognition": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"dl_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"include_states": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_states": {
"type": "array",
"items": {
"type": "string"
}
},
"dob_match_required": {
"type": "boolean"
},
"first_name_exact_match_required": {
"type": "boolean"
},
"first_name_fuzzy_match_required": {
"type": "boolean"
},
"last_name_exact_match_required": {
"type": "boolean"
},
"last_name_fuzzy_match_required": {
"type": "boolean"
},
"middle_name_exact_match_required": {
"type": "boolean"
},
"middle_name_fuzzy_match_required": {
"type": "boolean"
},
"doc_category_match_required": {
"type": "boolean"
},
"doi_match_required": {
"type": "boolean"
},
"doe_match_required": {
"type": "boolean"
},
"person_sex_match_required": {
"type": "boolean"
},
"person_height_match_required": {
"type": "boolean"
},
"person_eye_color_match_required": {
"type": "boolean"
},
"address_match_required": {
"type": "boolean"
},
"city_match_required": {
"type": "boolean"
},
"state_match_required": {
"type": "boolean"
},
"zip_match_required": {
"type": "boolean"
},
"dl_number_match_required": {
"type": "boolean"
},
"weights": {
"type": "object",
"properties": {
"dob_match_required": {
"type": "number"
},
"first_name_exact_match_required": {
"type": "number"
},
"first_name_fuzzy_match_required": {
"type": "number"
},
"last_name_exact_match_required": {
"type": "number"
},
"last_name_fuzzy_match_required": {
"type": "number"
},
"middle_name_exact_match_required": {
"type": "number"
},
"middle_name_fuzzy_match_required": {
"type": "number"
},
"doc_category_match_required": {
"type": "number"
},
"doi_match_required": {
"type": "number"
},
"doe_match_required": {
"type": "number"
},
"person_sex_match_required": {
"type": "number"
},
"person_height_match_required": {
"type": "number"
},
"person_eye_color_match_required": {
"type": "number"
},
"address_match_required": {
"type": "number"
},
"city_match_required": {
"type": "number"
},
"state_match_required": {
"type": "number"
},
"zip_match_required": {
"type": "number"
},
"dl_number_match_required": {
"type": "number"
}
}
}
}
}
},
"ssn_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDetectTimeout": {
"type": "number"
},
"postTimeoutCaptureMode": {
"type": "string"
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"matchCommonAliases": {
"type": "boolean"
},
"ignoreMiddleNames": {
"type": "boolean"
}
}
}
},
"bypassConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"criteria": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tenantId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tag": "xxxxxx",
"name": "xxxxxx",
"face_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.7,
"min_quality": 0.5,
"selfieCaptureMode": "auto",
"pipeline": "aaa",
"other_pipelines": {
"authentication": "xxx",
"registration": "yyy",
"doc_enrollment": "zzz"
}
}
],
"face_compare": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7,
"other_confidence": {
"authentication": 0.7,
"doc_enrollment": 0.7
}
}
],
"face_rekognition": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7
}
],
"dl_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"include_states": [
"xx",
"xx"
],
"exclude_states": [
"xx",
"xx"
],
"dob_match_required": false,
"first_name_exact_match_required": true,
"first_name_fuzzy_match_required": true,
"last_name_exact_match_required": true,
"last_name_fuzzy_match_required": true,
"middle_name_exact_match_required": true,
"middle_name_fuzzy_match_required": true,
"doc_category_match_required": true,
"doi_match_required": true,
"doe_match_required": true,
"person_sex_match_required": true,
"person_height_match_required": true,
"person_eye_color_match_required": true,
"address_match_required": true,
"city_match_required": true,
"state_match_required": true,
"zip_match_required": true,
"dl_number_match_required": true,
"weights": {
"dob_match_required": 0,
"first_name_exact_match_required": 0,
"first_name_fuzzy_match_required": 0,
"last_name_exact_match_required": 0,
"last_name_fuzzy_match_required": 0,
"middle_name_exact_match_required": 0,
"middle_name_fuzzy_match_required": 0,
"doc_category_match_required": 0,
"doi_match_required": 0,
"doe_match_required": 0,
"person_sex_match_required": 0,
"person_height_match_required": 0,
"person_eye_color_match_required": 0,
"address_match_required": 0,
"city_match_required": 0,
"state_match_required": 0,
"zip_match_required": 0,
"dl_number_match_required": 0
}
}
],
"ssn_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_search": [
{
"verifier": "xxxx",
"skip": false,
"debug": true
}
],
"dl_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "11",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"ppt_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"document_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.5
}
],
"idcard_authenticate": [
{
"verifier": "xxxx",
"skip": true,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"id_capture": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"fraudDetectFailureBypass": true,
"piiRetentionConfig": [
{
"status": "SUCCESS",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
},
{
"status": "FAILED",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 300
}
},
{
"status": "NOT_PERFORMED",
"value": {
"pii_retention_off": true
}
},
{
"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"
],
"autoDetectTimeout": 40,
"postTimeoutCaptureMode": "none",
"autoCaptureCountdownSeconds": 10,
"autoCaptureCountdownVisible": true,
"bypassConfigJS": "return true;",
"enableManualReview": false,
"useV1BlinkIdVerify": false,
"maxRetries": 2,
"bypassConfig": [
{
"criteria": "result.barcode.addressDetailedInfo.jurisdiction === \"NU\"",
"enabled": true
}
],
"conditions": [
{
"module": "firstname check",
"criteria": "fuzzyMatch",
"minMatchScore": 50,
"matchCommonAliases": false,
"ignoreMiddleNames": false
},
{
"module": "lastname check",
"criteria": "eq",
"ignoreMiddleNames": false
},
{
"module": "dob check",
"criteria": "eq"
}
]
}
]
}
},
"GetVerificationConfigsResponse": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"face_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"min_quality": {
"type": "number"
},
"selfieCaptureMode": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"other_pipelines": {
"type": "object",
"properties": {
"authentication": {
"type": "string"
},
"registration": {
"type": "string"
},
"doc_enrollment": {
"type": "string"
}
}
}
}
}
},
"face_compare": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"other_confidence": {
"type": "object",
"properties": {
"authentication": {
"type": "number"
},
"doc_enrollment": {
"type": "number"
}
}
}
}
}
},
"face_rekognition": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"dl_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"include_states": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_states": {
"type": "array",
"items": {
"type": "string"
}
},
"dob_match_required": {
"type": "boolean"
},
"first_name_exact_match_required": {
"type": "boolean"
},
"first_name_fuzzy_match_required": {
"type": "boolean"
},
"last_name_exact_match_required": {
"type": "boolean"
},
"last_name_fuzzy_match_required": {
"type": "boolean"
},
"middle_name_exact_match_required": {
"type": "boolean"
},
"middle_name_fuzzy_match_required": {
"type": "boolean"
},
"doc_category_match_required": {
"type": "boolean"
},
"doi_match_required": {
"type": "boolean"
},
"doe_match_required": {
"type": "boolean"
},
"person_sex_match_required": {
"type": "boolean"
},
"person_height_match_required": {
"type": "boolean"
},
"person_eye_color_match_required": {
"type": "boolean"
},
"address_match_required": {
"type": "boolean"
},
"city_match_required": {
"type": "boolean"
},
"state_match_required": {
"type": "boolean"
},
"zip_match_required": {
"type": "boolean"
},
"dl_number_match_required": {
"type": "boolean"
},
"weights": {
"type": "object",
"properties": {
"dob_match_required": {
"type": "number"
},
"first_name_exact_match_required": {
"type": "number"
},
"first_name_fuzzy_match_required": {
"type": "number"
},
"last_name_exact_match_required": {
"type": "number"
},
"last_name_fuzzy_match_required": {
"type": "number"
},
"middle_name_exact_match_required": {
"type": "number"
},
"middle_name_fuzzy_match_required": {
"type": "number"
},
"doc_category_match_required": {
"type": "number"
},
"doi_match_required": {
"type": "number"
},
"doe_match_required": {
"type": "number"
},
"person_sex_match_required": {
"type": "number"
},
"person_height_match_required": {
"type": "number"
},
"person_eye_color_match_required": {
"type": "number"
},
"address_match_required": {
"type": "number"
},
"city_match_required": {
"type": "number"
},
"state_match_required": {
"type": "number"
},
"zip_match_required": {
"type": "number"
},
"dl_number_match_required": {
"type": "number"
}
}
}
}
}
},
"ssn_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDetectTimeout": {
"type": "number"
},
"postTimeoutCaptureMode": {
"type": "string"
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"matchCommonAliases": {
"type": "boolean"
},
"ignoreMiddleNames": {
"type": "boolean"
}
}
}
},
"bypassConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"criteria": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"example": {
"list": [
{
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tenantId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tag": "xxxxxx",
"name": "xxxxxx",
"face_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.7,
"min_quality": 0.5,
"selfieCaptureMode": "auto",
"pipeline": "aaa",
"other_pipelines": {
"authentication": "xxx",
"registration": "yyy",
"doc_enrollment": "zzz"
}
}
],
"face_compare": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7,
"other_confidence": {
"authentication": 0.7,
"doc_enrollment": 0.7
}
}
],
"face_rekognition": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7
}
],
"dl_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"include_states": [
"xx",
"xx"
],
"exclude_states": [
"xx",
"xx"
],
"dob_match_required": false,
"first_name_exact_match_required": true,
"first_name_fuzzy_match_required": true,
"last_name_exact_match_required": true,
"last_name_fuzzy_match_required": true,
"middle_name_exact_match_required": true,
"middle_name_fuzzy_match_required": true,
"doc_category_match_required": true,
"doi_match_required": true,
"doe_match_required": true,
"person_sex_match_required": true,
"person_height_match_required": true,
"person_eye_color_match_required": true,
"address_match_required": true,
"city_match_required": true,
"state_match_required": true,
"zip_match_required": true,
"dl_number_match_required": true,
"weights": {
"dob_match_required": 0,
"first_name_exact_match_required": 0,
"first_name_fuzzy_match_required": 0,
"last_name_exact_match_required": 0,
"last_name_fuzzy_match_required": 0,
"middle_name_exact_match_required": 0,
"middle_name_fuzzy_match_required": 0,
"doc_category_match_required": 0,
"doi_match_required": 0,
"doe_match_required": 0,
"person_sex_match_required": 0,
"person_height_match_required": 0,
"person_eye_color_match_required": 0,
"address_match_required": 0,
"city_match_required": 0,
"state_match_required": 0,
"zip_match_required": 0,
"dl_number_match_required": 0
}
}
],
"ssn_verify": [
{
"verifier": "xxxx",
"skip": true,
"debug": true,
"returnRawData": false,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_search": [
{
"verifier": "xxxx",
"skip": false,
"debug": true
}
],
"dl_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "11",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"ppt_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"document_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.5
}
],
"idcard_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"id_capture": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"fraudDetectFailureBypass": true,
"piiRetentionConfig": [
{
"status": "SUCCESS",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
},
{
"status": "FAILED",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 300
}
},
{
"status": "NOT_PERFORMED",
"value": {
"pii_retention_off": true
}
},
{
"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"
],
"autoDetectTimeout": 40,
"postTimeoutCaptureMode": "none",
"autoCaptureCountdownSeconds": 10,
"autoCaptureCountdownVisible": true,
"bypassConfigJS": "return true;",
"enableManualReview": false,
"useV1BlinkIdVerify": false,
"maxRetries": 2,
"bypassConfig": [
{
"criteria": "result.barcode.addressDetailedInfo.jurisdiction === \"NU\"",
"enabled": true
}
],
"conditions": [
{
"module": "firstname check",
"criteria": "fuzzyMatch",
"minMatchScore": 50,
"matchCommonAliases": false,
"ignoreMiddleNames": false
},
{
"module": "lastname check",
"criteria": "eq",
"ignoreMiddleNames": false
},
{
"module": "dob check",
"criteria": "eq"
}
]
}
]
}
]
}
},
"GetVerificationConfigResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
},
"face_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"min_quality": {
"type": "number"
},
"selfieCaptureMode": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"other_pipelines": {
"type": "object",
"properties": {
"authentication": {
"type": "string"
},
"registration": {
"type": "string"
},
"doc_enrollment": {
"type": "string"
}
}
}
}
}
},
"face_compare": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"other_confidence": {
"type": "object",
"properties": {
"authentication": {
"type": "number"
},
"doc_enrollment": {
"type": "number"
}
}
}
}
}
},
"face_rekognition": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"dl_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"include_states": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_states": {
"type": "array",
"items": {
"type": "string"
}
},
"dob_match_required": {
"type": "boolean"
},
"first_name_exact_match_required": {
"type": "boolean"
},
"first_name_fuzzy_match_required": {
"type": "boolean"
},
"last_name_exact_match_required": {
"type": "boolean"
},
"last_name_fuzzy_match_required": {
"type": "boolean"
},
"middle_name_exact_match_required": {
"type": "boolean"
},
"middle_name_fuzzy_match_required": {
"type": "boolean"
},
"doc_category_match_required": {
"type": "boolean"
},
"doi_match_required": {
"type": "boolean"
},
"doe_match_required": {
"type": "boolean"
},
"person_sex_match_required": {
"type": "boolean"
},
"person_height_match_required": {
"type": "boolean"
},
"person_eye_color_match_required": {
"type": "boolean"
},
"address_match_required": {
"type": "boolean"
},
"city_match_required": {
"type": "boolean"
},
"state_match_required": {
"type": "boolean"
},
"zip_match_required": {
"type": "boolean"
},
"dl_number_match_required": {
"type": "boolean"
},
"weights": {
"type": "object",
"properties": {
"dob_match_required": {
"type": "number"
},
"first_name_exact_match_required": {
"type": "number"
},
"first_name_fuzzy_match_required": {
"type": "number"
},
"last_name_exact_match_required": {
"type": "number"
},
"last_name_fuzzy_match_required": {
"type": "number"
},
"middle_name_exact_match_required": {
"type": "number"
},
"middle_name_fuzzy_match_required": {
"type": "number"
},
"doc_category_match_required": {
"type": "number"
},
"doi_match_required": {
"type": "number"
},
"doe_match_required": {
"type": "number"
},
"person_sex_match_required": {
"type": "number"
},
"person_height_match_required": {
"type": "number"
},
"person_eye_color_match_required": {
"type": "number"
},
"address_match_required": {
"type": "number"
},
"city_match_required": {
"type": "number"
},
"state_match_required": {
"type": "number"
},
"zip_match_required": {
"type": "number"
},
"dl_number_match_required": {
"type": "number"
}
}
}
}
}
},
"ssn_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_verify": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
},
"first_name_match_confidence": {
"type": "number"
},
"last_name_match_confidence": {
"type": "number"
},
"ssn_match_confidence": {
"type": "number"
},
"dob_match_confidence": {
"type": "number"
},
"age_match_confidence": {
"type": "number"
},
"address_match_confidence": {
"type": "number"
},
"identity_verified": {
"type": "boolean"
}
}
}
},
"person_search": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
}
}
},
"dl_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"ppt_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"document_liveness": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"min_confidence": {
"type": "number"
}
}
}
},
"idcard_authenticate": {
"type": "array",
"items": {
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"action_code": {
"type": "number"
},
"document_type": {
"type": "string"
},
"document_front_liveness": {
"type": "number"
},
"document_back_liveness": {
"type": "number"
},
"face_assertion_score": {
"type": "number"
}
}
}
},
"id_capture": {
"type": "array",
"items": {
"type": "object",
"description": "ID Capture configuration. Either `pii_retention_off`/`pii_retention_ttl` or `piiRetentionConfig` must be present, but not both. These fields are mutually exclusive.\n",
"properties": {
"verifier": {
"type": "string"
},
"skip": {
"type": "boolean"
},
"debug": {
"type": "boolean"
},
"returnRawData": {
"type": "boolean"
},
"expireSessionInMin": {
"type": "number"
},
"abandonSessionInMin": {
"type": "number"
},
"fraudDetectFailureBypass": {
"type": "boolean"
},
"pii_retention_off": {
"type": "boolean",
"description": "Mutually exclusive with piiRetentionConfig. If true, disables retention for all statuses."
},
"pii_retention_ttl": {
"type": "number",
"description": "Required if pii_retention_off is false. Mutually exclusive with piiRetentionConfig."
},
"piiRetentionConfig": {
"type": "array",
"description": "Array of objects, one for each status. Mutually exclusive with pii_retention_off and pii_retention_ttl.",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
}
}
}
}
}
},
"checks": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDetectTimeout": {
"type": "number"
},
"postTimeoutCaptureMode": {
"type": "string"
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
},
"useV1BlinkIdVerify": {
"type": "boolean"
},
"maxRetries": {
"type": "number"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"criteria": {
"type": "string"
},
"minMatchScore": {
"type": "number"
},
"matchCommonAliases": {
"type": "boolean"
},
"ignoreMiddleNames": {
"type": "boolean"
}
}
}
},
"bypassConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"criteria": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
"communityId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tenantId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"tag": "xxxxxx",
"name": "xxxxxx",
"face_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.7,
"min_quality": 0.5,
"selfieCaptureMode": "auto",
"pipeline": "aaa",
"other_pipelines": {
"authentication": "xxx",
"registration": "yyy",
"doc_enrollment": "zzz"
}
}
],
"face_compare": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7,
"other_confidence": {
"authentication": 0.7,
"doc_enrollment": 0.7
}
}
],
"face_rekognition": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0.7
}
],
"dl_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"include_states": [
"xx",
"xx"
],
"exclude_states": [
"xx",
"xx"
],
"dob_match_required": false,
"first_name_exact_match_required": true,
"first_name_fuzzy_match_required": true,
"last_name_exact_match_required": true,
"last_name_fuzzy_match_required": true,
"middle_name_exact_match_required": true,
"middle_name_fuzzy_match_required": true,
"doc_category_match_required": true,
"doi_match_required": true,
"doe_match_required": true,
"person_sex_match_required": true,
"person_height_match_required": true,
"person_eye_color_match_required": true,
"address_match_required": true,
"city_match_required": true,
"state_match_required": true,
"zip_match_required": true,
"dl_number_match_required": true,
"weights": {
"dob_match_required": 0,
"first_name_exact_match_required": 0,
"first_name_fuzzy_match_required": 0,
"last_name_exact_match_required": 0,
"last_name_fuzzy_match_required": 0,
"middle_name_exact_match_required": 0,
"middle_name_fuzzy_match_required": 0,
"doc_category_match_required": 0,
"doi_match_required": 0,
"doe_match_required": 0,
"person_sex_match_required": 0,
"person_height_match_required": 0,
"person_eye_color_match_required": 0,
"address_match_required": 0,
"city_match_required": 0,
"state_match_required": 0,
"zip_match_required": 0,
"dl_number_match_required": 0
}
}
],
"ssn_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_verify": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"min_confidence": 0,
"first_name_match_confidence": true,
"last_name_match_confidence": true,
"ssn_match_confidence": true,
"dob_match_confidence": true,
"age_match_confidence": true,
"address_match_confidence": true,
"identity_verified": true
}
],
"person_search": [
{
"verifier": "xxxx",
"skip": false,
"debug": true
}
],
"dl_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "11",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"ppt_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"face_assertion_score": 0.5
}
],
"document_liveness": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"min_confidence": 0.5
}
],
"idcard_authenticate": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"action_code": 99,
"document_type": "00",
"document_front_liveness": 0.5,
"document_back_liveness": 0.5,
"face_assertion_score": 0.7
}
],
"id_capture": [
{
"verifier": "xxxx",
"skip": false,
"debug": true,
"returnRawData": false,
"expireSessionInMin": 10080,
"abandonSessionInMin": 60,
"fraudDetectFailureBypass": true,
"piiRetentionConfig": [
{
"status": "SUCCESS",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 0
}
},
{
"status": "FAILED",
"value": {
"pii_retention_off": false,
"pii_retention_ttl": 300
}
},
{
"status": "NOT_PERFORMED",
"value": {
"pii_retention_off": true
}
},
{
"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"
],
"autoDetectTimeout": 40,
"postTimeoutCaptureMode": "none",
"autoCaptureCountdownSeconds": 10,
"autoCaptureCountdownVisible": true,
"bypassConfigJS": "return true;",
"enableManualReview": false,
"useV1BlinkIdVerify": false,
"maxRetries": 2,
"bypassConfig": [
{
"criteria": "result.barcode.addressDetailedInfo.jurisdiction === \"NU\"",
"enabled": true
}
],
"conditions": [
{
"module": "firstname check",
"criteria": "fuzzyMatch",
"minMatchScore": 50,
"matchCommonAliases": false,
"ignoreMiddleNames": false
},
{
"module": "lastname check",
"criteria": "eq",
"ignoreMiddleNames": false
},
{
"module": "dob check",
"criteria": "eq"
}
]
}
]
}
},
"VerifyRequest": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
},
"example": {
"data": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx="
}
},
"VerifyResponse": {
"type": "object",
"properties": {
"data": {
"type": "string"
},
"publicKey": {
"type": "string"
}
},
"example": {
"data": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx=",
"publicKey": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx="
}
},
"DocumentShareSessionRequest": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
},
"example": {
"data": {
"dvcID": "",
"sessionRequest": {
"tenantDNS": "",
"communityName": "",
"documentType": "",
"userUID": "",
"did": "",
"user": {
"uid": "",
"username": "",
"firstname": "",
"lastname": "",
"dob": ""
},
"expireSessionInMin": "",
"abandonSessionInMin": "",
"workflowMetadata": {
"workflowId": "",
"wfInstanceId": ""
}
}
}
}
},
"DocumentShareSessionResponse": {
"type": "object",
"properties": {
"sessionId": {
"type": "string"
},
"url": {
"type": "string"
}
},
"example": {
"sessionId": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx=",
"url": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx="
}
},
"checkSessionStatusRequest": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
},
"example": {
"data": {
"dvcID": "",
"sessionId": "",
"includeMetadata": false,
"alwaysReturnAssets": false,
"granularStatus": false
}
}
},
"checkSessionStatusResponse": {
"type": "object",
"properties": {
"data": {
"type": "string"
},
"publicKey": {
"type": "string"
}
},
"example": {
"data": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx=",
"publicKey": "xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx="
}
},
"GetServiceComponentsResponse": {
"type": "object",
"properties": {
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"name3": {
"type": "string"
}
},
"example": {
"name1": "https://xxx.xxxxxx.xxx/xxxxx",
"name2": "https://xxx.xxxxxx.xxx/xxxxx",
"name3": "https://xxx.xxxxxx.xxx/xxxxx"
}
},
"WellKnownResponse": {
"type": "object",
"properties": {
"journeyTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"documentsList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"region": {
"type": "string"
},
"documentType": {
"type": "string"
}
}
}
},
"dataRetention": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "integer"
}
}
}
}
}
},
"dataComparisonAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"module": {
"type": "string"
},
"criteriaOptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"ignoreMiddleNames": {
"type": "boolean"
},
"minMatchScore": {
"type": "object",
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
},
"default": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"usecase": {
"type": "object",
"properties": {
"contexts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"documentVerificationPolicy": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"retryCount": {
"type": "object",
"properties": {
"maxValue": {
"type": "integer"
},
"defaultValue": {
"type": "integer"
}
}
},
"selfieRetryCount": {
"type": "object",
"properties": {
"maxValue": {
"type": "integer"
},
"defaultValue": {
"type": "integer"
}
}
},
"expireSessionInMin": {
"type": "integer"
},
"abandonSessionInMin": {
"type": "integer"
},
"livenessLevels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"faceMatchingScore": {
"type": "integer"
},
"selfieCaptureModes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"PutVerificationConfigV2Request": {
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
},
"journeyType": {
"type": "string",
"enum": [
"DOCUMENT_VERIFICATION_ONLY",
"KYC_WITH_FACE_COMPARISON"
]
},
"dvcID": {
"type": "string"
},
"face_liveness": {
"type": "object"
},
"face_compare": {
"type": "object"
},
"dl_verify": {
"type": "object"
},
"ssn_verify": {
"type": "object"
},
"person_verify": {
"type": "object"
},
"person_search": {
"type": "object"
},
"id_capture": {
"type": "object",
"properties": {
"tenantDNS": {
"type": "string"
},
"debug": {
"type": "boolean",
"default": true
},
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
},
"autoDetectTimeout": {
"type": "number",
"default": 40
},
"postTimeoutCaptureMode": {
"type": "string",
"default": "none",
"enum": [
"none",
"manual",
"auto"
]
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
}
}
},
"face_rekognition": {
"type": "object"
}
}
},
"PatchVerificationConfigV2Request": {
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"name": {
"type": "string"
},
"dvcID": {
"type": "string"
},
"face_liveness": {
"type": "object"
},
"face_compare": {
"type": "object"
},
"dl_verify": {
"type": "object"
},
"ssn_verify": {
"type": "object"
},
"person_verify": {
"type": "object"
},
"person_search": {
"type": "object"
},
"id_capture": {
"type": "object",
"properties": {
"tenantDNS": {
"type": "string"
},
"debug": {
"type": "boolean",
"default": true
},
"pii_retention_off": {
"type": "boolean"
},
"pii_retention_ttl": {
"type": "number"
},
"autoDetectTimeout": {
"type": "number",
"default": 40
},
"postTimeoutCaptureMode": {
"type": "string",
"default": "none",
"enum": [
"none",
"manual",
"auto"
]
},
"autoCaptureCountdownSeconds": {
"type": "number"
},
"autoCaptureCountdownVisible": {
"type": "boolean"
},
"bypassConfigJS": {
"type": "string",
"description": "JavaScript code for custom bypass logic"
},
"enableManualReview": {
"type": "boolean",
"description": "Enable manual review for the capture session",
"default": false
}
}
},
"face_rekognition": {
"type": "object"
}
}
},
"GetVerificationConfigV2Response": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"communityId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tag": {
"type": "string"
},
"name": {
"type": "string"
},
"journeyType": {
"type": "string"
},
"createdAt": {
"type": "number"
},
"lastModifiedAt": {
"type": "number"
},
"dvcID": {
"type": "string"
},
"face_liveness": {
"type": "object"
},
"face_compare": {
"type": "object"
},
"dl_verify": {
"type": "object"
},
"ssn_verify": {
"type": "object"
},
"person_verify": {
"type": "object"
},
"person_search": {
"type": "object"
},
"id_capture": {
"type": "object"
},
"face_rekognition": {
"type": "object"
}
}
},
"GetVerificationConfigV2ListResponse": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetVerificationConfigV2Response"
}
},
"page": {
"type": "object",
"properties": {
"index": {
"type": "number"
},
"size": {
"type": "number"
},
"total": {
"type": "number"
}
}
}
}
}
},
"securitySchemes": {
"keyId": {
"type": "apiKey",
"name": "keyId",
"in": "header",
"description": "ECDSA Public Key"
},
"keySecret": {
"type": "apiKey",
"name": "keySecret",
"in": "header",
"description": "ECDSA Private Key"
},
"license": {
"type": "apiKey",
"name": "license",
"in": "header",
"description": "License key from License Microservice"
}
}
},
"tags": [
{
"name": "Well Known config"
},
{
"name": "Service Key"
},
{
"name": "Public Key"
},
{
"name": "Healthz"
},
{
"name": "Environment"
},
{
"name": "ECDSA Helper"
},
{
"name": "Base64 Helper"
}
],
"servers": [
{
"url": "https://pilot-root.1kosmos.net/docuverify/"
}
]
}