Identity Check

Output

Attribute	Type	Description
client	object	Comply Cube client details.
checksResult	map	Results of performed checks.

Client

Attribute	Type	Description
id	string	The unique identifier for a client.
type	string, possible values include: person company	The type of client.
entityName	string	The client's full name.
email	string	The client's email address.
personDetails	object	Details for a client of type person.
companyDetails	object	Details for a client of type company.
createdAt	string	The date and time when the client was created.
updatedAt	string	The date and time when the client was updated.

Person Details

Attribute	Type	Description
firstName	string	The client's first name.
lastName	string	The client's last name.

Company Details

Attribute	Type	Description
name	string	The client's name.

Checks Result

Attribute	Type	Description
identityCheck	string	Result of the identity check.

Identity Check

Attribute	Type	Description
state	string, possible values include: INIT IN_PROGRESS ERROR FAILED FINISHED	The status of the client's verification
document	object	Document which was used to verification process.
files	links	Links that allow to download client's documents.
outcome	string, possible values include: clear attention not_processed	The outcome attribute represents the overall check result. Returned values include: clear: Indicates every analysis type conducted returned a successful result, and hence the document is authentic. attention: Indicates at least one of the analysis results requires attention. not_processed: Indicates that ComplyCube was not able to process the images. Reasons include: The image is of low quality. The image is blurred or glared. The image is at an angle. The ID type and country provided do not correspond with the actual document provided uploaded.
breakdown	object	Details of verification.

Document

Attribute	Type	Description
type	string, valid values include: passport driving_license national_insurance_number social_security_number utility_bill tax_identification_number national_identity_card visa polling_card residence_permit birth_certificate bank_statement change_of_name tax_document company_confirmation_statement company_annual_accounts company_statement_of_capital company_change_of_address company_incorporation company_change_of_officers company_change_of_beneficial_owners unknown other	The type of document.
issuingCountry	string	The document's issuing country. This will be the two-letter country ISO code.
createdAt	string	The date and time when the document was created.
updatedAt	string	The date and time when the document was updated.

Breakdown

Property	Type	Description
faceAnalysis	object	The facial analysis results.
authenticityAnalysis	object	The facial analysis results.
integrityAnalysis	object	The integrity analysis results.

Face Analysis

Attribute	Type	Description
faceDetection	string	Indicates whether a face is detected and that number of faces detected on the ID and live photo are valid.
facialSimilarity	string	Indicates whether the faces on the live photo and document belong to the same person.
previouslyEnrolledFace	string	Indicates whether the face on the live photo has been previously enrolled as a different client.
breakdown	object	Breakdown related to facial analysis.

Face Analysis Breakdown

Attribute	Type	Description
facialSimilarityScore	number	Indicates the similarity level of whether two faces belong to the same person. The score will be 100 for a perfect match.
enrolledFacesMatches	array<object>	If a face is deemed to have been enrolled previously, this will contain an array of objects.

Enrolled Faces Matches

Attribute	Type	Description
clientId	string	Unique identifier for the matching client.
entityName	string	Full name of the client.
livePhotoId	string	Unique identifier for the matching live photo.
facialSimilarityScore	number	The similarity level of the client's face against the live photo associated with the check.

Authenticity Analysis

Attribute	Type	Description
spoofedImageAnalysis	string	Indicates whether images are spoofed, copied from internet, or blacklisted.
livenessCheck	string	Indicates if live photo is genuine and not a photo-of-an-image or screen.
breakdown	object	Breakdown related to authenticity analysis.

Authenticity Analysis Breakdown

Attribute	Type	Description
specimenCheckMatches	array<string>	If an image is deemed copied from the internet, this will contain an array of URLs pointing to the image.
livenessCheckScore	number	Indicates the liveness score of the live photo. The score will be 100 when it is assumed to be authentic.

Integrity Analysis

Attribute	Type	Description
faceDetection	string	Indicates whether expected number of faces are detected.
vpnDetected	string	Indicates if client used a Virtual Private Network (VPN).

Example

{
    "complyCube": {
        "idVerification": [
            {
                "client": {
                    "id": "64df68fabc1c610008bbb1b9",
                    "type": "person",
                    "entityName": "Jan Kowalski",
                    "email": "[e-mail]",
                    "personDetails": {
                        "firstName": "Jan",
                        "lastName": "Kowalski"
                    },
                    "createdAt": "2023-08-18T12:50:02.168Z",
                    "updatedAt": "2023-08-18T12:50:02.168Z"
                },
                "checksResult": {
                    "identityCheck": {
                        "state": "FINISHED",
                        "document": {
                            "type": "DRIVING_LICENSE",
                            "issuingCountry": "PL",
                            "createdAt": "2023-08-18T12:50:27.062Z",
                            "updatedAt": "2023-08-18T12:54:50.285Z"
                        },
                        "files": [
                            {
                                "resourceId": "e652dc6e-22cc-4f47-8e90-fcaa8e0be1a7",
                                "resourcePath": "resources/c84db9d5-3e88-4fa2-9211-60f9b9e6b213/e652dc6e-22cc-4f47-8e90-fcaa8e0be1a7/4127107e-d7b2-4d7f-8f1f-494682a8cb3d/selfie_1692363309716.jpg",
                                "resourceName": "selfie_1692363309716.jpg"
                            }
                        ],
                        "outcome": "clear",
                        "breakdown": {
                            "faceAnalysis": {
                                "faceDetection": "clear",
                                "facialSimilarity": "clear",
                                "previouslyEnrolledFace": "clear",
                                "breakdown": {
                                    "facialSimilarityScore": 100
                                }
                            },
                            "authenticityAnalysis": {
                                "spoofedImageAnalysis": "clear",
                                "livenessCheck": "clear",
                                "breakdown": {
                                    "livenessCheckScore": 100
                                }
                            },
                            "integrityAnalysis": {
                                "faceDetection": "clear",
                                "vpnDetected": "clear"
                            }
                        }
                    }
                }
            }
        ]
    }
}