Overview

Use this method to get the PoA check results based on the data from the provided PoA documents.

The Sumsub service has an additional feature that can identify the type of the issuing company for the proof of address that you provide us with, as well as its subtype.

Response explained

The response is a JSON file that contains a list of PoA checks and detailed check results.

Root variables

Root variables are the core PoA check results data items. Some of them may include nested attributes and element fields.

Field	Type	Description
`answer`	String	Answer on overall PoA check: `RED` — at least one of the checks returned a high risk indication. `YELLOW` — all checks ended up with no certain data found. `GREEN` — at least one of the PoA checks ended up green with no high risk indication; some `YELLOW` results are acceptable.
`checkType`	String	Indicates that it is a `POA` check type: `POA` — for the `PROOF_OF_RESIDENCE` step of the verification level. `POA2` — for the `PROOF_OF_RESIDENCE2` step.
`createdAt`	Date	Date and time (UTC) of the latest PoA check.
`id`	String	Unique identifier of the check.
`inputDoc`	Object	Represents the data used for the TIN check.
`poaCheckInfo`	Object	Includes PoA check results.

`inputDoc` attributes

The following table explains the inputDoc attributes representing the data taken from the provided document.

Field	Type	Description
`idDocType`	String	A type of the document provided for verification. For example, `UTILITY_BILL`, `TAX_BILL`, `PASSPORT`, `DRIVERS`.
`country`	String	Alpha-3 country code. For example, `DEU`, `GBR`, `ARG`.
`firstName`	String	Applicant first name as stated in the document.
`firstNameEn`	String	Automatic transliteration of the applicant first name into Latin.
`middleName`	String	Applicant middle name as stated in the document.
`middleNameEn`	String	Automatic transliteration of the applicant middle name into Latin.
`lastName`	String	Applicant last name as stated in the document.
`lastNameEn`	String	Automatic transliteration of the applicant last name into Latin.
`issuedDate`	Date	The date when the PoA document was issued (format `YYYY-MM-DD`).
`number`	String	TIN document number.
`dob`	Date	Applicant date of birth specified in the provided document.
`address`	Object	The address details specified in the provided document.

`address` attributes

The following table explains the address attributes containing the applicant address details available in the provided document.

Field	Type	Description
`street`	String	The street where the applicant lives and/or is registered.
`streetEn`	String	Automatic transliteration of the applicant street into Latin.
`subStreet`	String	Additional information related to the applicant street. This could be a house number or any other details.
`state`	String	The state, region, district, county or another territorial entity inside a country, if applicable.
`stateEn`	String	Automatic transliteration of the applicant state, region, district, county, or another territorial entity inside a country into Latin.
`buildingNumber`	String	Building number.
`town`	String	The city, town, or another settlement where the applicant lives and/or is registered.
`townEn`	String	Automatic transliteration of the city, town, or another settlement where the applicant lives and/or is registered into Latin.
`postCode`	String	Address postal code.
`country`	String	Alpha-3 country code. For example, `DEU`, `GBR`, `ARG`.
`formattedAddress`	String	Address in an human-readable format.

`poaCheckInfo` attributes

The following table describes the poaCheckInfo attributes representing the PoA checks results.

Field	Type	Description
`answer`	String	PoA check answer (`RED`, `YELLOW`, `GREEN`).
`unexpired`	String	Shows if the PoA document is still valid or already expired: `GREEN` — valid. `YELLOW` — no expiry date on the document. `RED` — expired.
`acceptableType`	String	Shows if the document can be accepted as PoA: `GREEN` — acceptable. `YELLOW` — no certain data on the document. `RED` — unacceptable.
`validAddress`	String	Shows if the address is valid and matches the one provided by the applicant: `GREEN` — valid and confirmed. `YELLOW` — no address found or it cannot be confirmed. `RED` — invalid address or it does not match the one provided by the applicant.
`poiAsPoa`	Boolean	Indicates if an identity document was used as a PoA document (`true`) or not (`false`).
`companyContact`	Object	Represents the PoA document issuer and the subtype of the document accepted as a proof of address.

Available values for `companyContact.type` and `.subType`

The following table lists the available values for the companyContact.type and .subType attributes that represent the PoA issuers and document types, respectively.

Refer to Set document types for detailed description.

PoA issuer (`companyContact.type`)	Document type (`.subType`)
`governmentOrganization`	`statement`, `voterRegistration`, `taxBill`, `other`.
`utilityProvider`	`utilityBill`, `telecom`, `other`.
`bank`	`bankStatement`/`bankLetter`/`other`.
`mobileOperator`	—
`other`	`lease`, `other`.

Overview

Response explained

Root variables

inputDoc attributes

address attributes

poaCheckInfo attributes

Available values for companyContact.type and .subType

`inputDoc` attributes

`address` attributes

`poaCheckInfo` attributes

Available values for `companyContact.type` and `.subType`