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": "jsmith@example.com",
"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"
}
'import requests
url = "https://api.gotrebol.com/account-flows"
payload = {
"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": "jsmith@example.com",
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: 'jsmith@example.com',
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'
})
};
fetch('https://api.gotrebol.com/account-flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gotrebol.com/account-flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => 'jsmith@example.com',
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gotrebol.com/account-flows"
payload := strings.NewReader("{\n \"friendly_name\": \"A FLOW name test\",\n \"id_slug\": \"id-test-flow\",\n \"flow_items\": {\n \"id\": \"enterprise-example-2\",\n \"items\": [\n {\n \"type\": \"rues\",\n \"options\": {\n \"nit\": \"\"\n }\n },\n {\n \"type\": \"ubos\",\n \"options\": {\n \"ubos_data_extraction\": true\n }\n },\n {\n \"type\": \"forms\",\n \"options\": {\n \"schema_id\": \"some-test-form-schema\",\n \"is_optional\": true\n }\n }\n ],\n \"options\": {\n \"creator_email\": \"jsmith@example.com\",\n \"next_steps_checkout\": [\n {\n \"title\": \"Documentos adicionales\",\n \"description\": \"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo.\"\n },\n {\n \"title\": \"Firma del contrato\",\n \"description\": \"Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato.\"\n }\n ]\n }\n },\n \"record_validation_schema\": {\n \"version\": 2,\n \"requirements\": {\n \"doc_1\": {\n \"ui_options\": {\n \"label\": \"Poderes del representante legal\",\n \"description\": \"Documento que certifica que el representante legal tiene los poderes para representar a la empresa.\",\n \"conditional_render\": true,\n \"conditional_render_label\": \"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?\"\n },\n \"allowed_item_types\": [\n \"pw_mx\",\n \"ac_mx\",\n \"aa_mx\"\n ]\n }\n },\n \"optional_requirements\": {}\n },\n \"country\": \"mx\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gotrebol.com/account-flows")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"friendly_name\": \"A FLOW name test\",\n \"id_slug\": \"id-test-flow\",\n \"flow_items\": {\n \"id\": \"enterprise-example-2\",\n \"items\": [\n {\n \"type\": \"rues\",\n \"options\": {\n \"nit\": \"\"\n }\n },\n {\n \"type\": \"ubos\",\n \"options\": {\n \"ubos_data_extraction\": true\n }\n },\n {\n \"type\": \"forms\",\n \"options\": {\n \"schema_id\": \"some-test-form-schema\",\n \"is_optional\": true\n }\n }\n ],\n \"options\": {\n \"creator_email\": \"jsmith@example.com\",\n \"next_steps_checkout\": [\n {\n \"title\": \"Documentos adicionales\",\n \"description\": \"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo.\"\n },\n {\n \"title\": \"Firma del contrato\",\n \"description\": \"Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato.\"\n }\n ]\n }\n },\n \"record_validation_schema\": {\n \"version\": 2,\n \"requirements\": {\n \"doc_1\": {\n \"ui_options\": {\n \"label\": \"Poderes del representante legal\",\n \"description\": \"Documento que certifica que el representante legal tiene los poderes para representar a la empresa.\",\n \"conditional_render\": true,\n \"conditional_render_label\": \"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?\"\n },\n \"allowed_item_types\": [\n \"pw_mx\",\n \"ac_mx\",\n \"aa_mx\"\n ]\n }\n },\n \"optional_requirements\": {}\n },\n \"country\": \"mx\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gotrebol.com/account-flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"friendly_name\": \"A FLOW name test\",\n \"id_slug\": \"id-test-flow\",\n \"flow_items\": {\n \"id\": \"enterprise-example-2\",\n \"items\": [\n {\n \"type\": \"rues\",\n \"options\": {\n \"nit\": \"\"\n }\n },\n {\n \"type\": \"ubos\",\n \"options\": {\n \"ubos_data_extraction\": true\n }\n },\n {\n \"type\": \"forms\",\n \"options\": {\n \"schema_id\": \"some-test-form-schema\",\n \"is_optional\": true\n }\n }\n ],\n \"options\": {\n \"creator_email\": \"jsmith@example.com\",\n \"next_steps_checkout\": [\n {\n \"title\": \"Documentos adicionales\",\n \"description\": \"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo.\"\n },\n {\n \"title\": \"Firma del contrato\",\n \"description\": \"Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato.\"\n }\n ]\n }\n },\n \"record_validation_schema\": {\n \"version\": 2,\n \"requirements\": {\n \"doc_1\": {\n \"ui_options\": {\n \"label\": \"Poderes del representante legal\",\n \"description\": \"Documento que certifica que el representante legal tiene los poderes para representar a la empresa.\",\n \"conditional_render\": true,\n \"conditional_render_label\": \"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?\"\n },\n \"allowed_item_types\": [\n \"pw_mx\",\n \"ac_mx\",\n \"aa_mx\"\n ]\n }\n },\n \"optional_requirements\": {}\n },\n \"country\": \"mx\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"ubos_schema_id": "ubos-custom-001",
"schema_id": "some-test-form-schema"
}
}
],
"options": {
"creator_email": "jsmith@example.com",
"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": {}
}
}Gestión de Flujos de Cuenta
Crear nuevo flujo
Crea un nuevo flujo de cuenta. Visita la guía de desarrollo para más información.
Nota: El cuerpo de la solicitud está limitado a 200 KB por nuestro WAF. Si tu configuración (reglas de validación, esquemas de formulario, listas de
flow_items, etc.) supera este tamaño, la solicitud será rechazada antes de llegar al backend. Revisa las recomendaciones de la guía para mantenerte dentro del límite.
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": "jsmith@example.com",
"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"
}
'import requests
url = "https://api.gotrebol.com/account-flows"
payload = {
"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": "jsmith@example.com",
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: 'jsmith@example.com',
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'
})
};
fetch('https://api.gotrebol.com/account-flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gotrebol.com/account-flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => 'jsmith@example.com',
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gotrebol.com/account-flows"
payload := strings.NewReader("{\n \"friendly_name\": \"A FLOW name test\",\n \"id_slug\": \"id-test-flow\",\n \"flow_items\": {\n \"id\": \"enterprise-example-2\",\n \"items\": [\n {\n \"type\": \"rues\",\n \"options\": {\n \"nit\": \"\"\n }\n },\n {\n \"type\": \"ubos\",\n \"options\": {\n \"ubos_data_extraction\": true\n }\n },\n {\n \"type\": \"forms\",\n \"options\": {\n \"schema_id\": \"some-test-form-schema\",\n \"is_optional\": true\n }\n }\n ],\n \"options\": {\n \"creator_email\": \"jsmith@example.com\",\n \"next_steps_checkout\": [\n {\n \"title\": \"Documentos adicionales\",\n \"description\": \"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo.\"\n },\n {\n \"title\": \"Firma del contrato\",\n \"description\": \"Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato.\"\n }\n ]\n }\n },\n \"record_validation_schema\": {\n \"version\": 2,\n \"requirements\": {\n \"doc_1\": {\n \"ui_options\": {\n \"label\": \"Poderes del representante legal\",\n \"description\": \"Documento que certifica que el representante legal tiene los poderes para representar a la empresa.\",\n \"conditional_render\": true,\n \"conditional_render_label\": \"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?\"\n },\n \"allowed_item_types\": [\n \"pw_mx\",\n \"ac_mx\",\n \"aa_mx\"\n ]\n }\n },\n \"optional_requirements\": {}\n },\n \"country\": \"mx\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gotrebol.com/account-flows")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"friendly_name\": \"A FLOW name test\",\n \"id_slug\": \"id-test-flow\",\n \"flow_items\": {\n \"id\": \"enterprise-example-2\",\n \"items\": [\n {\n \"type\": \"rues\",\n \"options\": {\n \"nit\": \"\"\n }\n },\n {\n \"type\": \"ubos\",\n \"options\": {\n \"ubos_data_extraction\": true\n }\n },\n {\n \"type\": \"forms\",\n \"options\": {\n \"schema_id\": \"some-test-form-schema\",\n \"is_optional\": true\n }\n }\n ],\n \"options\": {\n \"creator_email\": \"jsmith@example.com\",\n \"next_steps_checkout\": [\n {\n \"title\": \"Documentos adicionales\",\n \"description\": \"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo.\"\n },\n {\n \"title\": \"Firma del contrato\",\n \"description\": \"Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato.\"\n }\n ]\n }\n },\n \"record_validation_schema\": {\n \"version\": 2,\n \"requirements\": {\n \"doc_1\": {\n \"ui_options\": {\n \"label\": \"Poderes del representante legal\",\n \"description\": \"Documento que certifica que el representante legal tiene los poderes para representar a la empresa.\",\n \"conditional_render\": true,\n \"conditional_render_label\": \"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?\"\n },\n \"allowed_item_types\": [\n \"pw_mx\",\n \"ac_mx\",\n \"aa_mx\"\n ]\n }\n },\n \"optional_requirements\": {}\n },\n \"country\": \"mx\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gotrebol.com/account-flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"friendly_name\": \"A FLOW name test\",\n \"id_slug\": \"id-test-flow\",\n \"flow_items\": {\n \"id\": \"enterprise-example-2\",\n \"items\": [\n {\n \"type\": \"rues\",\n \"options\": {\n \"nit\": \"\"\n }\n },\n {\n \"type\": \"ubos\",\n \"options\": {\n \"ubos_data_extraction\": true\n }\n },\n {\n \"type\": \"forms\",\n \"options\": {\n \"schema_id\": \"some-test-form-schema\",\n \"is_optional\": true\n }\n }\n ],\n \"options\": {\n \"creator_email\": \"jsmith@example.com\",\n \"next_steps_checkout\": [\n {\n \"title\": \"Documentos adicionales\",\n \"description\": \"Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo.\"\n },\n {\n \"title\": \"Firma del contrato\",\n \"description\": \"Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato.\"\n }\n ]\n }\n },\n \"record_validation_schema\": {\n \"version\": 2,\n \"requirements\": {\n \"doc_1\": {\n \"ui_options\": {\n \"label\": \"Poderes del representante legal\",\n \"description\": \"Documento que certifica que el representante legal tiene los poderes para representar a la empresa.\",\n \"conditional_render\": true,\n \"conditional_render_label\": \"¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial?\"\n },\n \"allowed_item_types\": [\n \"pw_mx\",\n \"ac_mx\",\n \"aa_mx\"\n ]\n }\n },\n \"optional_requirements\": {}\n },\n \"country\": \"mx\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"ubos_schema_id": "ubos-custom-001",
"schema_id": "some-test-form-schema"
}
}
],
"options": {
"creator_email": "jsmith@example.com",
"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
Body
application/json
Identificador único del flujo. Solo puede contener letras, números, guiones(-) y guiones bajos(_).
Example:
"id-test-flow"
Show child attributes
Show child attributes
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
Response
Flujo creado exitosamente
Identificador único del flujo. Solo puede contener letras, números, guiones(-) y guiones bajos(_).
Example:
"id-test-flow"
Show child attributes
Show child attributes
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
Was this page helpful?
⌘I