Skip to main content

Verifying ID document (IDC) (v5)

Preview / Alpha

This version of this step type is in preview / alpha. The functionality and subsequently the documentation can still change.
The stable / GA version of this step is Verifying ID document (IDC) (v3)

End-to-end identity verification with one or more identity documents (v5)​

Verifies identity using secure identity documents through multiple verification modes, adapted to business and regulatory needs.

With this step, the end user completes verification through the IDnow frontend, which guides them step by step in providing the required identity evidence. This includes capturing document images, performing biometric checks (such as face matching and liveness detection), and optionally reading electronic document chips via NFC.

Unlike earlier versions, a v5 session captures one to five identity documents in a single onboarding (up to four when biometric samples are requested), each configured through documentsToCapture. The verification outcome is the CIS file verdict: IDcheck compares every captured document against the others — same holder, data consistency — and against the selfie, and aggregates the result into the file verdict.


Key features​

  • Multi-document capture — Up to five identity documents in one onboarding, or up to four when biometric samples are requested: the verification service rejects a fifth document configured together with biometrics. Entry 0 of documentsToCapture is required; entries 1-4 may be optional, and a skipped optional document does not fail the step.
  • File-level verdict — The outcome is decided by the IDcheck file verdict, which cross-checks every captured document against the others and against the selfie.
  • Per-document outputs — Every captured document produces a full block set: BasicIdentity, ExtendedIdentity, DocumentData and DocumentImages. The primary document (entry 0) is emitted under the type-named keys; the others under ordinal aliases.
  • Full data set on rejection and fraud — not_verified and fraud_detected carry every extractable document so the rejection can be reviewed.
  • Automated visual verification - AI-based analysis of ID document authenticity, integrity, and visual security features.
  • Automated NFC verification - Secure reading and validation of embedded NFC chips in electronic identity documents.
  • Agent-assisted verification - Expert review for complex, regulated, or escalated cases both in Autoident and VideoIdent products.
  • Explicit cancellation routing: When enableCancellation: true, cancelled sessions (user-initiated or agent-initiated) exit via the cancelled route and can have a dedicated routing.

Configuration​

OptionTypeRequiredDefaultDescription
inputSourcesobjectNo—Specifies the workflow step IDs to use for sourcing data. If omitted, the step will use the latest available data blocks from the workflow.
documentsToCaptureobject[]No[{"code":"DOC1","docTypes":["ID","P"],"optional":false}]The identity documents to capture, in order. Entry 0 is the primary document: its blocks are emitted under the type-named keys and flow downstream normally. Entries 1-4 are emitted as alias outputs (basicIdentityTwo … basicIdentityFive) that appear in session results automatically; later steps consume them only via the long { step, alias } input-mapping form.
captureobjectYes—Capture configuration including biometric sample types and consent handling.
configobjectYes—Environment-specific configuration.
handoffbooleanNofalseWhen true, redirects the player immediately on manual review trigger and resumes polling in the background.
enableCancellationbooleanNofalseWhen true, cancelled sessions exit via the cancelled route. When false (default), the session immediately ends with an ABORTED outcome.

Specifies the workflow step IDs to use for sourcing data. If omitted, the step will use the latest available data blocks from the workflow.

OptionTypeRequiredDescription
basicIdentitystringNoThe ID of the step providing the BasicIdentity data block.
extendedIdentitystringNoThe ID of the step providing the ExtendedIdentity data block.

Capture configuration including biometric sample types and consent handling.

OptionTypeRequiredDefaultDescription
biometricSampleTypesstring[]Yes—List of biometric sample types. Accepted values: SELFIE, VIDEO.
biometricConsentHandlingstringNo"SDK"How biometric consent is handled during capture. Accepted values: SDK, CUSTOMER.

Environment-specific configuration.

OptionTypeRequiredDescription
liveobjectYes
stagingobjectYes
config.live
OptionTypeRequiredDescription
realmstringYesThe realm identifier for the document verification service. Provided by IDnow during onboarding.
config.staging
OptionTypeRequiredDescription
realmstringYesThe realm identifier for the document verification service. Provided by IDnow during onboarding.

Example configuration​

Single document

{
"documentsToCapture": [
{
"code": "DOC1",
"docTypes": ["ID", "P"]
}
],
"capture": {
"biometricSampleTypes": ["SELFIE"]
},
"config": {
"live": { "realm": "your-live-realm" },
"staging": { "realm": "your-staging-realm" }
}
}

Three documents, two of them optional

{
"documentsToCapture": [
{
"code": "PASSPORT",
"docTypes": ["P"],
"label": "Passport",
"description": "Please capture the machine-readable page."
},
{
"code": "PERMIT",
"docTypes": ["RP"],
"optional": true
},
{
"code": "DRIVING_LICENCE",
"docTypes": ["DL"],
"optional": true,
"versoHandling": "MANDATORY"
}
],
"capture": {
"biometricSampleTypes": ["SELFIE"],
"biometricConsentHandling": "CUSTOMER"
},
"config": {
"live": { "realm": "your-live-realm" },
"staging": { "realm": "your-staging-realm" }
}
}

