Supporting documents
Yoti offers the ability to request additional documents to enhance the verification of the user. You can request this on its own as part of a new session or include in your current session.
Please see our document comparison feature to compliment supporting documents.
Currently Yoti supports the ability to upload a:
- Utility bill
- Council tax bill
- Phone bill
- Bank statement
const supportingDocumentObjective = new ProofOfAddressObjectiveBuilder().build();const supportingDocument = new RequiredSupplementaryDocumentBuilder() .withObjective(supportingDocumentObjective) .build();const sessionSpec = new SessionSpecificationBuilder() // ... .withRequiredDocument(supportingDocument) // ... .build();Text Extraction
A request to obtain the data printed visually on a document, in structured form. If machine data extraction is not successful, there is an option (selected at session creation) to fall back to manual data extraction. This generates a ‘text data check’ automatically.
const supportingDocumentDataExtraction = new RequestedSupplementaryDocTextExtractionTaskBuilder() .withManualCheckFallback() .build();const sessionSpec = new SessionSpecificationBuilder() // ... .withRequestedTask(supportingDocumentDataExtraction) // ... .build();| Manual Data extraction | Description |
|---|---|
| withManualCheckFallback | This will initiate manual data extraction only if the automatic extraction fails. We strongly recommend this option. |
| withManualCheckNever | If the ID fails on automatic extraction, Yoti will not attempt manual extraction and will return a failure in the report. |
| withManualCheckAlways | The document is always referred for manual review at Yoti's Security Centre, regardless of whether machine data extraction has succeeded or failed. |
Filtering documents
You can filter documents by country or by document type.
const supportingDocument = new RequiredSupplementaryDocumentBuilder() .withObjective(supportingDocumentObjective) .withCountryCodes(["GBR","USA"]) .withDocumentTypes(["UTILITY_BILL"]) .build();Document comparison check
For requesting one ID document and one supporting document from the user please see below for configuration:
const documentComparisonCheck = new RequestedIdDocumentComparisonCheckBuilder().build();const sessionSpec = new SessionSpecificationBuilder() // ... .withRequestedCheck(documentComparisonCheck) // ... .build();Yoti will check and compare the following user data and provide you with a sub check result:
- Name
- Date of birth