Comment on page

OnDato

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
You can configure users' input that will be send to OnDato in order to get the most of the verifications.
Attribute
Type
Description
email
string
Email of the user (Required).
firstName
string
First name of the user (Optional).
middleName
string
Middle name of the user (Optional).
lastName
string
Last name of the user (Optional).
dateOfBirth
string
Date of birth of the user(Optional).
pesel
string
Pesel of the user(Optional).
phoneNumber
string
Phone number of the user (Optional).
countryCode
string
Country code of user (Optional).
Output
Attribute
Type
Description
state
string
Possible values include: 
- INIT
- IN_PROGRESS
- FAILED
- COMPLETED
- COMPLETED_WITH_ERRORS
​identityVerification​
object
​
​kycVerification​
object
​
Identity Verification
Attribute
Type
Description
applicationId
string
Identifier for the application
​communicationChannels​
array<object>
List of communication channels
createdUtc
string
Creation date and time (UTC)
externalReferenceId
string
External reference identifier
id
string
Identifier for the data record
modifiedUtc
string
Modification date and time (UTC)
​redaction​
object
Redaction information
​registration​
object
User registration details
​setup​
object
Setup information
status
string
Status of the data record (e.g., "Pending")
​step​
object
Workflow step details
Communication Channel
Attribute
Type
Description
id
string
Id of the communication channel.
type
string
Type of the communication channel.
Redaction
Attribute
Type
Description
redactedUtc
string
Redaction date and time (UTC)
Registration
Attribute
Type
Description
dateOfBirth
string
Date of birth
email
string
Email address
firstName
string
First name
lastName
string
Last name
middleName
string
Middle name
personalCode
string
Personal code
phoneNumber
number
Phone number
countryCode
string
Country code (e.g., "LT")
Setup
Attribute
Type
Description
id
string
Setup ID
overrideId
string
Override ID
versionId
string
Version ID
Step
Attribute
Type
Description
​consent​
object
Consent details
​kycIdentification​
object
KYC identification details
Consent
Attribute
Type
Description
consentedUtc
string
Consent date and time (UTC)
id
string
Consent ID
isConsented
boolean
Indicates if consent is given
KYC Identification Id
Attribute
Type
Description
id
string
Face authentication ID
Kyc Identification
Attribute
Type
Description
​additionalFiles​
array<object>
List of additional files
applicationId
string
Identifier for the application
​auditFiles​
array<object>
List of audit files
completedUtc
string
Completion date and time (UTC)
createdUtc
string
Creation date and time (UTC)
​document​
object
Document details
​face​
object
Face details
​fraudChecks​
array<object>
List of fraud checks
id
string
Identifier for the data record
identityVerificationId
string
Identifier for identity verification
isCrossChecked
boolean
Indicates if cross-checked
​proofOfAddress​
object
Proof of address details
​registries​
array<object>
List of registries
​rules​
array<object>
List of rules
​scores​
array<object>
List of scores
​setup​
object
Setup information
status
string
Possible values:
- Awaiting
- Approved
- Rejected
statusReason
string
Possible value in table below
Status
Status reasons
Awaiting
Unfinished
Processing
Approved
AutomaticallyIdentified
ManuallyIdentified
Rejected
TransferToVideoCall
MissingDocumentPhoto
DocumentNotAccepted
DataNotMatch
DataNotMatch
Sanctioned
MissingPersonPhoto
FacesNotMatch
PoorPhotoQuality
PoorPhotoLighting
FacePhotoUploadFormat
Miscellaneous
PossibleFraudAttempt
UnrelatedPhotoSubmit
MoreThanOnePerson
ProhibitedCountryOrState
DocumentIsExpired
DocumentWithNonLatinCharacters
PartOfDocumentIsCovered
PartOfFaceIsCovered
UnderagePerson
ProhibitedNationality
DuplicatedInfo
AdverseMediaFound
DocumentFromScreen
DocumentManipulation
DocumentPrinted
InvalidProofOfAddress
KnownFraudster
PoliticallyExposedPerson
SelfieHasNoFace
Additional Files
Attribute
Type
Description
createdUtc
string
Creation date and time (UTC)
fileExtension
string
File extension
fileId
string
File identifier
fileName
string
File name
fileType
string
File type
Audit Files
Attribute
Type
Description
createdUtc
string
Creation date and time (UTC)
fileExtension
string
File extension
fileId
string
File identifier
fileName
string
File name
fileType
string
File type
Document
Attribute
Type
Description
address
string
Document address
category
string
Document category
countryIso3
string
Country ISO-3 code
countryStateIso2
string
Country state ISO-2 code
dateOfBirth
string
Date of birth
dateOfExpiration
string
Date of expiration
dateOfIssue
string
Date of issue
documentNumber
string
Document number
​files​
array<object>
List of document files
firstName
string
First name
fullName
string
Full name
gender
string
Gender
lastName
string
Last name
middleName
string
Middle name
mrzVerified
boolean
MRZ verification status
nationalityIso3
string
Nationality ISO-3 code
​ocrValidations​
array<object>
List of OCR validations
personalCode
string
Personal code
type
string
Document type
Document Files
Attribute
Type
Description
autoCaptureConfidenceRate
number
Auto-capture confidence rate
createdUtc
string
Creation date and time (UTC)
fileExtension
string
File extension
fileId
string
File identifier
fileName
string
File name
fileType
string
File type
part
string
Part of the document
Face
Attribute
Type
Description
ageEstimation
string
Age estimation
ageEstimateGroupV2
string
Age estimate group (V2)
enrollmentId
string
Enrollment ID
​files​
array<object>
List of face files
Face Files
Attribute
Type
Description
createdUtc
string
Creation date and time (UTC)
fileExtension
string
File extension
fileId
string
File identifier
fileName
string
File name
fileType
string
File type
Fraud Checks
Attribute
Type
Description
fileId
string
File identifier
name
string
Fraud check name
reasons
array<string>
List of fraud check reasons
status
string
Fraud check status (e.g., "Success")
linkedIdentificationId
string
Linked identification identifier
Proof of Address
Attribute
Type
Description
city
string
City
files
array<object>
List of proof of address files
firstName
string
First name
lastName
string
Last name
​ocrValidations​
array<object>
List of Optical character recognition validations
parish
string
Parish
street
string
Street
Registries
Attribute
Type
Description
name
string
Registry name
reason
string
Reason
status
string
Status (e.g., "Ignore")
Rules
Attribute
Type
Description
name
string
Rule name
reason
string
Reason
status
string
Status (e.g., "Success")
Scores
Attribute
Type
Description
name
string
Score name
value
string
Score value
Setup
Attribute
Type
Description
id
string
Setup ID
versionId
string
Version ID
OCR Validations
Attribute
Type
Description
isValid
boolean
Flag indicating if validation is valid
key
string
Name of the field that's been validated
Output Example
{
    "state": "COMPLETED",
    "identityVerification": {
        "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "communicationChannels": [
            {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "Email"
            }
        ],
        "createdUtc": "2023-09-14T13:09:56.847Z",
        "externalReferenceId": "123",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "modifiedUtc": "2023-09-14T13:09:56.847Z",
        "redaction": {
            "redactedUtc": "2023-09-14T13:09:56.847Z"
        },
        "registration": {
            "dateOfBirth": "2021-01-14",
            "email": "[email protected]",
            "firstName": "John",
            "lastName": "Johnson",
            "middleName": "Adam",
            "personalCode": "1214148111000",
            "phoneNumber": 370624515141,
            "countryCode": "LT"
        },
        "setup": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "overrideId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "status": "Pending",
        "step": {
            "authenticationSignature": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "consent": {
                "consentedUtc": "2021-01-02T14:08:39.712Z",
                "id": "01d9d9df-afb3-445c-a9cf-012012df58ea",
                "isConsented": false
            },
            "documentSignatures": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                }
            ],
            "forms": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                }
            ],
            "kybIdentification": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "kycIdentification": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "faceAuthentication": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
        }
    },
    "kycVerification": {
        "additionalFiles": [
            {
                "createdUtc": "2023-09-14T13:13:15.724Z",
                "fileExtension": "jpeg",
                "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "fileName": "identity_file.jpeg",
                "fileType": "ProofOfAddress"
            }
        ],
        "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "auditFiles": [
            {
                "createdUtc": "2023-09-14T13:13:15.724Z",
                "fileExtension": "jpeg",
                "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "fileName": "identity_file.jpeg",
                "fileType": "ScreenRecording"
            }
        ],
        "completedUtc": "2023-09-14T13:13:15.724Z",
        "createdUtc": "2023-09-14T13:13:15.724Z",
        "document": {
            "address": "string",
            "category": "B",
            "countryIso3": "LTU",
            "countryStateIso2": "GR",
            "dateOfBirth": "2000-02-03",
            "dateOfExpiration": "2000-02-03",
            "dateOfIssue": "2000-02-03",
            "documentNumber": "PU2343443343",
            "files": [
                {
                    "autoCaptureConfidenceRate": 99.9,
                    "createdUtc": "2023-09-14T13:13:15.725Z",
                    "fileExtension": "jpeg",
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "fileName": "identity_file.jpeg",
                    "fileType": "DocumentPhoto",
                    "part": "Front"
                }
            ],
            "firstName": "John",
            "fullName": "John Adam Jones",
            "gender": "Male",
            "lastName": "Jones",
            "middleName": "Adam",
            "mrzVerified": true,
            "nationalityIso3": "LTU",
            "ocrValidations": [
                {
                    "isValid": true,
                    "key": "Address"
                }
            ],
            "personalCode": "199202030202",
            "type": "IdCard"
        },
        "face": {
            "ageEstimation": "AgeUnder13",
            "ageEstimateGroupV2": "AgeEstimateNotAvailable",
            "enrollmentId": "adfc35b9-faba-4b6f-9f7d-f33e2a83b0e6",
            "files": [
                {
                    "createdUtc": "2023-09-14T13:13:15.725Z",
                    "fileExtension": "gif",
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "fileName": "face_file.gif",
                    "fileType": "FaceVideo"
                }
            ]
        },
        "fraudChecks": [
            {
                "fileId": "52de38da842b4451bb4b18121eb4b80f",
                "name": "SeonIp",
                "reasons": [
                    "string"
                ],
                "status": "Success",
                "linkedIdentificationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
        ],
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "identityVerificationId": "1dbb6d1d-0596-4247-9b37-879e44c53ddc",
        "isCrossChecked": true,
        "proofOfAddress": {
            "city": "Amestris",
            "files": [
                {
                    "createdUtc": "2023-09-14T13:13:15.725Z",
                    "fileExtension": "jpeg",
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "fileName": "identity_file.jpeg",
                    "fileType": "DocumentPhoto"
                }
            ],
            "firstName": "John",
            "lastName": "Jones",
            "ocrValidations": [
                {
                    "isValid": true,
                    "key": "FirstName"
                }
            ],
            "parish": "Amestria",
            "street": "Amestry st. 15-25"
        },
        "registries": [
            {
                "name": "SharedDatabase",
                "reason": "FoundInSanctionsList",
                "status": "Ignore"
            }
        ],
        "rules": [
            {
                "name": "SelfieHasFace",
                "reason": "SelfieHasNoFace",
                "status": "Success"
            }
        ],
        "scores": [
            {
                "name": "SelfieAndDocumentImageComparison",
                "value": "0"
            }
        ],
        "setup": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "status": "Awaiting",
        "statusReason": "MissingDocumentPhoto"
    },
    "files": {
        ...
    }
}