Input data blocks​

Data blockRequiredDescription
BasicIdentityNoPre-filled identity data to associate with the verification.
ExtendedIdentityNoExtended identity data to associate with the verification.

Routes​

RouteDescription
verifiedSuccessful document processing with identity extraction. The CIS file verdict decides; CIS compares every captured document against the others (same holder, data consistency) and against the selfie. Each captured document produces a full block set: the primary (entry 0 of documentsToCapture) under the type-named keys, the others as ordinal aliases (basicIdentityTwo, …).
not_verifiedDocument verification failed. The full per-document data set is emitted for review — the primary under the type-named keys, the extras as ordinal aliases — with every identity slot optional, because a rejected session can lack extractable data. Downstream short-form consumers must tolerate a missing identity.
fraud_detectedFraud detected on the file. The full per-document data set is emitted for review — the primary under the type-named keys, the extras as ordinal aliases — with every identity slot optional, because a fraudulent session can lack extractable data. Downstream short-form consumers must tolerate a missing identity.
cancelledAvailable only when enableCancellation is true. User or agent cancelled the step; the end user can be routed to retry or a different step. For user-initiated and agent-initiated cancellations, only Verification is emitted. When a route configured with type: rollback redirects to cancelled, identity data blocks extracted up to that point may also be present (best-effort); DocumentImages only when processable images were returned.
Wire Cancellation with Retry prompt (v1)

In case of cancellation - triggered by enduser or by agent - we recommend connecting this route to the Retry prompt (v1). So that the user may confirm to retry and go through the step again.


Output data blocks​

RouteOutput aliasData blocks produced
verifiedbasicIdentity — BasicIdentity (required): Extracted identity of the document holder. This is the primary document (entry 0 of documentsToCapture).
extendedIdentity — ExtendedIdentity (required): Extended identity attributes of the document holder. This is the primary document (entry 0 of documentsToCapture).
documentData — DocumentData (required): Fields read from the document (MRZ, expiry, document number, …). This is the primary document (entry 0 of documentsToCapture).
documentImages — DocumentImages (required): Front and back images of the document. This is the primary document (entry 0 of documentsToCapture).
verification — Verification (required)
BasicIdentity, ExtendedIdentity, DocumentData, DocumentImages, Verification
conditionally:
BiometricSamples (only when capture.biometricSampleTypes is non-empty)
not_verifiedbasicIdentity — BasicIdentity (optional): Extracted identity of the document holder. This is the primary document (entry 0 of documentsToCapture).
extendedIdentity — ExtendedIdentity (optional): Extended identity attributes of the document holder. This is the primary document (entry 0 of documentsToCapture).
documentData — DocumentData (optional): Fields read from the document (MRZ, expiry, document number, …). This is the primary document (entry 0 of documentsToCapture).
documentImages — DocumentImages (optional): Front and back images of the document. This is the primary document (entry 0 of documentsToCapture).
verification — Verification (required)
BasicIdentity, ExtendedIdentity, DocumentData, DocumentImages, Verification
conditionally:
BiometricSamples (only when capture.biometricSampleTypes is non-empty)
fraud_detectedbasicIdentity — BasicIdentity (optional): Extracted identity of the document holder. This is the primary document (entry 0 of documentsToCapture).
extendedIdentity — ExtendedIdentity (optional): Extended identity attributes of the document holder. This is the primary document (entry 0 of documentsToCapture).
documentData — DocumentData (optional): Fields read from the document (MRZ, expiry, document number, …). This is the primary document (entry 0 of documentsToCapture).
documentImages — DocumentImages (optional): Front and back images of the document. This is the primary document (entry 0 of documentsToCapture).
verification — Verification (required)
BasicIdentity, ExtendedIdentity, DocumentData, DocumentImages, Verification
conditionally:
BiometricSamples (only when capture.biometricSampleTypes is non-empty)
cancelled—Verification
Available only when enableCancellation is true.

Multi-identity outputs​

Each captured document produces a full block set. The primary document's (entry 0) blocks are emitted under the type-named keys and flow downstream to later steps as usual. Every extra captured document produces the same four blocks under an ordinal alias, fixed by the document's position in documentsToCapture:

PositionIdentityExtended identityDocument dataDocument images
0 (primary)basicIdentityextendedIdentitydocumentDatadocumentImages
1basicIdentityTwoextendedIdentityTwodocumentDataTwodocumentImagesTwo
2basicIdentityThreeextendedIdentityThreedocumentDataThreedocumentImagesThree
3basicIdentityFourextendedIdentityFourdocumentDataFourdocumentImagesFour
4basicIdentityFiveextendedIdentityFivedocumentDataFivedocumentImagesFive

Aliases are not resolved by the default input source selection or the short inputMapping form; a later step consumes them through the long form ({ "step": "<stepId>", "alias": "<outputAlias>" }, see Output aliases). They appear in the session results automatically under their alias key — no configuration is needed. A skipped optional document has no alias.

Review routes carry optional identities

