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.

API Calls

  1. New scanning session: POST to https://env.zignsec.com/v3/eid/scanningsessions
  2. Add documents: POST multipart/form-data to https://env.zignsec.com/v3/eid/scanningsessions/scanningSessionId/documents
  3. Start analysis : POST analysis configuration object to POST to https://env.zignsec.com/v3/eid/scanningsessions/scanningSessionId
  4. Get analysis results: GET https://env.zignsec.com/v3/eid/scanningsessions/scanningSessionId/analyses/analysisId
      • env is api or test.
      • scanningSessionId is the analysis session identifier retrieved from the setup call.
      • analysisId identifies a specific analysis.

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.

Example 1: New scanning session

POST https://test.zignsec.com/v3/eid/scanningsessions HTTP/1.1
Authorization: YOUR-KEY....

New scanning session response

{
    "id": "{scanningSessionId}",
    "analysis_results": [],
    "documents": []
}

Example 2: Add documents

POST https://test.zignsec.com/v3/eid/scanningsessions/{scanningSessionId}/documents HTTP/1.1
Authorization: YOUR-KEY....
Content-Type: multipart/form-data; boundary=12345

--12345
Content-Type: image/jpeg
Content-Disposition: form-data; name="document" filename="id_document.jpg"

...(binary bytes of the image)...
--12345--

Example 3: Start analysis

POST https://test.zignsec.com/v3/eid/scanningsessions/{scanningSessionId}/analyses HTTP/1.1
Authorization: YOUR-KEY....

{
  "analysis_types": ["document", "fraud", "expert"],
  "callback_url": "https://my.callback.url/"
}

Start analysis response

{
    "id": {analysisId},
    "started_at": "2019-08-13T09:36:38.2322749Z",
    "finished_at": null,
    "total_process_state": "Processing",
    "document_analysis_state": "Processing",
    "document_analysis_result": null,
    "document_analysis_failed_fields": null,
    "fraud_analysis_state": "Processing",
    "fraud_analysis_result": null,
    "fraud_analysis_risk_score": "Undefined",
    "expert_analysis_state": "Processing",
    "expert_analysis_result": null,
    "identity": null,
    "id_document_details": {
        "process_status": "Processing",
        "document_type": null,
        "text_fields": [],
        "images": null
    },
    "fraud_analysis_details": {
        "process_status": "Processing",
        "analysed_images": [],
        "risk_score": "Undefined"
    },
    "expert_analysis_details": {
        "process_state": "Processing",
        "filter_results": []
    },
    "analysed_documents": [
        {
            "id": 3321,
            "file_name": "20190201190744666_back.jpg pp_Hip-Hop-007.jpg",
            "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/8d7ad989-955f-46cd-90b6-47bf0f267134/20190201190744666_back.jpg%20pp_Hip-Hop-007.jpg"
        },
        {
            "id": 3322,
            "file_name": "20190201190744766_front.jpg pp_Hip-Hop-007.jpg",
            "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/8d7ad989-955f-46cd-90b6-47bf0f267134/20190201190744766_front.jpg%20pp_Hip-Hop-007.jpg"
        }
    ]
}

Example 4: Get analysis results

GET https://test.zignsec.com/v3/eid/scanningsessions/{scanningSessionId}/analyses/{analysisId} HTTP/1.1
Authorization: YOUR-KEY....

Get analysis results response

