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.
Call Sequence
A scanning session is the overarching unit of work. It contains a collection of documents to be analysed. A scanning session can contain several analyses. An analysis is started by supplying the scanning session with an analysis configuration object.
Scanning flow can be configured using merchant settings, please contact Zignsec Support for assistance.
1: Create a scanning session
To start a Scanning session you need to follow these steps:
- Chose the environment to call and set up URL
- Add Headers to the request
- Add Request Parameters
- Execute the request and fetch the redirect_url from the response
Here follows an example of a request and a response and lists of parameters:
- Request
- Response
- Request parameter
- Response parameter
1.1: POST-request example
curl --location --request POST 'https://test-gateway.zignsec.com/v3/scanning' \
--header 'Authorization: Your-Key....' \
--header 'Content-Type: application/json' \
--data-raw '{
"locale": "SE",
"relay_state": "zignsec123456",
"analysis_types": [
"document",
"liveness",
"selfie"
],
"webhook": "https://webhook.site/fbbd9db0-d5dc-453a-935c-10d5160bc3bc",
"target": "https://google.com?q=success",
"target_error": "https://bing.com?q=error"
}'
1.2 Response example
{
"id": "59ded41d-4d9e-4c80-bab9-ead5eb54aa0e",
"errors": [],
"redirect_url": "https://test-gateway.zignsec.com/ui/scanning-dp50/59ded41d-4d9e-4c80-bab9-ead5eb54aa0f?otp=SlnMHYGwxUyguJUDDHe0Kb"
}
1.3 Request Parameters
Test Environment : https://test-gateway.zignsec.com/v3/scanning
Production Environment : https://gateway.zignsec.com/v3/scanning
| Header | Description | Required |
|---|---|---|
| Authorization | This header parameter is the subscription key you received from ZignSec during the registration process. Example: Authorization: c610f7add0cff22873c428e4c3605d98 | Yes |
| Content-Type | Specifies the media type of the request body data. Set to application/json if JSON object. | Yes |
| Parameters | Description | Required |
|---|---|---|
| locale | Preferred Language to use, we support multiple languages like : en , sv ,de , fr, el, it ,ru ,es , cs, tr. We can add more languages as per your business requirements | No |
| relay_state | Use it to link an unique ID of your choice that you can parse. Example: relay_state=zignsec123456 | No |
| analysis_types | Parameter to set up types of analysis that will apply for current session. Types of analysis: Document Selfie Liveness | Yes |
| target | If this parameter is supplied the browser session will finally be redirected to this URL-value. Example : “target”: “https://landing.mysite.com” | No |
| target_error | target_error works as target except it is navigated on user cancel or error situations. | No |
| webhook | A URL where success/error results will automatically be POST:ed. During test you try https://webhook.site/ for free web hook URLs. | No |
1.4 Response Parameters
| Parameter | Description |
|---|---|
| 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. |
2: Start the workflow
To start the workflow simply trigger the redirect_url received.
There are two approaches to complete files upload to scanning:
- Browser flow – where you complete the flow on the same device as you triggered the URL
- Mobile flow – where you complete the flow on a mobile by either scanning the QR code or sending an SMS both methods will give you a URL-link to trigger
2.1: Example of browser flow
Browser flow: Upload all images from current browser.
Start verify identity Select continue in browser | Upload document either by taking a photo or uploading from folder | Start selfie flow | Follow instructions on the screen | After completing the flow you will be redirected to target URL |
 |  |  |  |  |