On the not_verified and fraud_detected routes, the full per-document data set is emitted so the rejection can be reviewed — but every identity block is optional there, because a rejected or fraudulent session can legitimately lack extractable data. Downstream steps must tolerate a missing identity on these routes.

Step compatibility

The DocumentImages produced by this step are ID-category images (passport, driving licence, etc.). They cannot be used as input to Verifying IBAN - API only (v1) or Verifying proof of address - API only (v1), which require bank or address documents respectively.

This data block carries evidence artefacts under methods[].evidence[]. This Step can produce the following evidence types, each present only when the corresponding artefact is available:

  • documentFrontRecording,
  • documentBackRecording,
  • livenessRecording,
  • documentFrontOriginalImage,
  • documentBackOriginalImage,
  • analysisReport

When the step does not complete, the Verification data block's terminationReason.code says why. See Verification reason codes for every code this step can return.

Example payloads​

BasicIdentity — verified
{
"givenName": "Jean",
"familyName": "Dupont",
"name": "Jean Dupont",
"birthDate": "1985-03-22",
"birthPlace": "Paris"
}
ExtendedIdentity — verified
{
"portrait": {
"$ref": "vault",
"$id": "020ff369-43d8-4b8a-94e7-6814c0bdc35a"
},
"nationality": "FRA",
"personalAdministrativeNumber": null,
"familyNameBirth": "Dupont",
"givenNameBirth": "Jean",
"sex": 1,
"emailAddress": null,
"mobilePhoneNumber": null,
"residentAddress": null,
"residentStreet": null,
"residentHouseNumber": null,
"residentHouseName": null,
"residentCountry": null,
"residentState": null,
"residentCity": null,
"residentPostalCode": null
}
DocumentData — verified
{
"documentType": "ID",
"documentNumber": "D123456789",
"expiryDate": "2030-06-15",
"issuanceDate": "2020-06-15",
"issuingCountry": "DE",
"issuingAuthority": "Bürgeramt Berlin"
}
Verification — verified
{
"status": "verified",
"terminationReason": null,
"methods": [
{
"type": "documentCheck",
"checks": [
{
"technique": "documentValidity",
"sources": [],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
},
{
"technique": "electronicRecord",
"sources": [
{
"type": "internalRegister",
"id": null
}
],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
},
{
"technique": "dataCrosscheck",
"sources": [
{
"type": "mrz",
"id": null
},
{
"type": "ocr",
"id": null
}
],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
},
{
"technique": "securityFeatures",
"sources": [],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
},
{
"technique": "faceMatch",
"sources": [],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
}
],
"evidence": [
{
"type": "documentFrontOriginalImage",
"ref": {
"$ref": "vault",
"$id": "3f8a1c2e-7a4b-4d91-8c62-f1a9237e6d05"
}
},
{
"type": "documentBackOriginalImage",
"ref": {
"$ref": "vault",
"$id": "7b2d9e4a-2c8f-4e17-9d53-b6e08a41c792"
}
},
{
"type": "analysisReport",
"ref": {
"$ref": "vault",
"$id": "c1e6f0b8-9d42-4f6a-8e77-3b5c1d90ae14"
}
}
]
}
],
"provider": "idnow",
"trustFramework": null,
"assuranceLevel": null,
"verifiedAt": "2026-02-10T14:00:01.000Z",
"verificationProcessId": "d59cf1d1-d715-406e-ba47-4027fb8918f0"
}
Verification — not_verified
{
"status": "rejected",
"terminationReason": null,
"methods": [
{
"type": "documentCheck",
"checks": [
{
"technique": "documentValidity",
"sources": [],
"outcome": "failed",
"issues": [
{
"code": "DOC_EXPIRATION_DATE",
"severity": "error",
"message": "There are some warnings concerning the document expiration date"
}
],
"performedBy": null,
"performedAt": null
},
{
"technique": "dataCrosscheck",
"sources": [
{
"type": "mrz",
"id": null
},
{
"type": "ocr",
"id": null
}
],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
},
{
"technique": "securityFeatures",
"sources": [],
"outcome": "passed",
"issues": [],
"performedBy": null,
"performedAt": null
},
{
"technique": "agentReview",
"sources": [],
"outcome": null,
"issues": [],
"performedBy": null,
"performedAt": null
}
],
"evidence": [
{
"type": "analysisReport",
"ref": {
"$ref": "vault",
"$id": "7634dfe5-8dda-43d9-927a-4f69c4be84ca"
}
},
{
"type": "documentFrontOriginalImage",
"ref": {
"$ref": "vault",
"$id": "e7389b6a-2d05-4a8f-9920-e47798c9f919"
}
},
{
"type": "documentBackOriginalImage",
"ref": {
"$ref": "vault",
"$id": "71541e7d-e1dc-4826-a700-8c606f4e2dd3"
}
}
]
}
],
"provider": "idnow",
"trustFramework": null,
"assuranceLevel": null,
"verifiedAt": "2026-02-10T14:05:30.000Z",
"verificationProcessId": "3a128c6d-4960-45fd-b4d1-5922f44a61be"
}