Identity Validations
Combinations and Strategies per Signer
When generating a signing process, it is essential to understand the different possible combinations of identity validations, as well as the strategies that allow you to apply them globally or individually per signer.
To structure these validations, there are rules you must consider to ensure the process works correctly.
1. Types of Available Validations
The identity validations you can combine in a process include:
Validation | Type | Required | Description |
---|---|---|---|
camera | Boolean | Optional | Requests a photo of the signer's face. |
otpCode | Boolean | Optional | Requests a verification code. |
both | Boolean | Optional | Enables notification via email and WhatsApp. |
options.camera | Boolean | Conditional | If you want to match the face photo with the signer's ID, you must send 'identification' in this field, or if you want only the participant's photo, send 'photo' . |
options.otpCode | Boolean | Conditional | This field accepts the values 'phone' and 'email' to indicate through which medium the signer will receive the code if otpCode is set to true in the base data. |
options.whatsapp | Boolean | Conditional | Send this field as true only if you want the signing flow of this signer to be carried out through WhatsApp; by default, it is false . |
options.both | Boolean | Conditional | Send this field as true only if you want the signing flow of this signer to be carried out through WhatsApp and email, by default it is false . |
options.video | Boolean | Conditional | Send this field as true only if you want the identity validation to be done via video; by default, it is false , only available for WhatsApp. |
options.identificationCardback | Boolean | Conditional | Send this field as true only if you want the identity validation to additionally request the back side of the document only available for WhatsApp. |
options.flow | Boolean | Conditional | Send this field as true only if you want the identity validation to be done through forms within WhatsApp Flow only available for WhatsApp. |
info
Here you can see the list of countries and accepted identity documents
2. Global and Individual Validations
You can apply validations in two ways:
- Global: at the root of the request. They are automatically applied to all signers.
- Individual: in the signProfile[x] object, to validate each signer in a personalized way.
info
Individual validations take precedence over global ones when both are declared.
3. Key Rules
options.camera = 'identification'
activates biometric comparison, but it will only work if the signer has identification, country, and identificationType defined.options.video = true
will have no effect unlessoptions.whatsapp = true
is also activated.options.both = true
indicates that the signer must receive notifications via email and WhatsApp simultaneously; for this to be effective:options.whatsapp = true
.- If you declare
options
but do not activatecamera
orotpCode
externally, the process will not be valid. options.flow = true
to be effective, you must request at leastcamera:true
andoptions.camera: 'identification'
oroptions.camera: 'photo'
.
4. Examples:
Global Validations:
{
...,
"camera": true,
"otpCode": true,
"options": {
"camera": "identification",
"otpCode": "email",
}
"signProfile": [
{
"name": "Firmante 1",
"email": "example@auco.ai",
"phone": "+573000000000",
"identification": "123456789",
"identificationType": "CC",
"country": "CO"
},
{
"name": "Firmante 2",
"email": "example2@auco.ai",
"phone": "+573000000000",
"identification": "123456789",
"identificationType": "CC",
"country": "CO"
}
],
...
}
Individual Validations:
{
...,
"signProfile": [
{
"name": "Firmante 1",
"email": "example@auco.ai",
"phone": "+573000000000",
"camera": true,
"otpCode": true,
"identification": "123456789",
"identificationType": "CC",
"country": "CO"
"options": {
"camera": "identification",
"video": true,
"whatsapp": true,
"otpCode": "email"
}
}
],
...
}