Skip to main content
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. Supported formats: jpeg, jpg, png, gif, webp, heic, heif, pdf.
providedNameNoStringFull name of the user. Will be compared against the data retrieved from the PoA document.
providedAddressNoStringAddress for verification. Will be compared against the data retrieved from the PoA document.

​
Response structure

KeyTypeExplanation
idStringPoA check identifier.
createdStringTimestamp indicating when the PoA check was created.
updatedStringTimestamp indicating when the PoA check was last updated.
issueDateStringIssue date retrieved from the Proof of Address document.
documentTypeStringType of document. Possible values: UTILITY_BILL, BANK_STATEMENT, GOVERNMENT_LETTER, LEASE_AGREEMENT.
hasLogoBooleantrue if the document contains a company or provider logo; otherwise false.
nameMatchBooleantrue if the provided name matches the one on the document; otherwise false.
addressMatchBooleantrue if the provided address matches the one on the document; otherwise false.
dateValidBooleantrue if the document is not older than 3 months; otherwise false.
overallStatusStringOverall result of the comparison. Possible values: MATCH, NO_MATCH, NOT_COMPARED.
nameStringFull name retrieved from the PoA document.
addressStringFull address retrieved from the PoA document.
partnerObjectObject containing partner environment-related information.
fileTypeStringFile type of the uploaded document. Possible values: PDF, JPG, PNG.
providedNameStringName value that was provided when the check was initiated.
providedAddressStringAddress value that was provided when the check was initiated.
fileStringURL 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/[...]"
}