Links

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

{
"firstName": "Jan",
"lastName": "Kowalski"
}

Output

Attribute
Type
Description
platform
string
Possible values:
  • PC
  • MOBILE
  • TABLET
  • MOBILE_APP
  • MOBILE_SDK
  • OTHER
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:
  • APPROVED
  • DENIED
  • SUSPECTED
  • EXPIRED
fraudTags
array<string>
A list of fraud tags (strings) indicating why verification was SUSPECTED. Possible values:
  • FACE_SUSPECTED
  • FACE_BLACKLISTED
  • DOC_FACE_BLACKLISTED
  • DOC_MOBILE_PHOTO
  • DEV_TOOLS_OPENED
  • DOC_PRINT_SPOOFED
  • FAKE_PHOTO
  • AML_SUSPECTION
  • AML_FAILED
  • LID_SUSPECTION
  • LID_FAILED
  • UTILITY_ADDRESS_CHECK_FAILURE
  • VIRTUAL_CAMERA
  • FACE_IN_BLACKLIST
  • DOC_FACE_IN_BLACKLIST
  • DUPLICATE_FACE
  • DUPLICATE_DOC_FACE
mismatchTags
array<string>
A list of mismatch tags (strings) indicating where partner provided document information does not match with the read information. Possible values:
  • NAME
  • SURNAME
  • DOCUMENT_NUMBER
  • PERSONAL_CODE
  • EXPIRY_DATE
  • DATE_OF_BIRTH
  • DATE_OF_ISSUE
  • FULL_NAME
  • UNDER_AGE
  • UNKNOWN_AGE
  • SEX -NATIONALITY
  • INVALID_ADDITIONAL_STEP
  • ADDITIONAL_STEP_NOT_FOUND
  • GDC_NOT_MATCH
  • DOC_INFO_MISMATCH
  • ADDITIONAL_STEP_INFORMATION_MISMATCH
  • EXPIRED_ADDITIONAL_STEP_INFORMATION
autoFace
string
An automatic face analysis result (decision made by an automated platform). Possible values:
  • FACE_MATCH
  • FACE_MISMATCH
  • NO_FACE_FOUND
  • TOO_MANY_FACES
  • FACE_TOO_BLURRY
  • FACE_GLARED
  • FACE_UNCERTAIN
  • FACE_NOT_ANALYSED
  • FACE_NOT_CHECKED
  • FACE_ERROR
  • AUTO_UNVERIFIABLE
  • FAKE_FACE
  • null
manualFace
string
A Final face analysis result (decision made by a automatic system and human). Possible values:
  • FACE_MATCH
  • FACE_MISMATCH
  • NO_FACE_FOUND
  • TOO_MANY_FACES
  • FACE_UNCERTAIN
  • FAKE_FACE
autoDocument
string
An automatic document analysis result (decision made by an automated platform). Possible values:
  • DOC_VALIDATED
  • DOC_INFO_MISMATCH
  • DOC_NOT_FOUND
  • DOC_NOT_FULLY_VISIBLE
  • DOC_NOT_SUPPORTED
  • DOC_FACE_NOT_FOUND
  • DOC_TOO_BLURRY
  • DOC_GLARED
  • DOC_FACE_GLARED
  • MRZ_NOT_FOUND
  • MRZ_OCR_READING_ERROR
  • BARCODE_NOT_FOUND
  • DOC_EXPIRED
  • COUNTRY_MISMATCH
  • DOC_TYPE_MISMATCH
  • DOC_SIDE_MISMATCH
  • DOC_DAMAGED
  • DOC_FAKE
  • DOC_ERROR
  • AUTO_UNVERIFIABLE
  • DOC_NOT_ANALYSED
  • DOC_NAME_ERROR
  • DOC_SURNAME_ERROR
  • DOC_EXPIRY_ERROR
  • DOC_DOB_ERROR
  • DOC_PERSONAL_NUMBER_ERROR
  • DOC_NUMBER_ERROR
  • DOC_DATE_OF_ISSUE_ERROR
  • DOC_SEX_ERROR
  • DOC_NATIONALITY_ERROR
  • COUNTRY_NOT_SUPPORTED
  • DOC_PERSONAL_CODE_INVALID
  • DOC_SPOOF_DETECTED
  • MRZ_INVALID
  • DOC_NOT_ALLOWED