3: Get analysis result
The result of the web-flow will be sent to the webhook set in the POST request it is also possible to use a GET request together with the id for the session.
This method can also be used to fetch statues during the web-flow.
curl --location --request GET 'https://test-gateway.zignsec.com/v3/eid/scanningsessions/{id}/analyses' \
--header 'Authorization: Your-Key.....' \
--header 'Content-Type: application/json'
{
"total_result": "ACCEPTED",
"session_id": "90101b86-287e-4aa0-8638-1ad9ed43b387",
"start_date": "2023-01-04T14:12:15.5691888Z",
"finish_date": "2023-01-04T14:14:49.5791502Z",
"request_parameters": {
"relay_state": "zignsec123456",
"analysis_types": [
"Document",
"Liveness",
"Selfie"
],
"target": "https://google.com?q=success",
"target_error": "https://bing.com?q=error",
"webhook": "https://webhook.site/fbbd9db0-d5dc-453a-935c-10d5160bc3bc"
},
"synopsis_human_readable": {
"liveness_result": "ACCEPTED"
},
"identity": {
"first_name": "ERIKA",
"last_name": "MUSTERMANN",
"full_name": "MUSTERMANN ERIKA",
"personal_number": "",
"date_of_birth": "1964-08-12",
"age": 58,
"gender": "",
"address_info_raw": "51147KÖLN^HEIDESTRASSE 17",
"id_provider_name": "Regula",
"identification_date": "2023-01-04T14:14:00.4254855Z",
"id_provider_request_id": "55e95b84-b3cd-46be-b76a-50a068dffad7"
},
"identity_english": {
"first_name": "ERIKA",
"last_name": "MUSTERMANN",
"full_name": "MUSTERMANN ERIKA",
"personal_number": "",
"date_of_birth": "1964-08-12",
"age": 58,
"gender": "",
"address_info_raw": "51147KÖLN^HEIDESTRASSE 17",
"id_provider_name": "Regula",
"identification_date": "2023-01-04T14:14:00.4255071Z",
"id_provider_request_id": "55e95b84-b3cd-46be-b76a-50a068dffad7"
},
"analysis_summary": {
"result": "FAILED",
"result_title": "Failed",
"result_reason": "Id document was DECLINED. Selfie was FAILED",
"analysis_duration_sec": 154.0099614,
"history": [{
"startedAt": "2023-01-04T14:13:53.6683016Z",
"finishedAt": "2023-01-04T14:13:54.4747452Z",
"durationSec": 0.81,
"finished": true,
"subject": "Document-1-loading-files"
},
{
"startedAt": "2023-01-04T14:13:55.4511286Z",
"finishedAt": "2023-01-04T14:13:58.3929022Z",
"durationSec": 2.94,
"finished": true,
"subject": "Document-2-analysing"
},
{
"startedAt": "2023-01-04T14:13:58.392908Z",
"finishedAt": "2023-01-04T14:14:00.4254264Z",
"durationSec": 2.03,
"finished": true,
"subject": "Document-3-saving-output"
},
{
"startedAt": "2023-01-04T14:14:46.8572033Z",
"finishedAt": "2023-01-04T14:14:46.9797822Z",
"durationSec": 0.12,
"finished": true,
"subject": "FaceMatch-1-loading-files"
},
{
"startedAt": "2023-01-04T14:14:46.979792Z",
"finishedAt": "2023-01-04T14:14:47.0188328Z",
"durationSec": 0.04,
"finished": true,
"subject": "FaceMatch-2-loading-faces"
},
{
"startedAt": "2023-01-04T14:14:47.2271213Z",
"finishedAt": "2023-01-04T14:14:49.3333Z",
"durationSec": 2.11,
"finished": true,
"subject": "FaceMatch-3-analysing"
}
],
"session_id": "90101b86-287e-4aa0-8638-1ad9ed43b387",
"session_status": "FAILED",
"session_parameters": {
"relay_state": "zignsec123456",
"analysis_types": [
"Document",
"Liveness",
"Selfie"
],
"target": "https://google.com?q=success",
"target_error": "https://bing.com?q=error",
"webhook": "https://webhook.site/fbbd9db0-d5dc-453a-935c-10d5160bc3bc"
},
"id_document_summary": {
"result": "DECLINED",
"error": "",
"document_type_name": "Germany - Id Card (2010-2021) Side B",
"first_name": "ERIKA",
"last_name": "MUSTERMANN",
"full_name": "MUSTERMANN ERIKA",
"first_name_english": "ERIKA",
"last_name_english": "MUSTERMANN",
"full_name_english": "MUSTERMANN ERIKA",
"age": 58,
"expiration_date": "2027-04-05T00:00:00+00:00",
"result_title": "Declined",
"result_reason": "Surname,Surname_And_Given_Names",
"fields": {
"Address_local": "51147KÖLN^HEIDESTRASSE 17",
"Age": "58",
"Authority": "STADT KOELN",
"Authority_local": "STADT KÖLN",
"Date_of_Birth": "1964-08-12",
"Date_of_Birth_Checkdigit": "5",
"Date_of_Expiry": "2027-04-05",
"Date_of_Expiry_Checkdigit": "8",
"Date_of_Issue": "2017-04-06",
"Document_Class_Code": "ID",
"Document_Number": "T015Z7NGF",
"Document_Number_Checkdigit": "5",
"Eyes_Color_local": "GRÜN",
"Final_Checkdigit": "4",
"Given_Names": "ERIKA",
"Height": "160 cm",
"Issuing_State_Code": "D",
"Issuing_State_Name": "Germany",
"Line2_Optional_Data": "",
"MRZ_Strings": "IDD",
"MRZ_Type": "ID-1",
"Nationality": "Germany",
"Nationality_Code": "D",
"Optional_Data": "",
"RemainderTerm": "51",
"Sex": "",
"Surname": "MUSTERMANN",
"Surname_And_Given_Names": "MUSTERMANN ERIKA",
"Years_Since_Issue": "5"
}
},
"selfie_summary": {
"result": "FAILED",
"result_reason": "",
"result_title": "Failed"
},
"liveness_summary": {
"result": "ACCEPTED",
"result_title": "Accepted",
"errors": []
}
},
"analysis_details": [{
"analysis_id": 0,
"started_at": "2023-01-04T14:12:15.5691888Z",
"finished_at": "2023-01-04T14:14:49.5791502Z",
"total_process_state": "Failed",
"document_analysis_state": "Finished",
"session_status": "FAILED",
"document_analysis_result": "DECLINED",
"document_analysis_failed_fields": "Surname, Surname_And_Given_Names",
"fraud_analysis_result": "NOT_REQUESTED",
"expert_analysis_result": "NOT_REQUESTED",
"selfie_analysis_process_state": "Failed",
"selfie_analysis_result": "FAILED",
"liveness_analysis_state": "Finished",
"liveness_analysis_result": "ACCEPTED",
"document_analysis_details": {
"process_status": "Finished",
"document_type": "Germany - Id Card (2010-2021) Side B",
"found_text_fields": [{
"field_name": "Address_local",
"visual": "51147KÖLN^HEIDESTRASSE 17",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "ADDRESS",
"value": "51147KÖLN^HEIDESTRASSE 17",
"status": "NotVerified"
},
{
"field_name": "Age",
"mrz": "58",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "AGE",
"value": "58",
"status": "CompareTrue"
},
{
"field_name": "Authority",
"visual": "STADT KOELN",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "AUTHORITY",
"value": "STADT KOELN",
"status": "NotVerified"
},
{
"field_name": "Authority_local",
"visual": "STADT KÖLN",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "AUTHORITY",
"value": "STADT KÖLN",
"status": "NotVerified"
},
{
"field_name": "Date_of_Birth",
"mrz": "1964-08-12",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DATE_OF_BIRTH",
"value": "1964-08-12",
"status": "CompareTrue"
},
{
"field_name": "Date_of_Birth_Checkdigit",
"mrz": "5",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DATE_OF_BIRTH_CHECK_DIGIT",
"value": "5",
"status": "CompareTrue"
},
{
"field_name": "Date_of_Expiry",
"mrz": "2027-04-05",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DATE_OF_EXPIRY",
"value": "2027-04-05",
"status": "CompareTrue"
},
{
"field_name": "Date_of_Expiry_Checkdigit",
"mrz": "8",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DATE_OF_EXPIRY_CHECK_DIGIT",
"value": "8",
"status": "CompareTrue"
},
{
"field_name": "Date_of_Issue",
"visual": "2017-04-06",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "DATE_OF_ISSUE",
"value": "2017-04-06",
"status": "NotVerified"
},
{
"field_name": "Document_Class_Code",
"mrz": "ID",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DOCUMENT_CLASS_CODE",
"value": "ID",
"status": "CompareTrue"
},
{
"field_name": "Document_Number",
"mrz": "T015Z7NGF",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DOCUMENT_NUMBER",
"value": "T015Z7NGF",
"status": "CompareTrue"
},
{
"field_name": "Document_Number_Checkdigit",
"mrz": "5",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "DOCUMENT_NUMBER_CHECK_DIGIT",
"value": "5",
"status": "CompareTrue"
},
{
"field_name": "Eyes_Color_local",
"visual": "GRÜN",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "EYES_COLOR",
"value": "GRÜN",
"status": "NotVerified"
},
{
"field_name": "Final_Checkdigit",
"mrz": "4",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "FINAL_CHECK_DIGIT",
"value": "4",
"status": "CompareTrue"
},
{
"field_name": "Given_Names",
"mrz": "ERIKA",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "GIVEN_NAME",
"value": "ERIKA",
"status": "NotVerified"
},
{
"field_name": "Height",
"visual": "160 cm",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "HEIGHT",
"value": "160 cm",
"status": "NotVerified"
},
{
"field_name": "Issuing_State_Code",
"mrz": "D",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "ISSUING_STATE_CODE",
"value": "D",
"status": "CompareTrue"
},
{
"field_name": "Issuing_State_Name",
"mrz": "Germany",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "ISSUING_STATE_NAME",
"value": "Germany",
"status": "CompareTrue"
},
{
"field_name": "Line2_Optional_Data",
"mrz": "",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "LINE_2_OPTIONAL_DATA",
"value": "",
"status": "NotVerified"
},
{
"field_name": "MRZ_Strings",
"mrz": "IDD",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "MRZ_STRINGS",
"value": "IDD",
"status": "CompareTrue"
},
{
"field_name": "MRZ_Type",
"mrz": "ID-1",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "MRZ_TYPE",
"value": "ID-1",
"status": "NotVerified"
},
{
"field_name": "Nationality",
"mrz": "Germany",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "NATIONALITY",
"value": "Germany",
"status": "CompareTrue"
},
{
"field_name": "Nationality_Code",
"mrz": "D",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "NATIONALITY_CODE",
"value": "D",
"status": "CompareTrue"
},
{
"field_name": "Optional_Data",
"mrz": "",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "OPTIONAL_DATA",
"value": "",
"status": "NotVerified"
},
{
"field_name": "RemainderTerm",
"mrz": "51",
"verification_scores": {
"mrz": "CompareTrue"
},
"type": "REMAINDER_TERM",
"value": "51",
"status": "CompareTrue"
},
{
"field_name": "Sex",
"mrz": "",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "SEX",
"value": "",
"status": "NotVerified"
},
{
"field_name": "Surname",
"mrz": "MUSTERMANN",
"verification_scores": {
"mrz": "CompareFalse"
},
"type": "SURNAME",
"value": "MUSTERMANN",
"status": "CompareFalse"
},
{
"field_name": "Surname_And_Given_Names",
"mrz": "MUSTERMANN ERIKA",
"verification_scores": {
"mrz": "CompareFalse"
},
"type": "SURNAME_AND_GIVEN_NAMES",
"value": "MUSTERMANN ERIKA",
"status": "CompareFalse"
},
{
"field_name": "Years_Since_Issue",
"visual": "5",
"verification_scores": {
"mrz": "NotVerified"
},
"type": "YEARS_SINCE_ISSUE",
"value": "5",
"status": "NotVerified"
}
],
"found_image_parts": [{
"type": 210,
"name": "Ghost portrait",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/31b76e8c-4d94-4c86-8376-a77ad3a2aef7"
},
{
"type": 207,
"name": "Document front side",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/48249297-619d-465f-a283-6aa64588d6b1"
}
],
"history": [{
"startedAt": "2023-01-04T14:13:53.6683016Z",
"finishedAt": "2023-01-04T14:13:54.4747452Z",
"durationSec": 0.81,
"finished": true,
"subject": "Document-1-loading-files"
},
{
"startedAt": "2023-01-04T14:13:55.4511286Z",
"finishedAt": "2023-01-04T14:13:58.3929022Z",
"durationSec": 2.94,
"finished": true,
"subject": "Document-2-analysing"
},
{
"startedAt": "2023-01-04T14:13:58.392908Z",
"finishedAt": "2023-01-04T14:14:00.4254264Z",
"durationSec": 2.03,
"finished": true,
"subject": "Document-3-saving-output"
}
]
},
"selfie_analysis_details": {
"process_state": "Failed",
"resolution_status": "FAILED",
"resolution": "FAILED",
"resolution_message": "",
"found_images": [],
"history": [{
"startedAt": "2023-01-04T14:14:46.8572033Z",
"finishedAt": "2023-01-04T14:14:46.9797822Z",
"durationSec": 0.12,
"finished": true,
"subject": "FaceMatch-1-loading-files"
},
{
"startedAt": "2023-01-04T14:14:46.979792Z",
"finishedAt": "2023-01-04T14:14:47.0188328Z",
"durationSec": 0.04,
"finished": true,
"subject": "FaceMatch-2-loading-faces"
},
{
"startedAt": "2023-01-04T14:14:47.2271213Z",
"finishedAt": "2023-01-04T14:14:49.3333Z",
"durationSec": 2.11,
"finished": true,
"subject": "FaceMatch-3-analysing"
}
]
},
"liveness_analysis_details": {
"result": "ACCEPTED",
"process_status": "Finished",
"errors": [],
"liveness_media": [{
"name": "5fb0d063-071c-420f-948b-ed93e9f5fa1a",
"imageUrl": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/5fb0d063-071c-420f-948b-ed93e9f5fa1a"
}]
},
"analysed_documents": [{
"id": 0,
"file_name": "66a7ede4-600d-40e0-b48b-2011750fe921",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/66a7ede4-600d-40e0-b48b-2011750fe921",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
},
{
"id": 1,
"file_name": "efde0793-32eb-48e3-9781-573cdaa0fc53",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/efde0793-32eb-48e3-9781-573cdaa0fc53",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
},
{
"id": 2,
"file_name": "976be495-574b-4b45-9a4e-2d2e61d7a449",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/976be495-574b-4b45-9a4e-2d2e61d7a449",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
},
{
"id": 3,
"file_name": "78520419-767d-48ec-9884-ceb4353dd6f8",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/78520419-767d-48ec-9884-ceb4353dd6f8",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
}
]
}],
"documents": [{
"id": 0,
"file_name": "66a7ede4-600d-40e0-b48b-2011750fe921",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/66a7ede4-600d-40e0-b48b-2011750fe921",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
},
{
"id": 1,
"file_name": "efde0793-32eb-48e3-9781-573cdaa0fc53",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/efde0793-32eb-48e3-9781-573cdaa0fc53",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
},
{
"id": 2,
"file_name": "976be495-574b-4b45-9a4e-2d2e61d7a449",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/976be495-574b-4b45-9a4e-2d2e61d7a449",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
},
{
"id": 3,
"file_name": "78520419-767d-48ec-9884-ceb4353dd6f8",
"image_url": "https://test-gateway.zignsec.com/folders/90101b86-287e-4aa0-8638-1ad9ed43b387/media/78520419-767d-48ec-9884-ceb4353dd6f8",
"document_page_type": "OtherDocument",
"sequence_number": 1,
"content_type": "image/jpeg"
}
]
}
3.1 Result Parameters
Below are descriptions of the parameters, fields and nodes of the result of the scanning
3.1.1 Overall Result Summary
This table presents the top node with fields and sub nodes in collapsed form.
| Parameter | Description |
|---|---|
| total_result | An overall analysis result. More details can be found in the table 3.1.2 |
| session_id | a session identifier |
| start_date | session start date |
| finish_date | session finish date |
| request_parameters | Node containing parameters sent in the request body. More details can be found in the table 1.3 |
| synopsis_human_readable | Node containing human readable synopsis |
| identity | Node containing identity values in original language (local values) E.g. Given_Names_local: ΣΟΦΙΑ (Sofia) More details can be found in the table 3.1.7 |
| identity_english | Node containing identity values translated to English (English values) |
| analysis_summary | Node containing a summary of analysis preformed. More details can be found in the table 3.1.4 |
| analysis_details | Node containing details of the analysis down to the individual fields. More details can be found in the table 3.1.5 |
| documents | Node containing the analyzed documents |
3.1.2 Analys Result parameters
| Parameter | Description |
|---|---|
| CREATED | Session is created |
| ANALYSING | Session analysis is in progress. |
| READY_TO_START | 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 . E.g. Selfie/liveness not requested |
| CANCELLED | Session cancelled by user |
| OPERATOR_REQUIRED | Analysis needs to be manually reviewed. E.g. When Selfie confidence value between 60-70% |
| TIMEOUT | Session expired, default is set to 1 hour |
3.1.3 Analysis Summary Model
| Fields | Description |
|---|---|
| result | Overall analysis result. view table 3.1.2 for more details E.g. “result”: “ACCEPTED” |
| result_title | Result string representation format E.g. “result_title”: “Accepted” |
| result_reason | Reason for result |
| analysis_duration_sec | Analysis duration in seconds E.g. “analysis_duration_sec”: 87.2769149, |
| history | Node containing a history of the different parts of the session. E.g. {“startedAt”: “2022-12-30T12:32:03.8213922Z”, “finishedAt”: “2022-12-30T12:32:03.9377702Z”, “durationSec”: 0.12, “finished”: true, “subject”: “Document-1-loading-files”} |
| session_id | Session identifier E.g. “session_id”: “d80cbd8c-83af-4c5c-afeb-5e6cf531ed95” |
| session_status | Status of session E.g. “session_status”: “ACCEPTED”, |
| session_parameters | Node containing parameters sent in the request body. More details can be found in the table 1.3 |
| id_document_summary | Node containing ID Document Summary view table 3.1.6 for more details |
| selfie_summary | Node containing a summary of the selfie analysis view table 3.1.5 for more details |
| liveness_summary | Node containing a summary of the liveness analysis result, result_title and errors |
3.1.4 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_result | Not available, deprecated feature. |
| document_analysis_details | Node containing a collection of scanned document fields. Each text field contains the field value and optional verification scores. For more details view table 3.1.7 |
| fraud_analysis_details | Not available, deprecated feature. |
| expert_analysis_details | Not available, deprecated feature. |
| analysed_documents | The documents that were analysed in this analysis. See 3.1.7 |
| analysis_id: 0, | |
| started_at | started_at: “2022-12-30T12:31:08.563101Z”, |
| finished_at | finished_at: “2022-12-30T12:32:35.8400159Z”, |
| selfie_min_confidence | selfie_min_confidence: 0.9628319144248962, |
| selfie_max_confidence: | selfie_max_confidence: 0.9628319144248962, |
| expert_analysis_result | expert_analysis_result: “NOT_REQUESTED”, |
| selfie_analysis_process_state | selfie_analysis_process_state: “Finished”, |
| selfie_analysis_result | selfie_analysis_result: “ACCEPTED”, |
| liveness_analysis_state | liveness_analysis_state: “NotRequested”, |
| liveness_analysis_result | liveness_analysis_result: “NOT_REQUESTED”, |
3.1.5 Selfie Summary Model
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.
3.1.6 Identity Summary Model
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.
