Saltar al contenido principal

ValidationAttempt

ValidationAttempt

idstring

Identificador único del flujo de validación.

Example: va_1B2M2Y8AsgTpgAmY7PhCfg
identity_emailstring

Correo electrónico de la identidad asociada al flujo.

Example: gus@polloshermanos.com
statusstring

Estado actual del flujo de validación.

Possible values: [pending, in_progress, successful, failed, canceled]

failed_countinteger

Cantidad de veces que el flujo de validación ha fallado.

Example: 1
user_referencestring | nullnullable

Referencia de usuario de tu sistema para el flujo de validación.

Example: user_123
performed_nfc_scanboolean | nullnullable

Indica si el flujo incluyó paso de lectura NFC (solo disponible vía React Native SDK).

Example: true
nfc_detailstring

Resultado detallado de la lectura NFC cuando aplica.

Possible values: [not_requested, failed, success]

Example: success
identity_verification_typeIdentityVerificationType

Tipo semántico de validación de identidad configurado para el intento.

Possible values: [biometric, document_scan, government_check, biometric_with_government_check, document_scan_with_government_check, unknown]

Example: biometric_with_government_check
requestable_idstring

ID del objeto asociado al intento de validación (ej. DataSubjectRequest, DisclosureRequest, GovernmentCheckRequest, ConsentFormValidationRequest).

Example: cfvreq_1B2M2Y8AsgTpgAmY7PhCfg
requestable_typestring

Tipo de objeto asociado al intento de validación.

Example: ConsentFormValidationRequest
errors_array object[]

Lista de errores detallados asociados al flujo de validación.

  • Array [
    • codestring

    Código interno del error.

    Example: auth-002
    typestring

    Categoría del error (document, facial u otro).

    Example: document
    messagestring

    Clave del error reportado.

    Example: document_validation_error
    detailstring

    Mensaje listo para mostrar relacionado al error.

    Example: No pudimos validar el documento con la información enviada.
  • ]
    • risk_reason_codesstring[]

    Señales de riesgo legibles por máquina acumuladas durante las evaluaciones del intento. Pueden aparecer en intentos exitosos y no reemplazan error_reason ni errors_array. El orden no representa prioridad ni causalidad.

    Example: ["repeated_possible_spoof","velocity_high_user_reference_rate"]
    error_reasonnull | stringnullable

    Motivo del error, si el flujo no fue exitoso. Campo opcional.

    Possible values: [unknown_error, document_validation_error, facial_validation_error, expiration_error, matcher_error, timeout_error]

    created_atdate-time

    Fecha y hora de creación del flujo de validación.

    successful_atdate-timenullable

    Fecha y hora en que el flujo de validación se marcó como exitoso.

    document_images object

    Imágenes del documento obtenidas desde los archivos asociados al mismo intento de validación.

    oneOf
    frontstring | nullnullable

    URL de la imagen frontal endurecida del documento, o "hidden" si la respuesta va enmascarada.

    Example: /api/v1/validation_attempts/va_123/document_images/front
    backstring | nullnullable

    URL de la imagen trasera endurecida del documento, o "hidden" si la respuesta va enmascarada.

    Example: /api/v1/validation_attempts/va_123/document_images/back
    government_id_validation object

    Estado no sensible de la validación gubernamental asociada, si existe.

    oneOf
    statusstring

    Estado de la validación gubernamental.

    Possible values: [pending, in_progress, verified, failed]

    Example: verified
    government_check_providerstring | nullnullable

    Proveedor usado para la validación gubernamental.

    Example: certificadora_del_sur
    error_reasonstring | nullnullable

    Motivo del error si la validación gubernamental falló.

    Example: document_not_valid
    has_audit_imageboolean

    Indica si el intento es elegible para tener imagen de auditoría, es decir si llegó a completar su enrollment biométrico. No garantiza que la descarga siga disponible, porque la imagen puede haber sido eliminada según la configuración de retención. No expone la imagen ni su contenido.

    ValidationAttempt
    {
      "id": "va_1B2M2Y8AsgTpgAmY7PhCfg",
      "identity_email": "gus@polloshermanos.com",
      "status": "pending",
      "failed_count": 1,
      "user_reference": "user_123",
      "performed_nfc_scan": true,
      "nfc_detail": "success",
      "identity_verification_type": "biometric_with_government_check",
      "requestable_id": "cfvreq_1B2M2Y8AsgTpgAmY7PhCfg",
      "requestable_type": "ConsentFormValidationRequest",
      "errors_array": [
        {
          "code": "auth-002",
          "type": "document",
          "message": "document_validation_error",
          "detail": "No pudimos validar el documento con la información enviada."
        }
      ],
      "risk_reason_codes": [
        "repeated_possible_spoof",
        "velocity_high_user_reference_rate"
      ],
      "error_reason": "unknown_error",
      "created_at": "2024-07-29T15:51:28.071Z",
      "successful_at": "2024-07-29T15:51:28.071Z",
      "document_images": {
        "front": "/api/v1/validation_attempts/va_123/document_images/front",
        "back": "/api/v1/validation_attempts/va_123/document_images/back"
      },
      "government_id_validation": {
        "status": "verified",
        "government_check_provider": "certificadora_del_sur",
        "error_reason": "document_not_valid"
      },
      "has_audit_image": true
    }