Skip to main content

Scan ID

Availability

Available in SDK v1.0+

Extraction​

This capability extracts information from a government-issued identity document such as an identity card, passport, or driver's license. The extracted info is then available in subsequent steps, as well as over the API. This step doesn't contain specific configurations, but it allows custom rules.

Scan ID

After a document has been scanned, the subsequent steps can use it automatically in their downstream workflow.

API access​

If you need access to the extracted information via the API, use the Agent API.

The relevant portion of the response is .state.Blinkid:<id>, as contains the extracted information. (The <id> portion is a placeholder for the actual capability ID for that workflow; it's going to be a number).

For example:

curl --url https://api.us-east.platform.microblink.com/agent/api/v1/transaction/<transaction_id> --oauth2-bearer $YOUR_BEARER_TOKEN_HERE | jq '.state.["BlinkId:3"]'

This will return an object like this:

{
  "extraction": {
    "firstName": "EXAMPLE",
    "lastName": "EXAMPLE",
    "address": "EXAMPLE ADDRESS",
    "dateOfBirth": "1991-01-01",
    "dateOfIssue": "2024-01-01",
    "dateOfExpiry": "2029-01-01",
    "documentNumber": "123456789",
    "sex": "M/M",
    "fullDocumentFrontImage": {
      "id": "6870cabf86000c0943ef2b9",
      "contentType": "image/png",
      "size": 648352
    },
    "fullDocumentBackImage": {
      "id": "6871cabf00067c0943ef2b7",
      "contentType": "image/png",
      "size": 639788
    },
    "faceImage": {
      "id": "6870cabf865f00003ef2b5",
      "contentType": "image/png",
      "size": 153426
    },
    "nationality": "HRV",
    "personalIdNumber": "000000000",
    "documentAdditionalNumber": "00000",
    "issuingAuthority": "EXAMPLE",
    "dateOfExpiryPermanent": false,
    "additionalPersonalIdNumber": "12345",
    "signatureImage": {
      "id": "68abcdbf865f67c00002bb",
      "contentType": "image/png",
      "size": 7664
    },
    "country": "Croatia",
    "documentType": "Id",
    "isoAlpha2CountryCode": "HR",
    "isoAlpha3CountryCode": "HRV",
    "isoNumericCountryCode": 191
  },
  "$type": "BlinkId",
  "workflowStepId": 3,
  "processingStatus": "Complete",
  "verificationStatus": "Accept",
  "createdOn": "2025-07-11T08:26:28.023Z",
  "modifiedOn": "2025-07-11T08:26:28.023Z",
  "completedOn": "2025-07-11T08:26:39.695Z",
  "executionIndex": 1,
  "ruleMatches": [],
  "serviceTraces": []
}

Linked fields​

In addition to the object described above, a subset of this information is propagated in the linkFields object:

curl --url https://api.us-east.platform.microblink.com/agent/api/v1/transaction/<transaction_id> --oauth2-bearer $YOUR_BEARER_TOKEN_HERE | jq .linkFields

This returns something like:

{
  "FirstName": "EXAMPLE",
  "LastName": "EXAMPLE",
  "DateOfBirth": "1991-01-01",
  "DocumentNumber": "123456789",
  "Country": "Croatia",
  "CountryIso3": "HRV",
  "DocumentType": "Id",
  "Address": "EXAMPLE ADDRESS",
  "PersonalIdNumber": "123456789",
  "DocumentFaceImage": {
    "id": "6870cabf865f67abcd13ef2b5",
    "contentType": "image/png",
    "size": 153426
  }
}
Last updated on