Skip to main content
POST
/
account-flows
Crear nuevo flujo
curl --request POST \
  --url https://api.gotrebol.com/account-flows \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "friendly_name": "A FLOW name test",
  "id_slug": "id-test-flow",
  "flow_items": {
    "id": "enterprise-example-2",
    "items": [
      {
        "type": "rues",
        "options": {
          "nit": ""
        }
      },
      {
        "type": "ubos",
        "options": {
          "ubos_data_extraction": true
        }
      },
      {
        "type": "forms",
        "options": {
          "schema_id": "some-test-form-schema",
          "is_optional": true
        }
      }
    ],
    "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": "Poderes del representante legal",
          "description": "Documento que certifica que el representante legal tiene los poderes para representar a la empresa.",
          "conditional_render": true,
          "conditional_render_label": "¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?"
        },
        "allowed_item_types": [
          "pw_mx",
          "ac_mx",
          "aa_mx"
        ]
      }
    },
    "optional_requirements": {}
  },
  "country": "mx"
}
'
{
  "id": "<string>",
  "account_id": "<string>",
  "friendly_name": "<string>",
  "id_slug": "id-test-flow",
  "flow_items": {
    "id": "<string>",
    "items": [
      {
        "type": "generic",
        "options": {
          "is_optional": true,
          "ubos_threshold": 25,
          "ubos_form_schema": "mx_form",
          "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": {}
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
friendly_name
string
required
​
id_slug
string
required

Identificador único del flujo. Solo puede contener letras, números, guiones(-) y guiones bajos(_).

Example:

"id-test-flow"

​
flow_items
object
​
record_validation_schema
object

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.

Response

Flujo creado exitosamente

​
id
string
​
account_id
string
​
friendly_name
string
​
id_slug
string

Identificador único del flujo. Solo puede contener letras, números, guiones(-) y guiones bajos(_).

Example:

"id-test-flow"

​
flow_items
object
​
record_validation_schema
object

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.