ID document checking and general document scanning are historically the most common means of identifying new customers and is still considered an option to national electronic identification methods. We offer automatic detection and analysis of identity cards, passports and driving licenses.
The service Forgery Detection can be used as a measure to increase the confidence level and safeguard against deliberate tampering. Forgery Detection – ZignSec Docs
Swagger Links –
Test Swagger – Swagger UI (zignsec.com)
Prod Swagger – Swagger UI (zignsec.com)
Flow
- Intialize scanning session
- Complete browser steps
- Get analysis result
Step 1: Initialize scanning session
Step 1.1: Create a new scanning session
POST to
Test enviornment : https://test-gateway.zignsec.com/core/api/sessions/identity_verification/online_id_scan
Production enviornment : https://gateway.zignsec.com/core/api/sessions/identity_verification/online_id_scan
POST https://test-gateway.zignsec.com/core/api/sessions/identity_verification/online_id_scan
Content-Type: application/json
Authorization: 12345678-Your-KEY-5352305c9fb0
{
"locale": "en",
"metadata": {
"locale": "en"
},
"redirect_failure": "https://my_failure_url.com",
"redirect_success": "https://my_success_url.com",
"relay_state": "my-unique-customer-id",
"webhook": "https://my_webhook_url.com"
}
Step 1.2: Description of request model
locale | Preferred Language to use, we support multiple languages like : en , se ,de , fr, gr, it ,ru ,es , cz, tr |
metadata | Contain parameters like:
|
rediect_failure | URL to redirect the end-user to on failure |
rediect_success | URL to redirect the end-user to on success |
relay_state | This semi-optional parameter will be returned to you at the redirect back to your server. Use it to link an unique ID of your choice that you can parse. If not relaystate is specified, ZignSec will automatically set the ZignSec’s unique session identifier, the RequestID token here. Example: "relay_state":"client_state" |
webhook | A URL where success/error results will automatically be POST:ed. During test you try https://webhook.site/ for free web hook URLs. |
Step 1.3: Example of response for initializing scanning session
{
"id": "231a7aa4-SESSION_id-7ec4c6ee3a8c",
"errors": [],
"redirect_url": "https://test.zignsec.com/v3/eid/scanningsessions/scan/231a7aa4-SESSION_id-7ec4c6ee3a8c"
}Step 1.4: Description of response model
id | The session identifier, a GUID (globally unique identifier) unique for the started workflow, used both in the redirect_url and the get analysis results. |
errors | A JSON object that contains information on error conditions that might have resulted from the request, in an array of property-value pairs. If multiple errors occur, a pair of parameters is returned for each error. code Code for the error. List of codes is in table below. description A string that describes the type of error that occurred. If no errors occur, then this object is empty. errors : [] |
redirect_url | The URL that the user need to be redirected to complete the data via the web interface. It is possible to load the URL in an iframe. |
Step 2: Browser steps
There are two approaches to complete files upload to scanning:
- Browser flow
- Mobile flow
Step 2.1: Example of browser flow
Browser flow: Upload all images from current browser.
Start verify identity | Continue verification in browser | Select document type | Upload ID images | Upload selfie (optional depend on analysis types) | Waiting result |
 |  |  |  |  |  |
Step 2.2: Example of mobile flow
Mobile flow: start session in browser, continue in mobile, back to browser.
| Browser steps | |||||
Start verify identity | Scan QR code by mobile or send SMS with link to mobile | Waiting | Waiting | Waiting | Waiting result |
 | |  |  |  | |
| Mobile steps | |||||
| Open link from QR code or from SMS | Select document type | Upload ID images | Upload selfie (optional depend on analysis types) | Files submitted, go to browser | |
 |  |  |  | ||
