Skip to main content
Documentation Powered by Redocly

API para gestión de workflows. (stable)

Download OpenAPI specification:Download

Gestión y ejecución de flujos dinámicos

Esta API permite la creación y ejecución de flujos de negocio personalizables, brindando flexibilidad y dinamismo para diversos procesos.

Flujos

Un flujo es una secuencia ordenada de pasos, personalizable según el caso de uso.

Pasos

Cada paso es una unidad de ejecución dentro del flujo, pudiendo ser de distintos tipos y ajustarse a requerimientos específicos.

Workflows

Manejo de flujos

Obtener la lista de flujos.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1
Example: page=1

Número de página para la consulta de resultados.

per_page
integer <= 100
Default: 10
Example: per_page=10

Cantidad máxima de resultados por página (hasta 100).

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Crear un nuevo flujo.

Authorizations:
apiKey
Request Body schema: application/json

Parámetros requeridos para crear un flujo.

people_uuid
string or null <uuid>

Identificador de persona

callback_url
string or null

URL de notificaciones por medio de Webhook (debe ser HTTPS)

disable_geolocation
boolean or null

Indica si se desea deshabilitar la geolocalizacion en los pasos

responsible_uuid
string or null <uuid>

Identificador de usuario responsable del flujo

external_reference_id
string or null

Referencia externa de ID para el usuario que ejecuta el flujo

skip_steps
object or null

Pasos a saltar en el flujo, se usa la llave con el nombre del paso

rule_set_uuid
string or null <uuid>

Identificador de conjunto de reglas a aplicar al flujo

object or null

Datos para autollenado de campos

object or null

Algunos steps requieren un Setup inicial, en este parametro se envian tales configuraciones usando la llave con el nombre del Step

metadata
object or null

Metadatos del Flujo, con la propiedad customization_uuid se puede personalizar el contenido de los textos mostrados en los Steps.

expires_in
integer
Default: 0

Tiempo en que tarda en expirar el token de este Flujo en minutos. Este campo se omite o se envia en 0 si no se queire que caduque.

required
Array of Auth (string) or Biometric Sign (string) or Document Sign (string) or Enroll Basic (string) or Enroll Full (string) or Enroll Simple (string) or Liveness (string) or Document Preview (string) or Verify Email (string) or Verify Phone Number (string) or Personal Address (string) or CDC Authorization (string) or Document Analyzer (string) or Acceptance (string) or Files Upload (string) or Document QR (string) or Personal Financial (string) or Personal Job Detail (string) or Personal References (string) or Personal Bank Data (string) or Custom Form (string) or Address Verificacion (string) or Multiple Document Sign (string) or Enroll Fingerprint (string) >= 1 [ items unique ]

Arreglo de steps para el workflow

Responses

Request samples

Content type
application/json
{
  • "people_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
  • "callback_url": "https://webhook.com",
  • "disable_geolocation": true,
  • "responsible_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
  • "external_reference_id": 123456,
  • "skip_steps": {
    },
  • "rule_set_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
  • "autofill": {
    },
  • "setup": {
    },
  • "metadata": {
    },
  • "expires_in": 60,
  • "steps": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Consultar el detalle de un flujo específico.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del Flujo.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar un flujo existente.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del Flujo.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": true
}

Generar token y URL de ejecución del flujo.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del Flujo.

query Parameters
redirect_url
string
Example: redirect_url=http://example.com

URL donde se redirigirá al finalizar el Flujo.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crear un token de acceso y una URL de ejecución del flujo (soporte para encoding seguro).

Genera un token de acceso público y una URL para ejecutar el Flujo, útil cuando existen problemas de encoding en la URL.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del Flujo.

Request Body schema: application/json

Parámetros requeridos para la creación de un token.

redirect_url
string

URL al que se redireccionara al terminar el Flujo

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Steps

Pasos de un flujo

Obtener metadatos de los Steps disponibles.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Consultar el detalle de un Step de un flujo.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador del Step

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener los archivos multimedia (videos, imágenes, documentos) asociados a un Step.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador del Step

Responses

Media

Media que se adjunto dentro de los pasos de un flujo

Obtener los archivos multimedia (videos, imágenes, documentos) asociados a un Step.

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador del Step

