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:
|
checkType | String | Indicates that it is a POA check type:
|
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
inputDoc
attributesThe following table explains the inputDoc
attributes representing the data taken from the provided document.
Field | Type | Description |
---|---|---|
idDocType | String | 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 | 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 | Address details specified in the provided document. |
address
attributes
address
attributesThe following table explains the address
attributes containing the applicant address details available in the provided document.
Field | Type | Description |
---|---|---|
street | String | 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 | 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 | 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 a human-readable format. |
poaCheckInfo
attributes
poaCheckInfo
attributesThe 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:
|
acceptableType | String | Shows if the document can be accepted as PoA:
|
validAddress | String | Shows if the address is valid and matches 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
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 . |