KYC (Know Your Customer)

Time	Status	User Agent
Retrieving recent requests…

📢 Considerations

To successfully perform the flow of KYC validations, before being able to create a client, the same Endpoint specified in this section must be invoked. The structure of the body of the request (Body) must be changed, in all validations the type field is required, taking into account the information required in each validation:

Biometric validation: In BiometricCheck catalog requires all the fields presented in the JSON of this section. The number of images is proportional to the number of records provided in the Image Type catalog.
Blacklist validation: In BlackListCheck catalog it requires the customer_name field and the document object with its three fields, the others could be ignored or sent empty.
Selfie validation: In SelfieCheck catalog requires the customer_name field and the document object with its three fields, also the media array must be sent, which must contain an object containing the selfie image type; the other media objects are not used.
Document validation: In DocumentCheck catalog, requires the customer_name field and the document object with its three fields, in addition the media array must be sent, which must contain the image type objects: FrontalDocument and BackDocument.

📖 Example Requests

Below you will find the body of four example JSON requests for the KYC api:

Example 1: BlackListCheck.
Example 2: DocumentCheck.
Example 3: SelfieCheck.
Example 4: BiometricCheck.

{
    "type": "BlackListCheck",
    "customer_name": "Richard Ramirez Cordoba",
    "document": {
        "number": "9999999999",
        "document_type": "2",
        "expiry_date": "2030-02-04"
    }
}

{
    "type": "DocumentCheck",
    "customer_name": "Richard Ramirez Cordoba",
    "document": {
        "number": "9999999999",
        "document_type": "2",
        "expiry_date": "2030-02-04"
    },
    "media": [
        {
            "type": "FrontalDocument",
            "file": "image/base64"
        },
        {
            "type": "BackDocument",
            "file": "image/base64"
        }
    ]
}

{
    "type": "SelfieCheck",
    "customer_name": "Richard Ramirez Cordoba",
    "document": {
        "number": "9999999999",
        "document_type": "2",
        "expiry_date": "2030-02-04"
    },
    "media": [
        {
            "type": "Selfie",
            "file": "image/base64"
        }
    ]
}

{
    "type": "BiometricCheck",
    "customer_name": "Richard Ramirez Cordoba",
    "document": {
        "number": "9999999999",
        "document_type": "2",
        "expiry_date": "2030-02-04"
    },
    "media": [
        {
            "type": "FrontalDocument",
            "file": "image/base64"
        },
        {
            "type": "BackDocument",
            "file": "image/base64"
        },
        {
            "type": "Selfie",
            "file": "image/base64"
        },
        {
            "type": "Signature",
            "file": "image/base64"
        }
    ]
}

JSON response body fields:

Name	Descripction	Type
`bank_id`	Bank code of the validation.	`string`
`id`	Validated document number.	`string`
`customer_name`	The name of the validated person.	`string`
`date`	The date and time the validation was performed.	`date`
`satisfied`	It is a boolean that indicates whether the validation was successful or not.	`boolean`
`comments`	It is a comment that indicates which validation was not successful, in case of a successful response this value is null.	`string`

📋 Catalogs

✅ Verification Types

Type	Description
BiometricCheck	Performs biometric validation that verifies that the image entered matches the customer's ID image.
BlackListCheck	Performs the VIGIA validation that checks if the customer is blacklisted.
SelfieCheck	Performs biometric validation only on the selfie, validating that it is a real identifiable person.
DocumentCheck	Validate only the document sent, that it is valid, and that the name and number match the information provided.

📷 Image Types

Type	Description
Selfie	Photo of the customer's face taken at the time of registration.
FrontalDocument	Photo of the front of the identification document.
BackDocument	Photo of the back of the identification document.
Signature	Photo of the client's signature. This must be the same signature established in the identification document entered.

📢 Considerations

📖 Example Requests

JSON response body fields:

📋 Catalogs

✅ Verification Types

📷 Image Types

200200

400400

401401