Skip to main content

AI PoA Verification

Requirements
AI PoA verification

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/poa-checks/

Request structure​

KeyRequiredTypeExplanation
fileYesStringBase64 encoded document file. Can be: jpeg, jpg, png, gif, webp, heic, heif, pdf files.
providedNameNoStringFull name of the user. It will be compared against the data retrieved from the PoA document if fullName was provided.
providedAddressNoStringAddress of the PoA verification. It will be compared against the data retrieved from the PoA document if address was provided.

Response structure​

id| Type: String
Explanation:

PoA check identifier.

created| Type: String
Explanation:

Timestamp indicating when the PoA check was created.

updated| Type: String
Explanation:

Timestamp indicating when the PoA check was last updated.

issueDate| Type: String
Explanation:

Issue date retrieved from the Proof of Address document.

documentType| Type: String
Explanation:

Type of the document retrieved from the PoA document.

Possible values:

  • UTILITY_BILL
  • BANK_STATEMENT
  • GOVERNMENT_LETTER
  • LEASE_AGREEMENT
hasLogo| Type: Boolean
Explanation:

true if the document contains a company or provider logo; otherwise, false.

nameMatch| Type: Boolean
Explanation:

true if the provided name/surname matches the one on the document; otherwise, false.

addressMatch| Type: Boolean
Explanation:

true if the provided address matches the one on the document; otherwise, false.

dateValid| Type: Boolean
Explanation:

true if the document is not older than 3 months; otherwise, false.

overallStatus| Type: String
Explanation:

Overall result of the comparison.

Possible values:

  • MATCH
  • NO_MATCH
  • NOT_COMPARED
name| Type: String
Explanation:

Full name retrieved from the PoA document.

address| Type: String
Explanation:

Full address retrieved from the PoA document.

partner| Type: Object
Explanation:

Object containing partner environment-related information.

fileType| Type: String
Explanation:

File type of the uploaded document.

Possible values:

  • PDF
  • JPG
  • PNG
providedName| Type: String
Explanation:

Name value that was provided when the check was initiated.

providedAddress| Type: String
Explanation:

Address value that was provided when the check was initiated.

file| Type: String
Explanation:

URL to download the uploaded file.

Request example​

{
  "file": "iVBORw0KGgoAAAANSUhEUgAAAxoAAAC6CAYAAAApyZWVuc2hvdO8Dvz4AAAA[...]",
  "providedName": "John Smith",
  "providedAddress": "4344 Poco Mas Drive, Dallas, FL, 33009"
}

Response example​

{
  "id": "aa4e1453-abc0-4649-84ab-d6a65984329b",
  "created": "2024-10-21T06:10:31.559212Z",
  "updated": "2024-10-21T06:10:31.559246Z",
  "issueDate": "2021-11-15",
  "documentType": "Electricity bill",
  "hasLogo": true,
  "nameMatch": false,
  "addressMatch": true,
  "dateValid": false,
  "overallStatus": "NO_MATCH",
  "name": "Leslie Holden",
  "address": "4344 Poco Mas Drive Dallas, FL, 33009",
  "partner": {
    "id": 2253,
    "created": "2023-10-11T14:09:40.458303Z",
    "companyName": "iDenfy Techsupport TEST",
    "environment": "TESTING",
    "isActive": true
  },
  "fileType": "png",
  "providedName": "John Smith",
  "providedAddress": "4344 Poco Mas Drive, Dallas, FL, 33009",
  "file": "https://s3.eu-west-1.amazonaws.com/[...]"
}