manualDocument
string
Final document analysis result (decision made by a automatic system and human). Possible values:
  • DOC_VALIDATED
  • DOC_NOT_FULLY_VISIBLE
  • DOC_NOT_SUPPORTED
  • DOC_EXPIRED
  • DOC_DAMAGED
  • DOC_FAKE
  • DOC_PERSONAL_CODE_INVALID
  • MRZ_INVALID
additionalSteps
string
An additional steps result (decision made by human). Possible values:
  • VALID
  • INVALID
  • NOT_FOUND

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:
  • ID_CARD
  • PASSPORT
  • RESIDENCE_PERMIT
  • DRIVER_LICENSE
  • PAN_CARD
  • AADHAAR
  • OTHER
  • VISA
  • BORDER_CROSSING
  • ASYLUM
  • NATIONAL_PASSPORT
  • INTERNATIONAL_PASSPORT
  • PROVISIONAL_DRIVER_LICENSE
  • VOTER_CARD
  • OLD_ID_CARD
  • TRAVEL_CARD
  • PHOTO_CARD
  • MILITARY_CARD
  • PROOF_OF_AGE_CARD
  • DIPLOMATIC_ID
docSex
string
Clients sex from the document. Possible values:
  • MALE
  • FEMALE
  • UNDEFINED
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:
  • UNDER_13
  • OVER_13
  • OVER_18
  • OVER_22
  • OVER_25
  • OVER_30
clientIpProxyRiskLevel
string
Client's IP address proxy risk level. Possible values:
  • VERY_LOW
  • LOW
  • MEDIUM
  • HIGH
  • VERY_HIGH
  • NOT_CHECKED
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 UTILITY_BILL.

Example Output

{
"platform": "MOBILE_APP",
"startTime": 1554726960,
"finishTime": 1554727002,
"clientIp": "192.0.2.0",
"clientIpCountry": "LT",
"clientLocation": "Kaunas, Lithuania",
"final": false,
"status": {
"overall": "APPROVED",
"mismatchTags": [],
"fraudTags": [],
"autoDocument": "DOC_VALIDATED",
"autoFace": "FACE_MATCH",
"manualDocument": "DOC_VALIDATED",
"manualFace": "FACE_MATCH",
"additionalSteps": null
},
"data": {
"docFirstName": "FIRST-NAME-EXAMPLE",
"docLastName": "LAST-NAME-EXAMPLE",
"docNumber": "XXXXXXXXX",
"docPersonalCode": "XXXXXXXXX",
"docExpiry": "YYYY-MM-DD",
"docDob": "YYYY-MM-DD",
"docDateOfIssue": "2018-03-02",
"docType": "ID_CARD",
"docSex": "UNDEFINED",
"docNationality": "LT",
"docIssuingCountry": "LT",
"docTemporaryAddress": null,
"docBirthName": null,
"birthPlace": "BIRTH PLACE",
"authority": "AUTHORITY EXAMPLE",
"address": "ADDRESS EXAMPLE",
"fullName": "FULL-NAME-EXAMPLE",
"selectedCountry": "LT",
"mothersMaidenName": null,
"driverLicenseCategory": null,
"manuallyDataChanged": false,
"orgFirstName": "FIRST-NAME-EXAMPLE",
"orgLastName": "LAST-NAME-EXAMPLE",
"orgNationality": "LIETUVOS",
"orgBirthPlace": "ŠILUVA",
"orgAuthority": null,
"orgAddress": null,
"orgTemporaryAddress": null,
"orgMothersMaidenName": null,
"orgBirthName": null,
"ageEstimate": "OVER_25",
"clientIpProxyRiskLevel": "LOW",
"duplicateDocFaces": null,
"duplicateFaces": null,
"additionalData": {
"UTILITY_BILL": {
"ssn": {
"value": "ssn number",
"status": "MATCH"
}
}
},
"manualAddress": null,
"manualAddressMatch": false,
"registryCenterCheck": null,
"addressVerification": null
},
"additionalStepPdfUrls": {},
}