Attribute	Type	Description
email	string	Email of the user (Required).
firstName	string	First name of the user (Optional).
middleName	string	Middle name of the user (Optional).
lastName	string	Last name of the user (Optional).
dateOfBirth	string	Date of birth of the user(Optional).
pesel	string	Pesel of the user(Optional).
phoneNumber	string	Phone number of the user (Optional).
countryCode	string	Country code of user (Optional).

Attribute	Type	Description
state	string	Possible values include: - INIT - IN_PROGRESS - FAILED - COMPLETED - COMPLETED_WITH_ERRORS
identityVerification	object
kycVerification	object

Attribute	Type	Description
applicationId	string	Identifier for the application
communicationChannels	array<object>	List of communication channels
createdUtc	string	Creation date and time (UTC)
externalReferenceId	string	External reference identifier
id	string	Identifier for the data record
modifiedUtc	string	Modification date and time (UTC)
redaction	object	Redaction information
registration	object	User registration details
setup	object	Setup information
status	string	Status of the data record (e.g., "Pending")
step	object	Workflow step details

Attribute	Type	Description
id	string	Id of the communication channel.
type	string	Type of the communication channel.

Attribute	Type	Description
redactedUtc	string	Redaction date and time (UTC)

Attribute	Type	Description
dateOfBirth	string	Date of birth
email	string	Email address
firstName	string	First name
lastName	string	Last name
middleName	string	Middle name
personalCode	string	Personal code
phoneNumber	number	Phone number
countryCode	string	Country code (e.g., "LT")

