Workflows API (stable)
Download OpenAPI specification:Download
Esta API genera flujos customizables para la ejecucion de procesos de negocio, de manera flexible y dinamica.
Flujos
Los flujos son la base de la API, estos contienen pasos que se ejecutan en orden, y que pueden ser customizados para cada caso de uso.
Pasos
Los pasos son las unidades de ejecucion de un flujo, estos pueden ser de diferentes tipos, y pueden ser customizados para cada caso de uso.
Listar Flujos
Authorizations:
query Parameters
| page | integer Default: 1 Example: page=1 Numero de pagina a consultar |
| per_page | integer Default: 20 Example: per_page=20 Cantidad de resultados por pagina a consultar |
| responsible_uuid | string <uuid> Filtra por el identificador del usuario responsable. |
| people_uuid | string <uuid> Filtra por el identificador de la persona asociada. |
| status | string Enum: "pristine" "working" "error" "success" "failed" "people_error" "rules_failed" "skipped" Filtra por el estado del flujo. |
| from_date | string <date-time> Fecha minima de creacion del flujo. |
| to_date | string <date-time> Fecha maxima de creacion del flujo. |
| external_reference_id | string Filtra por la referencia externa del flujo. |
| order | string Default: "desc" Enum: "asc" "desc" Orden de los resultados por fecha de creacion. |
Responses
Response samples
- 200
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
], - "from": 1,
- "per_page": 20,
- "to": 20
}
}Crear un Flujo
Authorizations:
Request Body schema: application/json
Parametros de creacion de un Flujo
| people_uuid | string or null <uuid> Identificador de persona |
| entity_uuid | string or null <uuid> Identificador de la entidad asociada al flujo |
| 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 Configuracion inicial indexada por el nombre completo 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 StepName (string) or strings (StepReference) non-empty Arreglo de steps para el workflow |
Responses
Request samples
- Payload
{- "people_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "entity_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "disable_geolocation": true,
- "responsible_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "external_reference_id": 123456,
- "skip_steps": {
- "acceptance": "enroll_full['payload']['biometrics']['matchLevel'] >= 5}"
}, - "rule_set_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "autofill": {
- "autosigning": true,
- "send_email": true,
- "template_binding_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "document_name": "Documento de prueba",
- "document_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "user_email": "example@mail.com"
}, - "setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}, - "metadata": {
- "user_id": "uuid",
- "location": "US",
- "customization_uuid": "uuid"
}, - "expires_in": 60,
- "steps": [
- "document_sign"
]
}Response samples
- 200
- 400
{- "success": true,
- "result": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}Buscar Flujos por referencia externa
Authorizations:
path Parameters
| externalReferenceId required | string Referencia externa asociada a los Flujos. |
Responses
Response samples
- 200
- 500
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
], - "from": 1,
- "per_page": 20,
- "to": 20
}
}Eliminar permanentemente un Flujo y sus datos
Elimina permanentemente el flujo, sus steps, archivos multimedia y datos biometricos asociados.
Authorizations:
path Parameters
| uuid required | string <uuid> Identificador del Flujo. |
Responses
Response samples
- 200
- 500
{- "success": true,
- "result": {
- "message": "Workflow and its steps deleted successfully"
}
}Inicializar un Flujo
Registra los metadatos internos del dispositivo e inicia la ejecucion del flujo.
Authorizations:
path Parameters
| uuid required | string <uuid> Identificador del Flujo asociado al token de sesion. |
Request Body schema: application/json
| ip | string or null Direccion IPv4 o IPv6 del dispositivo. |
| user_agent | string or null <= 500 characters |
| device_id | string or null <= 100 characters |
| device_name | string or null <= 100 characters |
| system_name | string or null <= 100 characters |
| system_version | string or null <= 100 characters |
| app_version | string or null <= 50 characters |
Responses
Request samples
- Payload
{- "ip": "string",
- "user_agent": "string",
- "device_id": "string",
- "device_name": "string",
- "system_name": "string",
- "system_version": "string",
- "app_version": "string"
}Response samples
- 200
- 400
- 403
- 404
{- "success": true,
- "result": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}Actualizar un Flujo en ejecucion
Authorizations:
path Parameters
| uuid required | string <uuid> Identificador del Flujo asociado al token de sesion. |
Request Body schema: application/json
object | |
| status | string Enum: "pristine" "working" "error" "success" "failed" "people_error" "rules_failed" "skipped" |
| error | object |
Responses
Request samples
- Payload
{- "internal_metadata": {
- "ip": "string",
- "user_agent": "string",
- "device_id": "string",
- "device_name": "string",
- "system_name": "string",
- "system_version": "string"
}, - "status": "pristine",
- "error": { }
}Response samples
- 200
- 400
- 403
- 404
{- "success": true,
- "result": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}Obtener detalle de un Flujo especifico
Authorizations:
path Parameters
| uuid required | string Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del Flujo |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}Generar token y URL de ejecucion del Flujo
Authorizations:
path Parameters
| uuid required | string Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del Flujo |
query Parameters
| redirect_url | string Example: redirect_url=http://example.com URL al que se redireccionara al terminar el Flujo |
| custom_domain | string Example: custom_domain=workflows.example.com Dominio personalizado para construir la URL publica del Flujo. |
| generate_qr | boolean Al incluir este parametro se genera un codigo QR de la URL publica, independientemente de su valor. |
Responses
Response samples
- 200
- 403
- 404
{- "success": true,
- "result": {
- "token": "16968|r45IXIJHr9QfpHayecgFOw1R9Cs36zundce7VYk7",
- "token_encoded": "MzZ8czJhQUpFOWI2Z3IyNGFLOVBFcnRJODRrZDhjZ2pDQ0hxWmFCWUtFMA==",
- "expiration": "2019-08-24T14:15:22Z",
- "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
- "workflow": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}
}Crear un token de acceso y URL de ejecucion del Flujo (Encode Safe)
Crear un token de acceso publico y URL de ejecucion del Flujo cuando hay problemas de encoding en la URL
Authorizations:
path Parameters
| uuid required | string Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del Flujo |
Request Body schema: application/json
Parametros de creacion de un token
| redirect_url | string URL al que se redireccionara al terminar el Flujo |
| custom_domain | string Dominio personalizado para construir la URL publica del Flujo. |
| generate_qr | boolean Al incluir esta propiedad se genera un codigo QR de la URL publica, independientemente de su valor. |
Responses
Request samples
- Payload
{- "custom_domain": "workflows.example.com",
- "generate_qr": true
}Response samples
- 200
- 403
- 404
{- "success": true,
- "result": {
- "token": "16968|r45IXIJHr9QfpHayecgFOw1R9Cs36zundce7VYk7",
- "token_encoded": "MzZ8czJhQUpFOWI2Z3IyNGFLOVBFcnRJODRrZDhjZ2pDQ0hxWmFCWUtFMA==",
- "expiration": "2019-08-24T14:15:22Z",
- "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
- "workflow": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}
}Response samples
- 200
- 404
{- "success": true,
- "result": [
- {
- "key": "enroll_simple",
- "title": "Enrolamiento simple",
- "description": "Setup de enrolamiento por medio de CURP.",
- "setup_required": "false,",
- "requires_people": "false,",
- "setup": { },
- "allow_multiple": "false,",
- "geolocation": false
}
]
}Obtener detalle del Step de un Flujo
Authorizations:
path Parameters
| uuid required | string Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del Step |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
}Obtener Media (Video, Images, Documents) adjuntos a un Step
Authorizations:
path Parameters
| uuid required | string Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del Step |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": [
- {
- "collection": "id_back",
- "createdAt": "2021-03-26T01:06:59.000000Z",
- "mime": "image/jpeg",
- "uuid": "52a7ac96-807f-4675-98a6-48d7383ade60",
- "size": 1500,
}
]
}Obtener Media (Video, Images, Documents) adjuntos a un Step
Authorizations:
path Parameters
| uuid required | string Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del Step |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": [
- {
- "collection": "id_back",
- "createdAt": "2021-03-26T01:06:59.000000Z",
- "mime": "image/jpeg",
- "uuid": "52a7ac96-807f-4675-98a6-48d7383ade60",
- "size": 1500,
}
]
}Response samples
- 200
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template 1",
- "description": "Template 1",
- "config": {
- "metadata": {
- "user_id": "9c701122-defd-4ee7-9cd2-c4eca68b7af2"
}, - "expires_in": 20,
- "disable_geolocation": true
}, - "steps": [
- "acceptance"
], - "steps_setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}, - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 20,
- "prev_page_url": null,
- "to": 20
}
}Crear una plantilla de workflow
Authorizations:
Request Body schema: application/json
| name required | string Nombre de la plantilla de workflow |
| description | string Descripcion de la plantilla de workflow |
required | Array of StepName (string) or strings (StepReference) non-empty Arreglo de pasos de la plantilla de workflow |
| config required | object Objeto de configuracion de la plantilla de workflow |
required | object or null Configuracion inicial indexada por el nombre completo del step ( |
Responses
Request samples
- Payload
{- "name": "Workflow Template 1",
- "description": "Workflow Template 1 description",
- "steps": [
- "acceptance"
], - "config": {
- "metadata": {
- "user_id": "{{$guid}}"
}, - "expires_in": 20,
- "disable_geolocation": true
}, - "steps_setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}
}Response samples
- 201
- 400
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template 1",
- "description": "Template 1",
- "config": {
- "metadata": {
- "user_id": "9c701122-defd-4ee7-9cd2-c4eca68b7af2"
}, - "expires_in": 20,
- "disable_geolocation": true
}, - "steps": [
- "acceptance"
], - "steps_setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}, - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Obtener una plantilla de workflow
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador de la plantilla de workflow |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template 1",
- "description": "Template 1",
- "config": {
- "metadata": {
- "user_id": "9c701122-defd-4ee7-9cd2-c4eca68b7af2"
}, - "expires_in": 20,
- "disable_geolocation": true
}, - "steps": [
- "acceptance"
], - "steps_setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}, - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Actualizar una plantilla de workflow
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador 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 |
Array of StepName (string) or strings (StepReference) non-empty Arreglo de pasos de la plantilla de workflow | |
| config | object Objeto de configuracion de la plantilla de workflow |
required | object or null Configuracion inicial indexada por el nombre completo del step ( |
Responses
Request samples
- Payload
{- "name": "Workflow Template 1",
- "description": "Workflow Template 1 description",
- "steps": [
- "acceptance"
], - "config": {
- "metadata": {
- "user_id": "{{$guid}}"
}, - "expires_in": 20,
- "disable_geolocation": true
}, - "steps_setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}
}Response samples
- 200
- 400
- 404
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template 1",
- "description": "Template 1",
- "config": {
- "metadata": {
- "user_id": "9c701122-defd-4ee7-9cd2-c4eca68b7af2"
}, - "expires_in": 20,
- "disable_geolocation": true
}, - "steps": [
- "acceptance"
], - "steps_setup": {
- "document_sign": {
- "token": "TOKEN",
- "store_sign": false
}
}, - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Crear un workflow a partir de una plantilla de workflow
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador de la plantilla de workflow |
Request Body schema: application/json
| overwrites | object Objeto de configuracion de la plantilla de workflow |
Responses
Request samples
- Payload
{- "overwrites": {
- "setup": {
- "enroll_full": {
- "user_id": "86b9535d-50d9-419c-9965-ee4db5956871"
}, - "verify_email": {
- "user_id": "86b9535d-50d9-419c-9965-ee4db5956871"
}
}
}
}Response samples
- 201
- 400
- 404
{- "success": true,
- "result": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}Response samples
- 200
- 404
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template Binding 1",
- "template_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "text_bindings": {
- "77cf87f8-385a-463a-8088-c95322d70b95": {
- "steps": [
- "personal_address"
], - "template": "{personal_address.country}"
}, - "c6e6c76e-5a15-4f5f-9649-795da3d54f00": {
- "steps": [
- "verify_email"
], - "template": "{verify_email.email}"
}
}, - "sign_bindings": [
- "77cf87f8-385a-463a-8088-c95322d70b95",
- "c6e6c76e-5a15-4f5f-9649-795da3d54f00"
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "from": 1,
- "per_page": 20,
- "prev_page_url": null,
- "to": 20
}
}Crear un template binding
Authorizations:
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
- Payload
{- "name": "Template Binding 1",
- "text_bindings": {
- "c6e6c76e-5a15-4f5f-9649-795da3d54f00": {
- "steps": [
- "verify_email"
], - "template": "{verify_email.email}"
}
}, - "sign_bindings": [
- "faf108d5-0fd4-4802-8e31-71b7a812680b"
], - "template_uuid": "86b9535d-50d9-419c-9965-ee4db5956871"
}Response samples
- 201
- 400
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template Binding 1",
- "template_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "text_bindings": {
- "77cf87f8-385a-463a-8088-c95322d70b95": {
- "steps": [
- "personal_address"
], - "template": "{personal_address.country}"
}, - "c6e6c76e-5a15-4f5f-9649-795da3d54f00": {
- "steps": [
- "verify_email"
], - "template": "{verify_email.email}"
}
}, - "sign_bindings": [
- "77cf87f8-385a-463a-8088-c95322d70b95",
- "c6e6c76e-5a15-4f5f-9649-795da3d54f00"
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Validar la sintaxis de una expresion
Authorizations:
Request Body schema: application/json
| expression required | string Expresion a validar |
| data_names | Array of strings Nombres de variables permitidas en la expresion. |
Responses
Request samples
- Payload
{- "expression": "5 > 10 ? 'true': 'false'",
- "data_names": [
- "string"
]
}Response samples
- 200
- 400
{- "success": true,
- "result": "Ok"
}Obtener un template binding
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del template binding |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template Binding 1",
- "template_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "text_bindings": {
- "77cf87f8-385a-463a-8088-c95322d70b95": {
- "steps": [
- "personal_address"
], - "template": "{personal_address.country}"
}, - "c6e6c76e-5a15-4f5f-9649-795da3d54f00": {
- "steps": [
- "verify_email"
], - "template": "{verify_email.email}"
}
}, - "sign_bindings": [
- "77cf87f8-385a-463a-8088-c95322d70b95",
- "c6e6c76e-5a15-4f5f-9649-795da3d54f00"
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Actualizar un template binding
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador 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
- Payload
{- "name": "Template Binding 1",
- "text_bindings": {
- "c6e6c76e-5a15-4f5f-9649-795da3d54f00": {
- "steps": [
- "verify_email"
], - "template": "{verify_email.email}"
}
}, - "sign_bindings": [
- "faf108d5-0fd4-4802-8e31-71b7a812680b"
]
}Response samples
- 200
- 400
- 404
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Template Binding 1",
- "template_uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "text_bindings": {
- "77cf87f8-385a-463a-8088-c95322d70b95": {
- "steps": [
- "personal_address"
], - "template": "{personal_address.country}"
}, - "c6e6c76e-5a15-4f5f-9649-795da3d54f00": {
- "steps": [
- "verify_email"
], - "template": "{verify_email.email}"
}
}, - "sign_bindings": [
- "77cf87f8-385a-463a-8088-c95322d70b95",
- "c6e6c76e-5a15-4f5f-9649-795da3d54f00"
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Response samples
- 200
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 20,
- "prev_page_url": null,
- "to": 20
}
}Crear una regla de knockout
Authorizations:
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 (StepName) Enum: "acceptance" "address_proof" "address_verification" "auth" "biometric_sign" "cdc_authorization" "custom_form" "document_analyzer" "document_preview" "document_qr" "document_sign" "enroll_basic" "enroll_entity" "enroll_fingerprint" "enroll_full" "enroll_simple" "face_enrollment_3d" "files_upload" "finflux_offers" "lead_verify" "liveness" "liveness_2d" "multiple_document_sign" "password_sign" "personal_address" "personal_bank_data" "personal_financial" "personal_job_detail" "personal_references" "verify_email" "verify_phone_number" Nombre de un step disponible. La disponibilidad puede restringirse por ambiente mediante DISABLE_STEPS. |
Responses
Request samples
- Payload
{- "name": "Knockout Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance"
}Response samples
- 201
- 400
{- "success": true,
- "result": {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Obtener una regla de knockout
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador de la regla de knockout |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Actualizar una regla de knockout
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador 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 (StepName) Enum: "acceptance" "address_proof" "address_verification" "auth" "biometric_sign" "cdc_authorization" "custom_form" "document_analyzer" "document_preview" "document_qr" "document_sign" "enroll_basic" "enroll_entity" "enroll_fingerprint" "enroll_full" "enroll_simple" "face_enrollment_3d" "files_upload" "finflux_offers" "lead_verify" "liveness" "liveness_2d" "multiple_document_sign" "password_sign" "personal_address" "personal_bank_data" "personal_financial" "personal_job_detail" "personal_references" "verify_email" "verify_phone_number" Nombre de un step disponible. La disponibilidad puede restringirse por ambiente mediante DISABLE_STEPS. |
Responses
Request samples
- Payload
{- "name": "Knockout Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance"
}Response samples
- 200
- 404
{- "success": true,
- "result": {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Response samples
- 200
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "name": "Rule Set 1",
- "description": "Rule Set 1",
- "active": true,
- "knockoutRules": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 20,
- "prev_page_url": null,
- "to": 20
}
}Crear un conjunto de reglas
Authorizations:
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
- Payload
{- "name": "Rule Set 1",
- "description": "Rule Set 1 description",
- "active": true,
- "knockout_rules": [
- "86b9535d-50d9-419c-9965-ee4db5956871",
- "86b9535d-50d9-419c-9965-ee4db5956871"
]
}Response samples
- 201
- 400
{- "success": true,
- "result": {
- "name": "Rule Set 1",
- "description": "Rule Set 1",
- "active": true,
- "knockoutRules": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Obtener un conjunto de reglas
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del conjunto de reglas |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "name": "Rule Set 1",
- "description": "Rule Set 1",
- "active": true,
- "knockoutRules": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Actualizar un conjunto de reglas
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador 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
- Payload
{- "name": "Rule Set 1",
- "description": "Rule Set 1 description",
- "active": true
}Response samples
- 200
- 404
{- "success": true,
- "result": {
- "name": "Rule Set 1",
- "description": "Rule Set 1",
- "active": true,
- "knockoutRules": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Agregar reglas a un conjunto de reglas
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del conjunto de reglas |
Request Body schema: application/json
| knockout_rules | Array of strings <uuid> Arreglo de reglas |
Responses
Request samples
- Payload
{- "knockout_rules": [
- "86b9535d-50d9-419c-9965-ee4db5956871",
- "86b9535d-50d9-419c-9965-ee4db5956871"
]
}Response samples
- 200
- 400
- 404
{- "success": true,
- "result": {
- "name": "Rule Set 1",
- "description": "Rule Set 1",
- "active": true,
- "knockoutRules": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Eliminar reglas de un conjunto de reglas
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador del conjunto de reglas |
Request Body schema: application/json
| knockout_rules | Array of strings <uuid> Arreglo de reglas |
Responses
Request samples
- Payload
{- "knockout_rules": [
- "86b9535d-50d9-419c-9965-ee4db5956871",
- "86b9535d-50d9-419c-9965-ee4db5956871"
]
}Response samples
- 200
- 400
- 404
{- "success": true,
- "result": {
- "name": "Rule Set 1",
- "description": "Rule Set 1",
- "active": true,
- "knockoutRules": [
- {
- "name": "Rule 1",
- "template": "email != 'example@example.com'",
- "active": true,
- "step": "acceptance",
- "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
], - "created_at": "2021-03-26T01:06:59.000000Z",
- "updated_at": "2021-03-26T01:06:59.000000Z"
}
}Response samples
- 200
{- "success": true,
- "result": {
- "current_page": 1,
- "data": [
- {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Customization 1",
- "values": {
- "auth": {
- "title": "Autentica con tu rostro",
- "errors": {
- "an_error_occurred": "Ocurrió un problema"
}, - "legend": "Coloca tu rostro en el recuadro",
- "description": "Sigue las instrucciones para validar tu identidad."
}
}
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 20,
- "prev_page_url": null,
- "to": 20
}
}Crear una personalizacion
Authorizations:
Request Body schema: application/json
| name | string Nombre de la personalizacion |
| values | object Valores de la personalizacion |
Responses
Request samples
- Payload
{- "name": "Customization 1",
- "values": {
- "auth": {
- "title": "Autentica con tu rostro",
- "errors": {
- "an_error_occurred": "Ocurrió un problema"
}, - "legend": "Coloca tu rostro en el recuadro",
- "description": "Sigue las instrucciones para validar tu identidad."
}
}
}Response samples
- 201
- 400
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Customization 1",
- "values": {
- "auth": {
- "title": "Autentica con tu rostro",
- "errors": {
- "an_error_occurred": "Ocurrió un problema"
}, - "legend": "Coloca tu rostro en el recuadro",
- "description": "Sigue las instrucciones para validar tu identidad."
}
}
}
}Obtener una personalizacion
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador de la personalizacion |
Responses
Response samples
- 200
- 404
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Customization 1",
- "values": {
- "auth": {
- "title": "Autentica con tu rostro",
- "errors": {
- "an_error_occurred": "Ocurrió un problema"
}, - "legend": "Coloca tu rostro en el recuadro",
- "description": "Sigue las instrucciones para validar tu identidad."
}
}
}
}Actualizar una personalizacion
Authorizations:
path Parameters
| uuid required | string <uuid> Example: 86b9535d-50d9-419c-9965-ee4db5956871 Identificador de la personalizacion |
Request Body schema: application/json
| name | string Nombre de la personalizacion |
| values | object Valores de la personalizacion |
Responses
Request samples
- Payload
{- "name": "Customization 1",
- "values": {
- "auth": {
- "title": "Autentica con tu rostro",
- "errors": {
- "an_error_occurred": "Ocurrió un problema"
}, - "legend": "Coloca tu rostro en el recuadro",
- "description": "Sigue las instrucciones para validar tu identidad."
}
}
}Response samples
- 200
- 404
{- "success": true,
- "result": {
- "uuid": "86b9535d-50d9-419c-9965-ee4db5956871",
- "name": "Customization 1",
- "values": {
- "auth": {
- "title": "Autentica con tu rostro",
- "errors": {
- "an_error_occurred": "Ocurrió un problema"
}, - "legend": "Coloca tu rostro en el recuadro",
- "description": "Sigue las instrucciones para validar tu identidad."
}
}
}
}Notificacion de actualizacion de Step/Flujo Webhook
Authorizations:
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
- Payload
{- "event": "update",
- "resource": "workflow",
- "resource_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "payload": {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "responsible_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "people_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "entity_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "status": "pristine",
- "disable_geolocation": true,
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "lead_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "credit_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "skip_steps": {
- "document_sign": "enroll_full['payload']['biometrics']['matchLevel'] >= 5"
}, - "error": {
- "fatal": true,
- "extra": {
- "user_id": "uuid",
- "location": "US"
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "external_reference_id": 123456789,
- "callback_at": "2022-04-12T22:10:12.000000Z",
- "expires_in": 60,
- "metadata": {
- "user_id": "uuid",
- "location": "US"
}, - "internal_metadata": {
- "ip": "192.0.2.1",
- "user_agent": "Mozilla/5.0",
- "device_id": "device-123",
- "device_name": "iPhone 15",
- "system_name": "iOS",
- "system_version": "18.0",
- "app_version": "2.5.3"
}, - "template_binding_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "rule_set_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "document_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "user_email": "user@example.com",
- "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z",
- "steps": [
- {
- "uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "workflow_uuid": "cf455647-34ad-4bf2-900a-83f385b07927",
- "custom_id": "1",
- "coordinates": [
- [
- "-99.123456",
- "19.123456"
]
], - "error": {
- "fatal": true,
- "extra": {
- "idScanStatus": 500,
- "faceScanStatus": 500
}, - "details": {
- "reason": "Error al obtener la selfie",
- "error_id": 500,
- "stack": "Error al obtener la selfie"
}
}, - "metadata": {
- "name": "enroll_full",
- "title": "Enrolamiento Completo",
- "description": "Enrolamiento biometrico y obtencion de selfie con identificacion oficial"
}, - "status": "string",
- "step": "document_sign",
- "started_at": "2022-04-12T22:10:12.000000Z",
- "finished_at": "2022-04-12T22:10:12.000000Z",
- "payload": {
- "biometrics": {
- "safe": true,
- "success": true,
- "matchLevel": 7,
- "executed_at": "2023-04-27T21:29:06.162Z",
- "referenceId": "dev-123adc51-ff0e-44f0-af93-456cad813dca",
- "wasProcessed": true,
- "nfcStatusEnumInt": 0,
- "fullIDStatusEnumInt": 0,
- "barcodeStatusEnumInt": 0,
- "matchLevelNFCToFaceMap": 0,
- "digitalIDSpoofStatusEnumInt": 0,
- "faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
- "textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
- "idScanAgeEstimateGroupEnumInt": 4
}, - "ocr_backside": {
- "cic": "8596841236",
- "date": "990311",
- "name": "JUAN",
- "lines": [
- "IDMEX85968412367<<4578965896412",
- "9903110H3112319MEX<06<<16540<3",
- "PEREZ<GONZALES<<JUAN<<<<<<<<<<"
], - "gender": "H",
- "last_name": "PEREZ",
- "last_names": "PEREZ GONZALES",
- "ocr_number": "4578965896412",
- "nationality": "MEX",
- "cic_digit_check": "7",
- "expiration_date": "241231",
- "date_check_digit": "0",
- "emission_and_fuar": "06-16540",
- "mothers_last_name": "GONZALEZ",
- "expiration_date_digit": "9",
- "section_and_consecutive": "54236975896321",
- "is_cic_digit_check_consistent": true
}, - "ocr_frontside": {
- "city": "XOCHIMILCO",
- "curp": "PEGU990311HDFRMZA4",
- "name": "JUAN",
- "type": "INE",
- "gender": "H",
- "street": "CALLE 1",
- "city_id": null,
- "control": "2",
- "ine_type": "EFGH",
- "province": "CDMX",
- "state_id": null,
- "zip_code": "01000",
- "last_name": "PEREZ",
- "birth_date": "1999-03-11",
- "elector_key": "PRJMER99031109H900",
- "neighborhood": "COL CENTRO",
- "emission_number": "06",
- "expiration_date": null,
- "mothers_last_name": "GOZALEZ"
}, - "is_address_complete": true
}, - "updated_at": "2022-04-12T22:10:12.000000Z",
- "created_at": "2022-04-12T22:10:12.000000Z"
}
]
}
}Crear un receptor de webhooks
En la API privada requiere apiKey y workflow_uuid es opcional. En el host publico requiere una sesion de workflow y el receptor queda asociado a ese workflow.
Authorizations:
Request Body schema: application/json
| workflow_uuid | string <uuid> Disponible unicamente en la API privada |
| max_events | integer >= 1 Usa el valor configurado por defecto cuando se omite |
Responses
Request samples
- Payload
{- "workflow_uuid": "5f472623-08f6-4789-89f2-effc00ed9ea8",
- "max_events": 1
}Response samples
- 201
- 400
- 403
{- "success": true,
- "result": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "workflow_uuid": "5f472623-08f6-4789-89f2-effc00ed9ea8",
- "status": "open",
- "max_events": 1,
- "received_events": 0,
- "remaining_events": 0,
- "completed_at": "2019-08-24T14:15:22Z"
}
}Consultar el estado y requests de un receptor
La consulta publica requiere la sesion del workflow asociado. Las requests se eliminan automaticamente al superar el periodo de retencion configurado y los receptores se eliminan despues del mismo periodo sin actividad, 30 dias por defecto.
Authorizations:
path Parameters
| uuid required | string <uuid> |
query Parameters
| per_page | integer [ 1 .. 100 ] Default: 20 |
Responses
Response samples
- 200
- 403
- 404
{- "success": true,
- "result": {
- "receiver": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "workflow_uuid": "5f472623-08f6-4789-89f2-effc00ed9ea8",
- "status": "open",
- "max_events": 1,
- "received_events": 0,
- "remaining_events": 0,
- "completed_at": "2019-08-24T14:15:22Z"
}, - "requests": {
- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "method": "POST",
- "headers": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "query": { },
- "body": { },
- "content_type": "application/json",
- "ip_address": "string",
- "received_at": "2019-08-24T14:15:22Z"
}
]
}
}
}Recibir y guardar un evento de webhook
Cada llamada se almacena de forma independiente. Al alcanzar max_events, las llamadas posteriores reciben HTTP 410.
path Parameters
| uuid required | string <uuid> |
Request Body schema:
Responses
Request samples
- Payload
nullResponse samples
- 404
{- "success": false,
- "error": "No query results for model [App\\Models\\Workflow] 08e950b5-0806-4c13-bf25-dd1130d7c07"
}


