Skip to main content
Scrive logoeID Hub Documentation

Usage

Create a transaction with provider: onfido and method: auth. eID Hub hands the user an Onfido Web SDK session to capture documents and photos, then runs whichever checks you've configured.

Choosing what to check​

Set report to pick the check:

  • document (default) - verify the ID document only.
  • documentFacialSimilarityPhoto - document plus a selfie comparison.
  • documentFacialSimilarityVideo - document plus a video liveness check, where the user reads out loud a set of random numbers.
  • documentFacialSimilarityMotion - document plus Motion, an automated head-turn biometric check. See Onfido Motion.
  • proofOfAddress - verify an address document instead of an ID document. See Proof of address.
  • customWorkflowOutput - hand off to a custom Onfido Studio workflow. See Onfido Studio.

Applicant details​

First name, last name, date of birth, email and country of residence can all be passed up front; Onfido compares them against the document. None of these are required for a basic document check, but first name, last name and address are required for proof of address. You can also restrict which document types or issuing countries are accepted, and require driving licence details or address details to be extracted alongside the standard document fields.

Completion data​

Once checks complete, completion data includes the extracted document fields (name, date of birth, document number, expiry date, issuing country and so on) and, for facial similarity reports, a similarity score between 0 and 1, where 1 is a perfect match. See Onfido parameters.