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

New scanning session: POST to https://env.zignsec.com/v3/eid/scanningsessions

Add documents: POST multipart/form-data to https://env.zignsec.com/v3/eid/scanningsessions/scanningSessionId/documents

Start analysis : POST analysis configuration object to POST to https://env.zignsec.com/v3/eid/scanningsessions/scanningSessionId

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": "abc",
  "analysisResults": [
  ],
  "documents": [
  ]
}

Example 2: Add documents

POST https://test.zignsec.com/v3/eid/scanningsessions/abc/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/abc/analyses HTTP/1.1
Authorization: YOUR-KEY....

{
  analysisTypes: ["fraud", "idDocument", "expertAnalysis"],
  callbackUrl: "https://my.callback.url/"
}

Start analysis response

{
  "id": 1,
  "startedAt": "2018-06-23T10:47:39.799Z",
  "finishedAt": "2018-06-23T10:47:39.799Z",
  "totalProcessState": "Processing",
  "idDocumentProcessState": "Processing",
  "forensicProcessState": "Processing",
  "expertAnalysisProcessState": "Processing",
  
  "identity": null,
  "fraudRiskScore": null,
  "idDocumentResults": null,
  "fraudAnalysisResults": null,
  "expertAnalysisResults": null,
  "analysedDocuments": [
    {
      "id": 1,
      "fileName": "id_document.jpg"
    }
  ]
}

Example 4: Get analysis results

GET https://test.zignsec.com/v3/eid/scanningsessions/abc/analyses/1 HTTP/1.1
Authorization: YOUR-KEY....

Get analysis results response

{
  "id": 1,
  "startedAt": "2019-06-23T10:47:39.799Z",
  "finishedAt": "2019-06-23T10:47:39.799Z",
  "totalProcessState": "Finished",
  "idDocumentProcessState": "Finished",
  "fraudProcessState": "Finished",
  "expertAnalysisProcessState": "Finished",
  "identity": {
    "countryCode": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "personalNumber": "string",
    "dateOfBirth": "string",
    "age": 0,
  },
  "fraudRiskScore": "HighRisk",
  "idDocumentResults": {
    "processStatus": "Finished",
    "textFields": [
      {
        "fieldName": "Date_of_Expiry",
        "mrz": "11/24/2021",
        "visual": null,
        "barcode": null,
        "verificationScores": {
          "Mrz": "Verified",
          "Visual": "Disabled",
          "Barcode": "Disabled",
          "MrzVisual": "Disabled",
          "MrzBarcode": "Disabled",
          "VisualBarcode": "Disabled"
        },
        // ....
      }
    ]
  },
  "fraudAnalysisResults": {
    "processStatus": "Finished",
    "images": [
      {
        "fileName": "id_document.jpg",
        "originalImageUrl": "https://original.image.url",
        "resultShortDescription": "critical deviation",
        "resultLongDescription": "The image is probably not original.Information about image height and width differs from information in metadata",
        "riskScore": "HighRisk",
        "metadata": {
          "model": "Canon PowerShot A1100 IS",
          "software": "microsoft windows photo viewer 6.1.7600.16385",
        },
        "filterResults": {
          "clonesResultUrl": "https://clones.result.jpeg"
        }
      }
    ],
    "riskScore": "HighRisk"
  },
  "expertAnalysisResults": {
    "processState": "Finished"
  },
  "analysedDocuments": [
    {
      "id": 1,
      "fileName": "id_document.jpg"
    }
  ]
}

Analysis results details

FieldDescription
totalProcessStateThe total process state for all analyses. Indicated whether the analyses are finished or not.
idDocumentProcessStateThe process state for the id document analysis.
fraudProcessStateThe process state for the fraud analysis.
expertAnalysisProcessStateThe process state for the expert analysis.
identityIf the id document analysis was performed, this is an object containing the properties pertaining to the identified person.
fraudRiskScoreThe fraud risk score. Risk score range is: no risk, low risk, medium risk, high risk
idDocumentResultsContains a collection of scanned document fields. Each text field contains the field value and optional verification scores.
fraudAnalysisResultsA collection of fraud analysis results. Each result object contains a risk score and additional comments.
expertAnalysisResultsContains links to images of the different expert analysis filters.
analysedDocumentsThe documents that were analysed in this analysis.