Get PoA check results

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.

FieldTypeDescription
answerStringAnswer 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.
checkTypeStringIndicates 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.
createdAtDateDate and time (UTC) of the latest PoA check.
idStringUnique identifier of the check.
inputDocObjectRepresents the data used for the TIN check.
poaCheckInfoObjectIncludes PoA check results.

inputDoc attributes

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

FieldTypeDescription
idDocTypeStringType of the document provided for verification. For example, UTILITY_BILL, TAX_BILL, PASSPORT, DRIVERS.
countryStringAlpha-3 country code. For example, DEU, GBR, ARG.
firstNameStringApplicant first name as stated in the document.
firstNameEnStringAutomatic transliteration of the applicant first name into Latin.
middleNameStringApplicant middle name as stated in the document.
middleNameEnStringAutomatic transliteration of the applicant middle name into Latin.
lastNameStringApplicant last name as stated in the document.
lastNameEnStringAutomatic transliteration of the applicant last name into Latin.
issuedDateDateDate when the PoA document was issued (format YYYY-MM-DD).
numberStringTIN document number.
dobDateApplicant date of birth specified in the provided document.
addressObjectAddress 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.

FieldTypeDescription
streetStringStreet where the applicant lives and/or is registered.
streetEnStringAutomatic transliteration of the applicant street into Latin.
subStreetStringAdditional information related to the applicant street. This could be a house number or any other details.
stateStringState, region, district, county or another territorial entity inside a country, if applicable.
stateEnStringAutomatic transliteration of the applicant state, region, district, county, or another territorial entity inside a country into Latin.
buildingNumberStringBuilding number.
townStringCity, town, or another settlement where the applicant lives and/or is registered.
townEnStringAutomatic transliteration of the city, town, or another settlement where the applicant lives and/or is registered into Latin.
postCodeStringAddress postal code.
countryStringAlpha-3 country code. For example, DEU, GBR, ARG.
formattedAddressStringAddress in a human-readable format.

poaCheckInfo attributes

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

FieldTypeDescription
answerStringPoA check answer (RED, YELLOW, GREEN).
unexpiredStringShows if the PoA document is still valid or already expired:

  • GREEN — valid.
  • YELLOW — no expiry date on the document.
  • RED — expired.
acceptableTypeStringShows if the document can be accepted as PoA:

  • GREEN — acceptable.
  • YELLOW — no certain data on the document.
  • RED — unacceptable.
validAddressStringShows 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.
poiAsPoaBooleanIndicates if an identity document was used as a PoA document (true) or not (false).
companyContactObjectRepresents 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)
governmentOrganizationstatement, voterRegistration, taxBill, other.
utilityProviderutilityBill, telecom, other.
bankbankStatement/bankLetter/other.
mobileOperator
otherlease, other.
Language
Credentials
Header
Click Try It! to start a request and see the response here!