Configuring validators

Validators can be tweaked by using the config endpoint. Follow these steps to set up your validator configuration:

  1. Create a PUT request to the following url:
  2. Create a Header named Truora-API-Key and set its value to your API key.
  3. Create a Header named Content-Type and set its value to application/json.
  4. Add a field named validator to the Body and set its value to the validation you wish to configure: either identity-questions, face-recognition, email-verification, phone-verification, or document-validation.
  5. Add configuration fields according to the following table:
Validator Fields
Document validation
  • country: either ALL, CO, CL, MX, BR, or PE
  • document_type: either passport, driver-license, general-registration, foreign-id, national-id, or pep
  • document_version: either mx_ine-f, mx_ine-e, mx_ine-g, mx_ife-c, mx_ife-d, mx_fm3, co_national-id-2000, co_national-id-2020, co_foreign-id, co_pep, br_any, or passport
  • timeout
  • validation_methods: comma-separated list of validation methods. Allowed methods are: data-consistency, government-database, photocopy-analysis, manual-review, and image-analysis
  • allowed_retries
Email validation
  • allowed_retries
  • timeout
Face recognition
  • threshold: similarity between the provided picture and video that is required to pass the validation from 0 to 1
  • timeout
  • use_manual_review: activation of manual review for validation failure, you should set true or false
Voice recognition
  • timeout
Phone validation
  • allowed_retries
  • timeout
  • custom_name: custom name for verification messages
Security identity questions
  • allowed_retries
  • timeout
  • threshold: correctness required to pass the validation from 0 to 1

For more information on these fields, check the API reference.

  1. Send the request. The API returns a map of the configuration for all validations.