Step 3 : Get Session Analysis
Get Analysis result by below get URL and session Id.
GET to
Test Enviornment – https://test-gateway.zignsec.com/core/api/sessions/{SessionId }
Prod Enviornment – https://gateway.zignsec.com/core/api/sessions/{SessionId }
GET https://test-gateway.zignsec.com/core/api/sessions/{SessionId }
Authorization : YOUR KEY
Get Analysis Response
Below Response is for a Dummy User
{
"data": {
"analysis_details": [
{
"analysed_documents": [
{
"content_type": "image/jpeg",
"document_page_type": "DriversLicense",
"external_id": "2c9a55b3-5806-4996-a75e-2c5a19ee1904",
"file_name": "document_2022_05_11_09_57_10_0.jpg",
"id": 105751,
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/document_2022_05_11_09_57_10_0.jpg",
"reference": "undefined",
"sequence_number": 1
},
{
"content_type": "image/jpeg",
"document_page_type": "Selfie",
"external_id": "e92b9ad4-5b02-4d4e-9ba2-8cf8da303dd7",
"file_name": "self_document_2022_05_11_09_57_54_0.jpg",
"id": 105752,
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/self_document_2022_05_11_09_57_54_0.jpg",
"reference": "selfie",
"sequence_number": 1
}
],
"analysis_id": 74248,
"document_analysis_details": {
"document_type": "United States - Connecticut Driving License (2017) Real",
"found_document_types": [
{
"document_type": "United States - Connecticut Driving License (2017) Real",
"file_name": "document_2022_05_11_09_57_10_0.jpg",
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/6e0c40b1-c18b-4799-99b9-6b1c075bd4d9"
}
],
"found_image_parts": [
{
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/676fe172-213d-46b1-a75f-234cc3a2e06c",
"name": "Signature",
"type": 204
},
{
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/d7652ff6-7040-42d2-b044-a98f97a5616e",
"name": "Ghost portrait",
"type": 210
},
{
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/e46ac7bc-abe6-4f0a-bd88-f4e2e2e32436",
"name": "Portrait",
"type": 201
},
{
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/dd9154a6-47f3-42bd-9e4c-1aadd0ecb12a",
"name": null,
"type": 0
}
],
"found_text_fields": [
{
"barcode": null,
"field_name": "Given_Names",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "REBECCA"
},
{
"barcode": null,
"field_name": "Surname",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "IDTOPIS"
},
{
"barcode": null,
"field_name": "Surname_And_Given_Names",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "IDTOPIS REBECCA"
},
{
"barcode": null,
"field_name": "Issuing_State_Name",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "United States"
},
{
"barcode": null,
"field_name": "Issuing_State_Code",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "USA"
},
{
"barcode": null,
"field_name": "Age",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "22"
},
{
"barcode": null,
"field_name": "Document_Number",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "288888888"
},
{
"barcode": null,
"field_name": "DL_Class",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "D"
},
{
"barcode": null,
"field_name": "RemainderTerm",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 1,
"VisualBarcode": 0
},
"visual": "50"
},
{
"barcode": null,
"field_name": " (334)",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "15048625001253MVE1"
},
{
"barcode": null,
"field_name": " (522)",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "21"
},
{
"barcode": null,
"field_name": " (523)",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "1"
},
{
"barcode": null,
"field_name": "Address",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "1 VAN NESS ST^NORWALK, CT 06850-2912"
},
{
"barcode": null,
"field_name": "Address_City",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "NORWALK"
},
{
"barcode": null,
"field_name": "Address_Jurisdiction_Code",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "CT"
},
{
"barcode": null,
"field_name": "Address_Postal_Code",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "06850-2912"
},
{
"barcode": null,
"field_name": "Address_Street",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "1 VAN NESS ST"
},
{
"barcode": null,
"field_name": "Date_of_Birth",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "1999-08-08"
},
{
"barcode": null,
"field_name": "Date_of_Expiry",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 1,
"VisualBarcode": 0
},
"visual": "2026-08-08"
},
{
"barcode": null,
"field_name": "Date_of_Issue",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "2020-09-09"
},
{
"barcode": null,
"field_name": "DL_Endorsed",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "NONE"
},
{
"barcode": null,
"field_name": "DL_Restriction_Code",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "NONE"
},
{
"barcode": null,
"field_name": "Eyes_Color",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "Brown"
},
{
"barcode": null,
"field_name": "Height",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "172 cm"
},
{
"barcode": null,
"field_name": "Sex",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "M"
}
],
"process_status": "Finished"
},
"document_analysis_failed_fields": "",
"document_analysis_ignored_errors": "",
"document_analysis_result": "ACCEPTED",
"document_analysis_state": "Finished",
"expert_analysis_details": {
"filter_results": [],
"process_state": "NotRequested"
},
"expert_analysis_result": "NOT_REQUESTED",
"expert_analysis_state": "NotRequested",
"finished_at": "2022-05-11T09:58:06.3363981Z",
"fraud_analysis_details": {
"analysed_images": [],
"process_status": "NotRequested",
"risk_score": "Undefined"
},
"fraud_analysis_result": "NOT_REQUESTED",
"fraud_analysis_risk_score": "Undefined",
"fraud_analysis_state": "NotRequested",
"liveness_analysis_details": {
"errors": [],
"liveness_media": [
{
"confidence_spoofing": null,
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/document_2022_05_11_09_57_10_0.jpg",
"name": "document_2022_05_11_09_57_10_0.jpg",
"tags": null,
"video_url": null
}
],
"process_status": "NotRequested",
"result": "NOT_REQUESTED"
},
"liveness_analysis_result": "NOT_REQUESTED",
"liveness_analysis_state": "NotRequested",
"selfie_analysis_details": {
"found_images": [
{
"result_file_name": "",
"result_image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/f1e218dd-7bea-43ff-8e23-cf2af50c1d03",
"source_file_name": "document_2022_05_11_09_57_10_0.jpg",
"source_image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/4a740ef2-524f-4e82-a085-f42a000a1d8e"
},
{
"result_file_name": "",
"result_image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/e5496b9a-636e-462c-8ab7-68725e3dd8af",
"source_file_name": "self_document_2022_05_11_09_57_54_0.jpg",
"source_image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/2c0c64fa-2628-49f0-9a1e-ff3e64024a15"
}
],
"max_confidence": 0,
"min_confidence": 0,
"process_state": "Finished",
"resolution": "DECLINED",
"resolution_message": "Percent of similarity 0.00%",
"resolution_status": "DECLINED"
},
"selfie_analysis_process_state": "Finished",
"selfie_analysis_result": "DECLINED",
"selfie_max_confidence": 0,
"selfie_min_confidence": 0,
"session_status": "DECLINED",
"started_at": "2022-05-11T09:57:54.6789504Z",
"total_process_state": "Finished"
}
],
"analysis_summary": {
"analysis_duration_sec": 11.7,
"expert_summary": {
"error": null,
"result": "NOT_REQUESTED",
"result_title": "Not Requested"
},
"fraud_summary": {
"all_errors": [],
"error": null,
"result": "NOT_REQUESTED",
"result_reason": null,
"result_title": "Not Requested",
"risk_score": "Undefined"
},
"id_document_summary": {
"age": 22,
"document_type_name": "United States - Connecticut Driving License (2017) Real",
"error": null,
"expiration_date": "2026-08-08T00:00:00+00:00",
"fields": {
" (334)": "15048625001253MVE1",
" (522)": "21",
" (523)": "1",
"Address": "1 VAN NESS ST^NORWALK, CT 06850-2912",
"Address_City": "NORWALK",
"Address_Jurisdiction_Code": "CT",
"Address_Postal_Code": "06850-2912",
"Address_Street": "1 VAN NESS ST",
"Age": "22",
"DL_Class": "D",
"DL_Endorsed": "NONE",
"DL_Restriction_Code": "NONE",
"Date_of_Birth": "1999-08-08",
"Date_of_Expiry": "2026-08-08",
"Date_of_Issue": "2020-09-09",
"Document_Number": "288888888",
"Eyes_Color": "Brown",
"Given_Names": "REBECCA",
"Height": "172 cm",
"Issuing_State_Code": "USA",
"Issuing_State_Name": "United States",
"RemainderTerm": "50",
"Sex": "M",
"Surname": "IDTOPIS",
"Surname_And_Given_Names": "IDTOPIS REBECCA"
},
"first_name": "REBECCA",
"first_name_english": "REBECCA",
"full_name": "IDTOPIS REBECCA",
"full_name_english": "IDTOPIS REBECCA",
"issuer_state": "United States",
"last_name": "IDTOPIS",
"last_name_english": "IDTOPIS",
"result": "ACCEPTED",
"result_reason": "",
"result_title": "Accepted"
},
"liveness_summary": null,
"result": "DECLINED",
"result_reason": "Selfie was DECLINED",
"result_title": "Declined",
"selfie_summary": {
"error": null,
"max_confidence": 0,
"min_confidence": 0,
"result": "DECLINED",
"result_reason": "Percent of similarity 0.00%",
"result_title": "Declined"
},
"session_id": "476e5b72-1448-4412-928d-8d28b8d8b04f",
"session_parameters": {
"analysis_types": [
"Document",
"Selfie"
],
"doc": {
"ignore_errors_in_fields": [
"Personal_Number",
"Surname",
"Surname_And_Given_Names",
"Given_Names",
"Surname_And_Given_Names_local",
"Surname_local",
"Date_of_Birth",
"Date_of_Expiry",
"RemainderTerm"
],
"verification_types": [
"Mrz",
"Visual",
"Barcode",
"MrzVisual",
"MrzBarcode",
"VisualBarcode"
]
},
"flow": null,
"relay_state": null,
"session_type": "BrowserFlow",
"target": "https://my_success_url.com",
"target_error": null,
"webhook": "https://test-gateway.zignsec.com/api/core-bridge/webhooks/zignsec"
},
"session_status": "DECLINED"
},
"documents": [
{
"content_type": "image/jpeg",
"document_page_type": "DriversLicense",
"external_id": "2c9a55b3-5806-4996-a75e-2c5a19ee1904",
"file_name": "document_2022_05_11_09_57_10_0.jpg",
"id": 105751,
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/document_2022_05_11_09_57_10_0.jpg",
"reference": "undefined",
"sequence_number": 1
},
{
"content_type": "image/jpeg",
"document_page_type": "Selfie",
"external_id": "e92b9ad4-5b02-4d4e-9ba2-8cf8da303dd7",
"file_name": "self_document_2022_05_11_09_57_54_0.jpg",
"id": 105752,
"image_url": "https://test.zignsec.com/v3/scan/api/v1/images/476e5b72-1448-4412-928d-8d28b8d8b04f/self_document_2022_05_11_09_57_54_0.jpg",
"reference": "selfie",
"sequence_number": 1
}
],
"finish_date": "2022-05-11T09:58:06.336499Z",
"identity": {
"address_info_raw": "1 VAN NESS ST^NORWALK, CT 06850-2912",
"age": 22,
"country_code": "us",
"customer_person_id": null,
"date_of_birth": "1999-08-08",
"email": null,
"first_name": "REBECCA",
"full_name": "IDTOPIS REBECCA",
"gender": "",
"id_provider_authenticity_score": 0,
"id_provider_name": "Scanning",
"id_provider_person_id": null,
"id_provider_request_id": "e3ef9c41-4c78-4843-ba15-39cb096a9ec4",
"identification_date": "2022-05-11T09:58:06.4302359Z",
"last_name": "IDTOPIS",
"personal_number": null,
"phone": null,
"result_report_pdf": null
},
"identity_english": {
"address_info_raw": "1 VAN NESS ST^NORWALK, CT 06850-2912",
"age": 22,
"country_code": "us",
"customer_person_id": null,
"date_of_birth": "1999-08-08",
"email": null,
"first_name": "REBECCA",
"full_name": "IDTOPIS REBECCA",
"gender": "",
"id_provider_authenticity_score": 0,
"id_provider_name": "Scanning",
"id_provider_person_id": null,
"id_provider_request_id": "e3ef9c41-4c78-4843-ba15-39cb096a9ec4",
"identification_date": "2022-05-11T09:58:06.4302427Z",
"last_name": "IDTOPIS",
"personal_number": null,
"phone": null,
"result_report_pdf": null
},
"provider_folder_id": "31ecb6cb-512d-425c-a03f-80094dc1f78a",
"request_parameters": {
"analysis_types": [
"Document",
"Selfie"
],
"doc": {
"ignore_errors_in_fields": [
"Personal_Number",
"Surname",
"Surname_And_Given_Names",
"Given_Names",
"Surname_And_Given_Names_local",
"Surname_local",
"Date_of_Birth",
"Date_of_Expiry",
"RemainderTerm"
],
"verification_types": [
"Mrz",
"Visual",
"Barcode",
"MrzVisual",
"MrzBarcode",
"VisualBarcode"
]
},
"flow": null,
"relay_state": null,
"session_type": "BrowserFlow",
"target": "https://my_success_url.com",
"target_error": null,
"webhook": "https://test-gateway.zignsec.com/api/core-bridge/webhooks/zignsec"
},
"session_id": "476e5b72-1448-4412-928d-8d28b8d8b04f",
"start_date": "2022-05-11T09:57:54.6789535Z",
"synopsis_human_readable": {
"doc_date_of_birth": "1999-08-08 (Age: 22)",
"doc_expiration": "2026-08-08",
"doc_full_name": "IDTOPIS REBECCA",
"doc_issuer_state": "United States",
"expert_result": "NOT REQUESTED",
"fraud_result": "NOT REQUESTED",
"id_document_result": "ACCEPTED [IDTOPIS REBECCA; United States - Connecticut Driving License (2017) Real; Age 22]",
"liveness_result": null,
"selfie_result": "DECLINED [0.00% match]",
"session_started": "2022-05-11 09:57:54 (Duration 11.7 s)",
"total_result": "DECLINED [Selfie was DECLINED]"
},
"total_result": "DECLINED"
}
}
Response Paramters Description
total_result | an overall analysis result. See Result |
session_id | a session identifier |
start_date | session start date |
finish_date | session finish date |
provider_folder_id | an id used on the scanning provider side |
request_parameters | session parameters.See Session Parameters |
synopsis_human_readable | human readable synopsis |
identity | identity (local values) |
identity_english | identity (English values) |
analysis_summary | see Analysis Summary |
analysis_details | see Analysis Result |
documents | analyzed documents |
error | error string |
Total Result( an overall analysis result)
Total Result ( an overall analysis result)
Created | Session is created |
Analysing | Session analysis is in progress. |
Not started | Session analysis not started. |
Accepted | Session is successful.. |
Declined | Document is declined . when data is incorrect or bad document image quality. |
Failed | Session is failed . Document Image not found becuase of bad image quality or network issues . |
Not Requested | Analysis not requested . Ex: Selfie/liveness not requested |
Cancelled | Session cancelled by user |
Session Parameters
relay_state | state sent from the client persisted in session. Is sent back to redirect urls and webhooks as is |
session_type | session type Api | BrowserFlow | WebSdk |
webhook | webhook url |
target | to be used by the Browser Flow to redirect user when analysis is finished |
target_error | to be used by Browser Flow to redirect user when analysis is FAILED |
analysis_types | an array of the Document | Selfie |(Fraud and Expert are not available, have been deprecated) |
| Field | Description |
|---|
Analysis Summary Model
session_id | a session identifier |
total_process_state | a state of the current operation. See State |
session_parameters | session parameters. See Session Parameters |
result | an overall analysis result. See Result |
result_title | result string representation |
result_reason | result reason string |
analysis_duration_sec | analysis duration in seconds |
id_document_summary | See Id Document Summary |
selfie_summary | See Selfie Summary |
fraud_analysis_summary | not available |
expert_analysis_summary | not available |
Analysis results details
| Field | Description |
|---|---|
total_process_state | The total process state for all analyses. Indicated whether the analyses are finished or not. |
document_analysis_state | The state for the document analysis. |
document_analysis_result | The result for the document analysis. |
document_analysis_failed_fields | Failed fields in csv format. |
fraud_analysis_state | Not available |
fraud_analysis_result | Not available |
fraud_analysis_risk_score | Not available |
expert_analysis_state | Not available |
expert_analysis_result | Not available |
identity | If the id document analysis was performed, this is an object containing the properties pertaining to the identified person. |
document_analysis_details | Contains a collection of scanned document fields. Each text field contains the field value and optional verification scores. |
fraud_analysis_details | Not available |
expert_analysis_details | Not available |
analysed_documents | The documents that were analysed in this analysis. See Document |
