Skip to main content
POST
/
api
/
v2
/
poa-checks
/
cURL
curl --request POST \
  --url https://ivs.idenfy.com/api/v2/poa-checks/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": "aSDinaTvuI8gbWludGxpZnk=",
  "providedName": "<string>",
  "providedAddress": "<string>"
}
'
{
  "file": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "issueDate": "2023-12-25",
  "documentType": "<string>",
  "hasLogo": true,
  "isScreenshot": true,
  "nameMatch": true,
  "addressMatch": true,
  "dateValid": true,
  "name": "<string>",
  "address": "<string>",
  "orgName": "<string>",
  "orgAddress": "<string>",
  "documentTypeSupported": true,
  "countrySupported": true,
  "providedName": "<string>",
  "providedAddress": "<string>"
}

Authorizations

​
Authorization
string
header
required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Body

application/json
​
file
string<byte>
required

Base64 encoded document file. Can be: jpeg, jpg, png, webp, heic, heif, pdf files.

​
providedName
string | null
Maximum string length: 255
​
providedAddress
string | null
Maximum string length: 255

Response

201 - application/json
​
file
string<uri>
required

Base64 encoded document file. Can be: jpeg, jpg, png, webp, heic, heif, pdf files.

​
id
string<uuid>
required
read-only
​
created
string<date-time>
required
read-only
​
issueDate
string<date> | null
required
read-only
​
documentType
string | null
required
read-only
​
country
enum<string>
required
Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
CV,
KH,
CM,
CA,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
CD,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
XK,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
KP,
MK,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
KR,
SS,
ES,
LK,
SD,
SR,
SJ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
UM,
US,
UY,
UZ,
VU,
VA,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
​
hasLogo
boolean | null
required
read-only
​
isScreenshot
boolean | null
required
read-only
​
nameMatch
boolean | null
required
read-only
​
addressMatch
boolean | null
required
read-only
​
dateValid
boolean | null
required
read-only
​
overallStatus
enum<string>
required
Available options:
MATCH,
NO_MATCH,
NOT_COMPARED
​
name
string | null
required
read-only
​
address
string | null
required
read-only
​
orgName
string | null
required
read-only
​
orgAddress
string | null
required
read-only
​
documentTypeSupported
boolean | null
required
read-only
​
countrySupported
boolean | null
required
read-only
​
providedName
string | null
Maximum string length: 255
​
providedAddress
string | null
Maximum string length: 255