Idenfy
What kind of data I will get
By using this integration you will be able to verify identity of your customers.
Integration Scope
KYC - An identity verification service is used by businesses to ensure that users or customers provide information that is associated with the identity of a real person.
Input
There are some mandatory fields required for user to run this integration.
Attrribute | Type | Description |
---|---|---|
firstName | string | FIrst name of the user |
lastName | string | Last name of the user |
Input Example
Output
Attribute | Type | Description |
---|---|---|
platform | string | Possible values:
|
status | object | The status of the verification. |
data | object | The data from clients identity document. |
clientIp | string | Client's system IP address |
startTime | number | A timestamp of when a client starts the verification process. |
finishTime | number | A timestamp of when the final decision for automatic processing was made. |
clientIpCountry | string | A country code of the client's system IP address. |
clientLocation | string | Full information available about the client's current location based on the IP address. |
gdcMatch | boolean | Indicates if provided information in additional data matches any entry from global data sources databases. |
manualAddress | string | Client address parsed from utility bill. Only occurs if utility bill was uploaded. |
manualAddressMatch | boolean | Indicates if the document's address matched with the address provided by the partner after the manual check. |
addressVerification | json object | Client's address verification. |
registryCenterCheck | json object | Client's registry center check. |
Status
Attribute | Type | Description |
---|---|---|
overall | string | An overall status of the verification. It is a combination of manual and automatic verification results. Possible values:
|
fraudTags | array<string> | A list of fraud tags (strings) indicating why verification was
|
mismatchTags | array<string> | A list of mismatch tags (strings) indicating where partner provided document information does not match with the read information. Possible values:
|
autoFace | string | An automatic face analysis result (decision made by an automated platform). Possible values:
|
manualFace | string | A Final face analysis result (decision made by a automatic system and human). Possible values:
|
autoDocument | string | An automatic document analysis result (decision made by an automated platform). Possible values:
|
manualDocument | string | Final document analysis result (decision made by a automatic system and human). Possible values:
|
additionalSteps | string | An additional steps result (decision made by human). Possible values:
|
Data
Attribute | Type | Description |
---|---|---|
docFirstName | string | Clients name from the document. |
docLastName | string | Clients surname from the document. |
docNumber | string | Clients document number from the document. |
docPersonalCode | string | Clients personal code from the document. |
docExpiry | string | Clients document expiry date from the document. |
docDob | string | Clients date of birth from the document. |
docDateOfIssue | string | Clients date of issue from the document. |
docType | string | Clients used document type to complete verification. Possible values:
|
docSex | string | Clients sex from the document. Possible values:
|
docNationality | string | Clients nationality from the document. |
docIssuingCountry | string | Clients documents issuing country from the document. |
docTemporaryAddress | string | Clients temporary address from the document. |
docBirthName | string | Clients birth name from the document. |
docBirthPlace | string | Clients birth place from the document. |
authority | string | The authority of the document from the document. |
address | string | Clients address from the document. |
mothersMaidenName | string | Clients mothers maiden name from the document. |
driverLicenseCategory | string | Clients driving license categories (classes) from the document. |
manuallyDataChanged | boolean | Indicates whether a manual reviewer has changed any parsed data from the document. |
fullName | string | Clients full name parsed from the document. |
selectedCountry | string | Country which was selected in verification process. |
orgFirstName | string | Client name from the document in original language. |
orgLastName | string | Client surname from the document in original language. |
orgNationality | string | Client nationality from the document in original language. |
orgBirthPlace | string | Client birth place from the document in original language. |
orgAuthority | string | Client document authority categories from the document in original language. |
orgAddress | string | Client address from the document in original language. |
orgTemporaryAddress | string | Client temporary address from the document in original language. |
orgMothersMaidenName | string | Clients mothers maiden name from the document in original language. |
orgBirthName | string | Client birth name parsed from the document in original language. |
ageEstimate | string | Client age detected from selfie when liveness is on. Possible values:
|
clientIpProxyRiskLevel | string | Client's IP address proxy risk level. Possible values:
|
duplicateFaces | array<string> | Indicates if other clients which selfie faces were matched with this one's verification. |
duplicateDocFaces | array<string> | Indicates if other clients which document faces were matched with this one's verification. |
additionalData | string | Additional data provided alongside any additionalSteps, for example - Social Security Number in |
Example Output
Last updated