Responses

Templates

Templates para preconfigurar flujos

Obtener todas las plantillas de workflow.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crear una nueva plantilla de workflow.

Authorizations:
apiKey
Request Body schema: application/json
name
string

Nombre de la plantilla de workflow

description
string

Descripcion de la plantilla de workflow

steps
Array of strings
Items Enum: "acceptance" "auth" "biometric_sign" "cdc_authorization" "document_analyzer" "document_preview" "document_qr" "document_sign" "enroll_basic" "enroll_full" "enroll_simple" "files_upload" "personal_address" "verify_email" "verify_phone_number" "video_sign_step"

Arreglo de pasos de la plantilla de workflow

config
object

Objeto de configuracion de la plantilla de workflow

steps_setup
object

Responses

Request samples

Content type
application/json
{
  • "name": "Workflow Template 1",
  • "description": "Workflow Template 1 description",
  • "steps": [
    ],
  • "config": {
    },
  • "steps_setup": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener los detalles de una plantilla de workflow.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la plantilla de workflow.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar una plantilla de workflow.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la plantilla de workflow.

Request Body schema: application/json
name
string

Nombre de la plantilla de workflow

description
string

Descripcion de la plantilla de workflow

steps
Array of strings
Items Enum: "acceptance" "auth" "biometric_sign" "cdc_authorization" "document_analyzer" "document_preview" "document_qr" "document_sign" "enroll_basic" "enroll_full" "enroll_simple" "files_upload" "personal_address" "verify_email" "verify_phone_number" "video_sign_step"

Arreglo de pasos de la plantilla de workflow

config
object

Objeto de configuracion de la plantilla de workflow

steps_setup
object

Responses

Request samples

Content type
application/json
{
  • "name": "Workflow Template 1",
  • "description": "Workflow Template 1 description",
  • "steps": [
    ],
  • "config": {
    },
  • "steps_setup": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar una plantilla de workflow.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la plantilla de workflow.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Crear un workflow a partir de una plantilla de workflow.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la plantilla de workflow.

Request Body schema: application/json
overwrites
object

Objeto de configuracion de la plantilla de workflow

Responses

Request samples

Content type
application/json
{
  • "overwrites": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Template Bindings

Templates de autollenado de documentos

Obtener los template bindings definidos.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {}
}

Crear un nuevo template binding.

Authorizations:
apiKey
Request Body schema: application/json
name
string

Nombre del template binding

text_bindings
object

Objeto de campos de texto del template binding

sign_bindings
Array of strings <uuid>

Arreglo de campos de firma del template binding

template_uuid
string

Identificador del template

Responses

Request samples

Content type
application/json
{
  • "name": "Template Binding 1",
  • "text_bindings": {
    },
  • "sign_bindings": [
    ],
  • "template_uuid": "86b9535d-50d9-419c-9965-ee4db5956871"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Validar la sintaxis de una expresión.

Authorizations:
apiKey
Request Body schema: application/json
expression
string

Expresion a validar

Responses

Request samples

Content type
application/json
{
  • "expression": "5 > 10 ? 'true': 'false'"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Consultar un template binding específico.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del template binding.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar un template binding existente.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del template binding.

Request Body schema: application/json
name
string

Nombre del template binding

text_bindings
object

Objeto de campos de texto del template binding

sign_bindings
Array of strings

Arreglo de campos de firma del template binding

Responses

Request samples

Content type
application/json
{
  • "name": "Template Binding 1",
  • "text_bindings": {
    },
  • "sign_bindings": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar un template binding.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del template binding.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Knockout Rules

Reglas para ejecutar flujos

Obtener todas las reglas de knockout.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crear una nueva regla de knockout.

Authorizations:
apiKey
Request Body schema: application/json
name
string

Nombre de la regla de knockout

template
string

Plantilla de knockout

active
boolean

Indica si la regla de knockout esta activa

step
string
Enum: "acceptance" "auth" "biometric_sign" "cdc_authorization" "document_analyzer" "document_preview" "document_qr" "document_sign" "enroll_basic" "enroll_full" "enroll_simple" "files_upload" "personal_address" "verify_email" "verify_phone_number"

Tipo de step

Responses

Request samples

Content type
application/json
{
  • "name": "Knockout Rule 1",
  • "template": "email != 'example@example.com'",
  • "active": true,
  • "step": "acceptance"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Consultar los detalles de una regla de knockout.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la regla de knockout.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar una regla de knockout.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la regla de knockout.

Request Body schema: application/json
name
string

Nombre de la regla de knockout

template
string

Plantilla de knockout

active
boolean

Indica si la regla de knockout esta activa

step
string
Enum: "acceptance" "auth" "biometric_sign" "cdc_authorization" "document_analyzer" "document_preview" "document_qr" "document_sign" "enroll_basic" "enroll_full" "enroll_simple" "files_upload" "personal_address" "verify_email" "verify_phone_number"

Tipo de step

Responses

Request samples

Content type
application/json
{
  • "name": "Knockout Rule 1",
  • "template": "email != 'example@example.com'",
  • "active": true,
  • "step": "acceptance"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar una regla de knockout.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la regla de knockout.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Rule Sets

Conjuntos de reglas para ejecutar flujos

Obtener todas las reglas de knockout.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crear un conjunto de reglas.

Authorizations:
apiKey
Request Body schema: application/json
name
string

Nombre del conjunto de reglas

description
string

Descripcion del conjunto de reglas

active
boolean

Indica si el conjunto de reglas esta activo

knockout_rules
Array of strings <uuid>

Arreglo de reglas

Responses

Request samples

Content type
application/json
{
  • "name": "Rule Set 1",
  • "description": "Rule Set 1 description",
  • "active": true,
  • "knockout_rules": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Consultar los detalles de un conjunto de reglas.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del conjunto de reglas.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar un conjunto de reglas existente.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del conjunto de reglas.

Request Body schema: application/json
name
string

Nombre del conjunto de reglas

description
string

Descripcion del conjunto de reglas

active
boolean

Indica si el conjunto de reglas esta activo

Responses

Request samples

Content type
application/json
{
  • "name": "Rule Set 1",
  • "description": "Rule Set 1 description",
  • "active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar un conjunto de reglas.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del conjunto de reglas.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Agregar reglas a un conjunto ya existente.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del conjunto de reglas.

Request Body schema: application/json
knockout_rules
Array of strings <uuid>

Arreglo de reglas

Responses

Request samples

Content type
application/json
{
  • "knockout_rules": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar reglas de un conjunto.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único del conjunto de reglas.

Request Body schema: application/json
knockout_rules
Array of strings <uuid>

Arreglo de reglas

Responses

Request samples

Content type
application/json
{
  • "knockout_rules": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Customizations

Customizaciones para personalizar flujos

Obtener todas las personalizaciones disponibles.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crear una nueva personalización.

Authorizations:
apiKey
Request Body schema: application/json
name
string

Nombre de la personalizacion

values
object

Valores de la personalizacion

Responses

Request samples

Content type
application/json
{
  • "name": "Customization 1",
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Consultar una personalización específica.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la personalización.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar una personalización existente.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la personalización.

Request Body schema: application/json
name
string

Nombre de la personalizacion

values
object

Valores de la personalizacion

Responses

Request samples

Content type
application/json
{
  • "name": "Customization 1",
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Eliminar una personalización.

Authorizations:
apiKey
path Parameters
uuid
required
string <uuid>
Example: 86b9535d-50d9-419c-9965-ee4db5956871

Identificador único de la personalización.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Webhooks

Notificaciones de eventos de un flujo por medio de webhooks

Notificacion de actualizacion de Step/Flujo Webhook

Authorizations:
apiKey
Request Body schema: application/json
event
string
Enum: "update" "create"
resource
string
Enum: "workflow" "step"
resource_uuid
string
Workflow (object) or WorkflowStep (object)

Responses

Request samples

Content type
application/json
{
  • "event": "update",
  • "resource": "workflow",
  • "resource_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
  • "payload": {
    }
}
rem

JOIN US ON

facebooktwitterLinkedIn
AVISOS DE PRIVACIDADClientesProveedoresTrabajadoresUsuarios
POLÍTICASSeguridad de la informaciónTransferencia de datosPolítica disciplinaria
CONTACThello@rem.tools55-91-03-80-54
© Copyright rem 2022 All rights reserved.