Skip to main content

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:

ValidationTypeRequiredDescription
cameraBooleanOptionalRequests a photo of the signer's face.
otpCodeBooleanOptionalRequests a verification code.
bothBooleanOptionalEnables notification via email and WhatsApp.
options.cameraBooleanConditionalIf 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.otpCodeBooleanConditionalThis 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.whatsappBooleanConditionalSend 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.bothBooleanConditionalSend 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.videoBooleanConditionalSend 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.identificationCardbackBooleanConditionalSend 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.flowBooleanConditionalSend this field as true only if you want the identity validation to be done through forms within WhatsApp Flow only available for WhatsApp.

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

  1. options.camera = 'identification' activates biometric comparison, but it will only work if the signer has identification, country, and identificationType defined.
  2. options.video = true will have no effect unless options.whatsapp = true is also activated.
  3. options.both = true indicates that the signer must receive notifications via email and WhatsApp simultaneously; for this to be effective: options.whatsapp = true.
  4. If you declare options but do not activate camera or otpCode externally, the process will not be valid.
  5. options.flow = true to be effective, you must request at least camera:true and options.camera: 'identification' or options.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"
}
}
],
...
}