Attribute	Type	Description
id	string	Setup ID
overrideId	string	Override ID
versionId	string	Version ID

Attribute	Type	Description
consent	object	Consent details
kycIdentification	object	KYC identification details

Attribute	Type	Description
consentedUtc	string	Consent date and time (UTC)
id	string	Consent ID
isConsented	boolean	Indicates if consent is given

Attribute	Type	Description
id	string	Face authentication ID

Attribute	Type	Description
additionalFiles	array<object>	List of additional files
applicationId	string	Identifier for the application
auditFiles	array<object>	List of audit files
completedUtc	string	Completion date and time (UTC)
createdUtc	string	Creation date and time (UTC)
document	object	Document details
face	object	Face details
fraudChecks	array<object>	List of fraud checks
id	string	Identifier for the data record
identityVerificationId	string	Identifier for identity verification
isCrossChecked	boolean	Indicates if cross-checked
proofOfAddress	object	Proof of address details
registries	array<object>	List of registries
rules	array<object>	List of rules
scores	array<object>	List of scores
setup	object	Setup information
status	string	Possible values: - Awaiting - Approved - Rejected
statusReason	string	Possible value in table below

Status	Status reasons
Awaiting	Unfinished Processing
Approved	AutomaticallyIdentified ManuallyIdentified
Rejected	TransferToVideoCall MissingDocumentPhoto DocumentNotAccepted DataNotMatch DataNotMatch Sanctioned MissingPersonPhoto FacesNotMatch PoorPhotoQuality PoorPhotoLighting FacePhotoUploadFormat Miscellaneous PossibleFraudAttempt UnrelatedPhotoSubmit MoreThanOnePerson ProhibitedCountryOrState DocumentIsExpired DocumentWithNonLatinCharacters PartOfDocumentIsCovered PartOfFaceIsCovered UnderagePerson ProhibitedNationality DuplicatedInfo AdverseMediaFound DocumentFromScreen DocumentManipulation DocumentPrinted InvalidProofOfAddress KnownFraudster PoliticallyExposedPerson SelfieHasNoFace

