Proof of Address
Start here
This is an introductory guide and overview for the Proof of Address report, and contains advice on results logic.
You'll find API documentation separately.
Introduction
The Proof of Address (PoA) report enables the capture and/or upload of documents via mobile, desktop and cross device through the Web SDK (capture and upload) or API (upload). The PoA solution allows users to upload PoA documents from anywhere in the world. Currently, the Onfido platform can only process UK PoA documents.
Overall result logic
The PoA report can return a result of clear
or consider
or null
.
The overall report result will be clear
if all of the following are true:
- the quality of the provided PoA document is sufficient to process it
- the provided PoA document is a supported UK PoA document
- the data provided by the applicant matches the data that is on their PoA document
The overall report result will be null
if any of the following is true:
- the
issuing_country
field set when uploading the document is from an unsupported country (i.e. it is different from "GBR") - the
issuing_country
field is not provided when uploading the document
Please note that if the report result is null
, the report status will be cancelled
.
The overall report result will be consider
if any of the following is true:
- the document was not of sufficient quality to be processed (e.g. image blurred, data points not visible on the document). In this scenario, the value of the
image_quality
breakdown (which is part of theimage_integrity
breakdown) will beunidentified
and no data will be extracted from the document, hence the report properties attribute will be empty and all the other breakdowns will benull
- the document is not a valid UK PoA document: in this scenario the value of the
supported_document
breakdown (which is part of thedocument_classification
breakdown) will beunidentified
, no data will be extracted from the document, hence the report properties attribute will be empty and the data comparison breakdowns will be set tonull
- the data provided by the applicant does not match the data extracted from the PoA document. In this scenario the breakdowns
first_name
,last_name
andaddress
(which are part of thedata_comparison
breakdown) will have a value ofunidentified
. Data is extracted from the document and returned as part of the report properties attribute.