{
    "id": {scanningSessionId}
    "analysis_results": [
        {
            "id": {analysisId},
            "started_at": "2019-08-13T13:54:49.9585273",
            "finished_at": "2019-08-13T13:55:27.760144",
            "total_process_state": "Finished",
            "document_analysis_state": "Finished",
            "document_analysis_result": "DECLINED",
            "document_analysis_failed_fields": "FinalCheckDigit,Document_Number_CheckDigit,Date_of_Expiry,Document_Number,RemainderTerm",
            "fraud_analysis_state": "Finished",
            "fraud_analysis_result": "OPERATOR_REQUIRED",
            "fraud_analysis_risk_score": "HighRisk",
            "expert_analysis_state": "Finished",
            "expert_analysis_result": "OPERATOR_REQUIRED",
            "identity": {
                "document_number": null,
                "country_code": "",
                "first_name": "",
                "last_name": "",
                "full_name": "",
                "personal_number": "",
                "date_of_birth": "1990-02-10",
                "age": 29,
                "gender": "",
                "phone": null,
                "email": null,
                "address_info_raw": null,
                "result_report_pdf": null,
                "id_provider_name": "Scanning",
                "identification_date": "2019-08-13T13:55:33.8817449+00:00",
                "id_provider_request_id": "",
                "id_provider_person_id": "",
                "customer_person_id": "",
                "id_provider_authenticity_score": 0
            },
            "document_analysis_details": {
                "process_status": "Finished",
                "document_type": "Latvia - Id Card (2012) #2",
                "text_fields": [
                    {
                        "field_name": "Surname_And_Given_Names",
                        "mrz": "",
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Nationality_Code",
                        "mrz": "LVA",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Optional_Data",
                        "mrz": "10309",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Issuing_State_Name",
                        "mrz": "Latvia",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "MRZ_Strings",
                        "mrz": "",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Card_Access_Number",
                        "mrz": null,
                        "visual": "230605",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Date_of_Birth_CheckDigit",
                        "mrz": "0",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Date_of_Expiry_CheckDigit",
                        "mrz": "4",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "FinalCheckDigit",
                        "mrz": "9",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 2,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Surname_And_Given_Names (69599257)",
                        "mrz": null,
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "MRZ_Strings_With_Correct_CheckSums",
                        "mrz": "",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Document_Number_CheckDigit",
                        "mrz": "0",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 2,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Authority (69599256)",
                        "mrz": null,
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Given_Names (69599241)",
                        "mrz": null,
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Sex",
                        "mrz": "M",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Nationality",
                        "mrz": "Latvia",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Given_Names",
                        "mrz": "",
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Age",
                        "mrz": "29",
                        "visual": "29",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Surname",
                        "mrz": "",
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Surname (69599240)",
                        "mrz": null,
                        "visual": "",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Personal_Number",
                        "mrz": "",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Date_of_Birth",
                        "mrz": "2/10/1990",
                        "visual": "2/10/1990",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Date_of_Issue",
                        "mrz": null,
                        "visual": "19.10.210",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Date_of_Expiry",
                        "mrz": "8/21/2018",
                        "visual": "8/21/2018",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 2,
                            "Visual": 2,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Document_Number",
                        "mrz": "PA031343I0029",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 2,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Issuing_State_Code",
                        "mrz": "LVA",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Document_Class_Code",
                        "mrz": "I",
                        "visual": null,
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 1,
                            "Visual": 0,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "Height",
                        "mrz": null,
                        "visual": "683 ft 1 in",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 0,
                            "Visual": 2,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    },
                    {
                        "field_name": "RemainderTerm",
                        "mrz": "0",
                        "visual": "0",
                        "barcode": null,
                        "verification_scores": {
                            "Mrz": 2,
                            "Visual": 2,
                            "Barcode": 0,
                            "MrzVisual": 0,
                            "MrzBarcode": 0,
                            "VisualBarcode": 0
                        }
                    }
                ],
                "images": [
                    {
                        "type": 201,
                        "name": "Portrait",
                        "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/d8791fbe-8706-4b30-be15-b2ade1c7b733"
                    },
                    {
                        "type": 204,
                        "name": "Signature",
                        "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/ab0d41ab-ac81-4a65-9a2c-ac6238da3085"
                    }
                ]
            },
            "fraud_analysis_details": {
                "process_status": "Finished",
                "analysed_images": [
                    {
                        "file_name": "20190201190744766_front.jpg pp_Hip-Hop-007.jpg",
                        "original_image_url": null,
                        "result_short_description": "deviation was not detected",
                        "result_long_description": "The image is original.The image was probably compressed.",
                        "risk_score": "NoRisk",
                        "metadata": {
                            "maker": "",
                            "model": "",
                            "width": "2048",
                            "height": "1144",
                            "quality": "90",
                            "software": "google",
                            "width_exif": "2048",
                            "height_exif": "1144",
                            "exif_software_modified": "",
                            "datetime_create_exif_text": "",
                            "exif_gpsinfo_gpstimestamp": "",
                            "exif_image_timezoneoffset": "",
                            "exif_image_previewdatetime": "",
                            "datetime_digitize_exif_text": "",
                            "exif_image_datetimeoriginal": ""
                        }
                    },
                    {
                        "file_name": "20190201190744666_back.jpg pp_Hip-Hop-007.jpg",
                        "original_image_url": null,
                        "result_short_description": "critical deviation",
                        "result_long_description": "The image was compressed lots of times. The analyse of the image may be incorrect. The minimal threshold is 500 kb and 640x480 pixels.The image is probably not original.The image was resaved.",
                        "risk_score": "HighRisk",
                        "metadata": {
                            "maker": "",
                            "model": "",
                            "width": "2048",
                            "height": "1144",
                            "quality": "90",
                            "software": "google",
                            "width_exif": "2048",
                            "height_exif": "1144",
                            "exif_software_modified": "",
                            "datetime_create_exif_text": "",
                            "exif_gpsinfo_gpstimestamp": "",
                            "exif_image_timezoneoffset": "",
                            "exif_image_previewdatetime": "",
                            "datetime_digitize_exif_text": "",
                            "exif_image_datetimeoriginal": ""
                        }
                    }
                ],
                "risk_score": "HighRisk"
            },
            "expert_analysis_details": {
                "process_state": "Finished",
                "filter_results": [
                    {
                        "type": "Clones",
                        "url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/af4824ba-cff5-4036-b5ef-651ba8acd61d"
                    }
                ]
            },
            "analysed_documents": [
                {
                    "id": 3331,
                    "file_name": "20190201190744666_back.jpg pp_Hip-Hop-007.jpg",
                    "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/20190201190744666_back.jpg%20pp_Hip-Hop-007.jpg"
                },
                {
                    "id": 3332,
                    "file_name": "20190201190744766_front.jpg pp_Hip-Hop-007.jpg",
                    "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/20190201190744766_front.jpg%20pp_Hip-Hop-007.jpg"
                }
            ]
        }
    ],
    "documents": [
        {
            "id": 3331,
            "file_name": "20190201190744666_back.jpg pp_Hip-Hop-007.jpg",
            "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/20190201190744666_back.jpg%20pp_Hip-Hop-007.jpg"
        },
        {
            "id": 3332,
            "file_name": "20190201190744766_front.jpg pp_Hip-Hop-007.jpg",
            "image_url": "https://zignsecfilestorage.blob.core.windows.net/images-test/881fc8c4-67ee-4cf7-a3a9-21afa3f78ffc/20190201190744766_front.jpg%20pp_Hip-Hop-007.jpg"
        }
    ]
}

Get all analysis for session.

GET https://test.zignsec.com/v3/eid/scanningsessions/{scanningSessionId}/analyses HTTP/1.1
Authorization: YOUR-KEY....

Analysis results details

FieldDescription
total_process_stateThe 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
The state for the fraud analysis.
fraud_analysis_result
The result for the fraud analysis.
fraud_analysis_risk_score
The fraud risk score. Risk score range is: no risk, low risk, medium risk, high risk
expert_analysis_state
The state for the expert analysis.
expert_analysis_result
The result for the expert analysis.
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
A collection of fraud analysis results. Each result object contains a risk score and additional comments.
expert_analysis_details
Contains links to images of the different expert analysis filters.
analysed_documents
The documents that were analysed in this analysis.