Attribute	Type	Description
createdUtc	string	Creation date and time (UTC)
fileExtension	string	File extension
fileId	string	File identifier
fileName	string	File name
fileType	string	File type

Attribute	Type	Description
createdUtc	string	Creation date and time (UTC)
fileExtension	string	File extension
fileId	string	File identifier
fileName	string	File name
fileType	string	File type

Attribute	Type	Description
address	string	Document address
category	string	Document category
countryIso3	string	Country ISO-3 code
countryStateIso2	string	Country state ISO-2 code
dateOfBirth	string	Date of birth
dateOfExpiration	string	Date of expiration
dateOfIssue	string	Date of issue
documentNumber	string	Document number
files	array<object>	List of document files
firstName	string	First name
fullName	string	Full name
gender	string	Gender
lastName	string	Last name
middleName	string	Middle name
mrzVerified	boolean	MRZ verification status
nationalityIso3	string	Nationality ISO-3 code
ocrValidations	array<object>	List of OCR validations
personalCode	string	Personal code
type	string	Document type

Attribute	Type	Description
autoCaptureConfidenceRate	number	Auto-capture confidence rate
createdUtc	string	Creation date and time (UTC)
fileExtension	string	File extension
fileId	string	File identifier
fileName	string	File name
fileType	string	File type
part	string	Part of the document

Attribute	Type	Description
ageEstimation	string	Age estimation
ageEstimateGroupV2	string	Age estimate group (V2)
enrollmentId	string	Enrollment ID
files	array<object>	List of face files

Attribute	Type	Description
createdUtc	string	Creation date and time (UTC)
fileExtension	string	File extension
fileId	string	File identifier
fileName	string	File name
fileType	string	File type

Attribute	Type	Description
fileId	string	File identifier
name	string	Fraud check name
reasons	array<string>	List of fraud check reasons
status	string	Fraud check status (e.g., "Success")
linkedIdentificationId	string	Linked identification identifier

Attribute	Type	Description
city	string	City
files	array<object>	List of proof of address files
firstName	string	First name
lastName	string	Last name
ocrValidations	array<object>	List of Optical character recognition validations
parish	string	Parish
street	string	Street

Attribute	Type	Description
name	string	Registry name
reason	string	Reason
status	string	Status (e.g., "Ignore")

Attribute	Type	Description
name	string	Rule name
reason	string	Reason
status	string	Status (e.g., "Success")

Attribute	Type	Description
name	string	Score name
value	string	Score value

Attribute	Type	Description
id	string	Setup ID
versionId	string	Version ID

Attribute	Type	Description
isValid	boolean	Flag indicating if validation is valid
key	string	Name of the field that's been validated

Identity Card Verification

Next - Integrations

Polish VAT Whitelist

Last modified 2mo ago