DOCSEARCHbyAlgolia
Submit Docs

IDnow Trust Platform Documentation

website·Indexed 30 days ago

https://docs.dev1.platform.idnow.dev/

Developer guides and API references for the IDnow Trust Platform. Features include document-based identity verification, eID authentication (including German Personalausweis via AusweisApp and France Identité), European Digital Identity (EUDI) Wallet integration, and global PEP and sanctions screening. The platform provides APIs for session management, PII data block retrieval and deletion, and flow-specific OpenAPI specifications.

Tokens
76.7K
Snippets
239
Records
493
Agent score
49%

What's inside IDnow

  1. Overview of Signing incl. verifying ID (v1)

    The 'Signing incl. verifying ID (v1)' step combines document-based identity verification (IDV) in Capture mode with instant signature issuance. It supports three primary operational modes based on the configured shortname:

    1. VideoIdent with contract signing (VI + eSign): Agent-assisted verification followed by contract signing.
    2. AutoIdent with contract signing (AI + eSign): Automated visual verification followed by contract signing.
    3. AutoIdent with qualified electronic signature (QES): Focuses on AML-compliant IDV where the signature serves as a verification layer rather than a contract signature (no contract provided).

    Note: This version (v1) is deprecated. For current implementations, use Signing incl. verifying ID (v2).

  2. Overview of Identity Verification with Electronic Signature (v3)

    The DOC_ID_SIGNING:v3 step integrates identity verification with electronic signatures. It is a superset of v2, adding an explicit cancelled output route. This allows developers to route cancelled sessions (user-initiated or agent-initiated) to specific steps, such as retry prompts or rejection paths, instead of the session simply aborting with an ABORTED outcome.

  3. Overview of Automated Verification using pre-captured images (Headless mode)

    In Headless mode, the customer's application is responsible for collecting identity evidence (such as images of ID documents) and submitting them to IDnow via API. IDnow performs verification using AI-based analysis and data extraction on these static inputs.

    Important Constraints:

    • Because it relies solely on static images without live interaction, this method provides a more limited level of accuracy.
    • It is not suitable for regulated use cases such as KYC or AML processes.
    • It is best suited for unregulated scenarios, document data extraction, or image quality assessment.
    • This step cannot be combined in the same flow as 'Verifying IBAN - API only (v1)' or 'Verifying proof of address - API only (v1)' as they require different document types.

  4. Overview of Document-Based Identity Verification (Capture Mode)

    Document-based identity verification in Capture mode uses an IDnow-provided frontend to guide users through providing identity evidence. This process includes capturing document images, performing biometric checks (face matching and liveness detection), and optionally reading electronic document chips via NFC. This differs from the Headless approach where the customer collects data in their own frontend. Verification can be performed via automated visual verification (AI), automated NFC verification, or agent-assisted verification.

  5. Overview of Phone Verification (PHONE_VERIFY:v1)

    The PHONE_VERIFY:v1 step verifies that an end-user owns a specific phone number by sending a one-time password (OTP) via SMS. This step has no built-in Player UI; the developer's backend is responsible for presenting the OTP input screen to the user and submitting the response through the sessions API. The step resolves as completed once the code is validated or ends as not_verified when retry attempts are exhausted.

  6. Overview of Identity Verification and Electronic Signing (DocIDV)

    The DocIDV process combines identity verification with electronic signature capabilities. It verifies a user's identity via document analysis, security feature checks, face matching, and liveness detection. Once verified, it issues either a Qualified Electronic Signature (QES) for legally binding signatures under the eIDAS framework or a standard contract signature. The process outputs a unified Verification data block and a signed documents package including the audit trail.

  7. Overview of Document-Based Identity Verification (v4)

    The Document-Based Identity Verification (v4) step verifies identity using secure documents via multiple modes. In Capture mode, the IDnow frontend guides the user through capturing document images, performing biometric checks (face matching and liveness detection), and optionally reading electronic document chips via NFC. It supports automated visual verification (AI-based), automated NFC verification, and agent-assisted expert review.

  8. Overview of Document-Based Identity Verification (v3)

    The Document-Based Identity Verification (v3) step allows users to verify their identity via the IDnow frontend. The process includes capturing document images, performing biometric checks (face matching and liveness detection), and optionally reading electronic document chips via NFC. Verification can be performed through three modes: automated visual verification (AI-driven), automated NFC verification (secure chip reading), or agent-assisted verification (expert review). This step is compliant with eIDAS, AML, GwG, EAA, and BaFin standards.

  9. Overview of Biometric Authentication (v1)

    The Biometric Authentication step provides real-time identity confirmation using a face scan. It prevents impersonation, spoofing, and deepfakes through liveness detection (confirming physical presence) and face comparison (matching the live capture against an enrolled biometric template). This step requires that the user has previously completed the Biometric enrolment (v1) step.

  10. Overview of Headless Signing

    Headless Signing is a backend-only operation used to sign or seal documents instantly without user interaction. It integrates with the Sphinx credential system to issue either Advanced Electronic Signatures (AES) for natural persons or Qualified Electronic Seals (QSEAL) for legal entities. The process is handled server-side via a Temporal workflow that initiates the request, polls for completion, and finalizes the operation.

  11. Overview of IDnow DocIDV identity verification

    The DocIDV service verifies a user's identity by analyzing documents via either a live video session with an agent (VideoIdent) or a fully automated process (AutoIdent). The service uses a redirect-based UX where users are sent to the IDnow web interface. The process resolves via a webhook callback from IDnow, after which the verification report and evidence files are stored in the vault. Results are returned as a DocumentVerification data block.

  12. Overview of eKYC UK identity verification

    The eKYC UK step verifies a person's identity by cross-referencing their data against UK credit bureau and electoral roll sources. It is a headless, server-side process that requires no end-user interaction. The step consumes BasicIdentity and ExtendedIdentity data blocks and returns a tiered corroboration result based on the number of independent sources that successfully match the identity elements.