Creacion de Verificacion
Gestion de item Ids
Invalidar un documento
Leer por ID de Verificacion
- GETObtener una verificación por su ID
- GETObtener estatutos de las actas por el ID de Verificacion
- GETObtener documentos de la empresa por id de verificacion
- GETObtener apoderados y representates legales de la empresa de las actas por el ID de Verificacion
- GETObtener accionistas de la empresa de las actas por el ID de Verificacion
- GETObtener datos de prevalidacion de documentos
Leer por Etiqueta
- GETObtener estatutos de las actas por la Etiqueta
- GETObtener documentos de la empresa
- GETObtener apoderados y representantes legales de la empresa de las actas por la Etiqueta
- GETObtener accionistas de las actas de la empresa por la Etiqueta
- GETObtener la informacion de la prevalidacion de documentos asosciados a una empresa
Exportación de Verificaciones
Labels de Verificacion
Actualizar personas clave de una verificacion
Agregar items a una verificacion
Estado de validacion de documentos
Gestión de Flujos de Cuenta
Gestión de Esquemas de Formularios
Gestión de IPs Permitidas
Gestión de API Keys
Gestión de Política de Retención
curl --request GET \
--url https://api.gotrebol.com/account-flows \
--header 'x-api-key: <api-key>'[
{
"id": "<string>",
"account_id": "<string>",
"friendly_name": "<string>",
"flow_items": {
"id": "<string>",
"items": [
{
"type": "generic",
"options": {
"is_optional": true,
"client_item_type": "<string>",
"schema_id": "some-test-form-schema"
}
}
],
"options": {
"creator_email": "[email protected]",
"next_steps_checkout": [
{
"title": "Documentos adicionales",
"description": "Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo."
},
{
"title": "Firma del contrato",
"description": "Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato."
}
]
}
},
"record_validation_schema": {
"version": "2",
"requirements": {
"doc_1": {
"ui_options": {
"label": "Constancia de Situación Fiscal",
"description": "Documento que certifica que la empresa está al día con sus obligaciones fiscales.",
"conditional_render": true,
"conditional_render_label": "¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?"
},
"allowed_item_types": [
"csf_mx"
],
"validation_options": {
"on_invalid_type_error": "invalidate"
}
}
},
"optional_requirements": {}
},
"country": "mx",
"id_slug": "<string>"
}
]Listar flujos de cuenta
Obtiene una lista de todos los flujos de cuenta
curl --request GET \
--url https://api.gotrebol.com/account-flows \
--header 'x-api-key: <api-key>'[
{
"id": "<string>",
"account_id": "<string>",
"friendly_name": "<string>",
"flow_items": {
"id": "<string>",
"items": [
{
"type": "generic",
"options": {
"is_optional": true,
"client_item_type": "<string>",
"schema_id": "some-test-form-schema"
}
}
],
"options": {
"creator_email": "[email protected]",
"next_steps_checkout": [
{
"title": "Documentos adicionales",
"description": "Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo."
},
{
"title": "Firma del contrato",
"description": "Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato."
}
]
}
},
"record_validation_schema": {
"version": "2",
"requirements": {
"doc_1": {
"ui_options": {
"label": "Constancia de Situación Fiscal",
"description": "Documento que certifica que la empresa está al día con sus obligaciones fiscales.",
"conditional_render": true,
"conditional_render_label": "¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?"
},
"allowed_item_types": [
"csf_mx"
],
"validation_options": {
"on_invalid_type_error": "invalidate"
}
}
},
"optional_requirements": {}
},
"country": "mx",
"id_slug": "<string>"
}
]Authorizations
Response
Lista de flujos recuperada exitosamente
Show child attributes
Show child attributes
ID con el que se identifica el template de verificación.
Lista de items que conforman el template de verificación
Show child attributes
Show child attributes
Tipo de item de verificación
"generic"
Show child attributes
Show child attributes
Indica si el item es opcional, si es true, el item no sera requerido para que finalice la verificacion.
Especificacion del tipo de item segun el cliente. Consulta los valores disponibles en Tipos de ítem
ID del esquema de formulario. Requerido para items de tipo forms.
Debe corresponder a un esquema de formulario existente en la cuenta.
"some-test-form-schema"
Opciones adicionales para la verificacion.
Show child attributes
Show child attributes
Email del creador de la verificacion, el usuario empresarial.
Lista de pasos que se mostrarán en el checkout del widget. Se puede enviar un array vacio para no mostrar ningun paso.
Show child attributes
Show child attributes
Titulo del paso.
"Documentos adicionales"
Descripción del paso.
"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo."
[
{
"title": "Documentos adicionales",
"description": "Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo."
},
{
"title": "Firma del contrato",
"description": "Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato."
}
]Schema de validación para el expediente de la verificacion. Las reglas que se definan aqui sera la que determine la finalizacion de la verificacion.
Show child attributes
Show child attributes
Version del schema de validacion, ahora solo soporta la version 2.
2, 1 Mapa de requerimientos donde la clave es un ID personalizado (por ejemplo, "doc_1")
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Etiqueta que se mostrará en la interfaz de usuario
"Constancia de Situación Fiscal"
Descripción detallada del requerimiento
"Documento que certifica que la empresa está al día con sus obligaciones fiscales."
Indica si el campo debe ser renderizado condicionalmente mediante un checkbox, que tiene como leyenda la propiedad conditional_render_label.
Etiqueta que se mostrará en la interfaz de usuario para el campo condicional.
"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?"
Lista de tipos de items permitidos para este requerimiento
Los siguientes son items basados en documentos.
aa_mx, ac_mx, bank_statement, cc_co_ops, csf_mx, fme_mx, person_id, proof_address, pw_mx ["csf_mx"]Show child attributes
Show child attributes
Determina el comportamiento de la verificacion cuando el tipo de item no es valido.
invalidate, ignore El subtipo de item que se permite para este requerimiento, solo algunos items tienen subtipos, como los csf, o los bank statements.
business, individual "business"
Show child attributes
Show child attributes
El alcance de las personas que deben ser consideradas en la verificación, aplica cuando el tipo de item es un person_id.
powers {
"doc_1": {
"ui_options": {
"label": "Constancia de Situación Fiscal",
"description": "Documento que certifica que la empresa está al día con sus obligaciones fiscales.",
"conditional_render": true,
"conditional_render_label": "¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?"
},
"allowed_item_types": ["csf_mx"],
"validation_options": { "on_invalid_type_error": "invalidate" }
}
}Mapa de requerimientos opcionales donde la clave es un ID personalizado (por ejemplo, "doc_1")
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Etiqueta que se mostrará en la interfaz de usuario
"Constancia de Situación Fiscal"
Descripción detallada del requerimiento
"Documento que certifica que la empresa está al día con sus obligaciones fiscales."
Indica si el campo debe ser renderizado condicionalmente mediante un checkbox, que tiene como leyenda la propiedad conditional_render_label.
Etiqueta que se mostrará en la interfaz de usuario para el campo condicional.
"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?"
Lista de tipos de items permitidos para este requerimiento
Los siguientes son items basados en documentos.
aa_mx, ac_mx, bank_statement, cc_co_ops, csf_mx, fme_mx, person_id, proof_address, pw_mx ["csf_mx"]Show child attributes
Show child attributes
Determina el comportamiento de la verificacion cuando el tipo de item no es valido.
invalidate, ignore El subtipo de item que se permite para este requerimiento, solo algunos items tienen subtipos, como los csf, o los bank statements.
business, individual "business"
Show child attributes
Show child attributes
El alcance de las personas que deben ser consideradas en la verificación, aplica cuando el tipo de item es un person_id.
powers País al que pertenece el flujo
mx, co Identificador único del flujo
Was this page helpful?