​
Expediente de una verificación

El expediente de una verificación representa el estado de las validaciones de los documentos subidos para la verificación. Por ejemplo, si queremos que nuestros usuarios suban 3 documentos para la verificación, el expediente de la verificación tendrá definidos estos requerimientos:
  • 1 documento obligatorio: una acta constitutiva
  • 2 documentos opcionales: un estado de cuenta bancario y una constancia de situación fiscal
Esta es la representación de los requerimientos de la verificación: 
{
  "version": 2,
  "requirements": {
    "doc_1": {
      "ui_options": {
        "label": "Acta Constitutiva",
        "description": "Documento que certifica la constitución de la empresa."
      },
      "allowed_item_types": ["ac_mx"]
    }
  },
  "optional_requirements": {
    "doc_2": {
      "ui_options": {
        "label": "Estado de cuenta bancario",
        "description": "Documento que certifica el estado de cuenta bancario de la empresa."
      },
      "allowed_item_types": ["bank_statement"],
      "allowed_item_subtype": "business"
    },
    "doc_3": {
      "ui_options": {
        "label": "Constancia de situación fiscal",
        "description": "Documento que certifica la constancia de situación fiscal de la empresa."
      },
      "allowed_item_types": ["csf_mx"],
      "allowed_item_subtype": "business"
    }
  }
}
  • Los valores que pueden ir dentro de allowed_item_subtype son business o individual.
  • Los valores que pueden ir dentro de allowed_item_types son los mismos que los que se encuentran en los Tipos de Documentos de la Guía de Desarrolladores.

​
¿Cómo funciona el expediente?

Los usuarios pueden subir los documentos que se encuentran en el expediente de la verificación a través de nuestro widget (onboarding.gotrebol.com). Una vez subido cada documento, nuestra plataforma ejecutará las validaciones para determinar si el documento es válido o no. Una vez que todas las validaciones se han completado, cada requerimiento del expediente de la verificación se actualizará a un estado ok.

​
Estados de los requerimientos del expediente

EstadoCódigo de estadoDescripción
okokEl requerimiento ha sido validado.
errorinvalid_typeEl documento no es del tipo esperado.
errorinvalid_subtypeEl documento no es del subtipo esperado.
pendingpending_uploadEl documento no ha sido subido.
pendingpending_classificationEl documento no ha sido clasificado.

​
Consultar el estado de los requerimientos del expediente

Para consultar el estado de los requerimientos del expediente, puedes hacer una solicitud a la API de Trébol. 
curl -X GET "https://api.gotrebol.com/verifications/{verification_id}/record_validation" \
     -H "x-api-key: {api_key}"
Más información sobre este endpoint en API Reference.