Skip to main content
Documentation Powered by Redocly

API de gestión de personas. (stable)

Download OpenAPI specification:Download

La API permite administrar información de personas, quienes son el recurso principal del sistema. Es posible crear, consultar, modificar y eliminar registros de personas. Además, cada persona puede estar asociada a direcciones, referencias, validaciones, archivos, canales de notificación, empleos, datos bancarios y financieros.

Nota: La estructura admite la gestión integral del historial y atributos de cada persona.

Catalogs

Catalogos para personas

Catálogo de tipos de relaciones personales.

Authorizations:
apiKey

Responses

Response samples

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

Elemento de un catálogo de relaciones.

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Catálogo de estados civiles disponibles.

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catálogo de estados civiles.

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Catálogo de nacionalidades.

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catálogo de nacionalidades.

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Catálogo de estados de México.

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catálogo de estados.

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

People Groups

Administracion de los grupos de personas

Lista los grupos de personas registrados.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Registrar un nuevo grupo de personas.

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

Responses

Request samples

Content type
application/json
{
  • "name": "Deudores",
  • "description": "Grupo donde entran las personas con deuda pendiente de pagar"
}

Response samples

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

Recupera los grupos de personas registrados.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualiza los datos de un grupo de personas.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "Deudores",
  • "description": "Grupo donde entran las personas con deuda pendiente de pagar"
}

Response samples

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

Eliminar un grupo de personas del registro.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

People

Informacion relacionada con las personas

Consulta la lista de personas registradas.

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

Responses

Response samples

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

Registrar una nueva persona en el sistema.

Authorizations:
apiKey
Request Body schema: application/json
national_id
required
string

CURP oficial de la persona en México, clave única nacional.

name
required
string

Nombre oficial de la persona.

first_lastname
required
string

Primer apellido registrado de la persona.

second_lastname
required
string

Segundo apellido registrado de la persona.

birthdate
string <date>

Fecha oficial de nacimiento de la persona.

gender
string
Enum: "MALE" "FEMALE"

Sexo registrado de la persona.

tax_id
string

RFC de la persona en México.

nationality_id
integer

Identificador del catálogo de nacionalidades utilizado, 144 corresponde, por ejemplo, a México.

state_id
integer

Identificador de estado dentro del catálogo nacional.

entity_of_birth
string

Texto libre para el nombre del estado de nacimiento.

external_ref_id
string

Identificador externo personalizado de la persona.

facetec_ref_id
string

Referencia a registro en la base de Facetec.

biometrics
object

Datos biométricos almacenados sobre la persona.

marital_status_id
integer

Identificador del estado civil de la persona según catálogos internos.

people_group_id
string <uuid>

Identificador del grupo de pertenencia de la persona.

extra_data
object

Campo de uso libre para información adicional sobre la persona.

ignore_curp_validation
boolean

Indica si se debe omitir la validación del CURP (ID nacional) para esta persona.

Responses

Request samples

Content type
application/json
{
  • "national_id": "PESJ880212HDFHLX01",
  • "name": "Juan",
  • "first_lastname": "Perez",
  • "second_lastname": "Suares",
  • "birthdate": "1988-02-12T00:00:00Z",
  • "gender": "MALE",
  • "tax_id": null,
  • "nationality_id": 144,
  • "state_id": 7,
  • "entity_of_birth": "DF",
  • "external_ref_id": null,
  • "facetec_ref_id": null,
  • "biometrics": null,
  • "marital_status_id": null,
  • "people_group_id": null,
  • "extra_data": null,
  • "ignore_curp_validation": false
}

Response samples

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

Consultar los datos de una persona por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar los datos de una persona por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
national_id
string

CURP oficial de la persona en México, clave única nacional.

name
string

Nombre oficial de la persona.

first_lastname
string

Primer apellido registrado de la persona.

second_lastname
string

Segundo apellido registrado de la persona.

birthdate
string <date>

Fecha oficial de nacimiento de la persona.

gender
string
Enum: "MALE" "FEMALE"

Sexo registrado de la persona.

tax_id
string

RFC de la persona en México.

nationality_id
integer

Identificador del catálogo de nacionalidades utilizado, 144 corresponde, por ejemplo, a México.

state_id
integer

Identificador de estado dentro del catálogo nacional.

entity_of_birth
string

Texto libre para el nombre del estado de nacimiento.

external_ref_id
string

Identificador externo personalizado de la persona.

facetec_ref_id
string

Referencia a registro en la base de Facetec.

biometrics
object

Datos biométricos almacenados sobre la persona.

marital_status_id
integer

Identificador del estado civil de la persona según catálogos internos.

people_group_id
string <uuid>

Identificador del grupo de pertenencia de la persona.

extra_data
object

Campo de uso libre para información adicional sobre la persona.

ignore_curp_validation
boolean

Indica si se debe omitir la validación del CURP (ID nacional) para esta persona.

Responses

Request samples

Content type
application/json
{
  • "national_id": "PESJ880212HDFHLX01",
  • "name": "Juan",
  • "first_lastname": "Perez",
  • "second_lastname": "Suares",
  • "birthdate": "1988-02-12T00:00:00Z",
  • "gender": "MALE",
  • "tax_id": null,
  • "nationality_id": 144,
  • "state_id": 7,
  • "entity_of_birth": "DF",
  • "external_ref_id": null,
  • "facetec_ref_id": null,
  • "biometrics": null,
  • "marital_status_id": null,
  • "people_group_id": null,
  • "extra_data": null,
  • "ignore_curp_validation": false
}

Response samples

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

Eliminar el registro de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Busca personas utilizando una lista de IDs.

Authorizations:
apiKey
Request Body schema: application/json
ids
Array of strings <uuid>

Responses

Request samples

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

Response samples

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

Crear una persona usando el CURP (Clave Única de Registro de Población de México).

Authorizations:
apiKey
Request Body schema: application/json
curp
required
string = 18 characters

Responses

Request samples

Content type
application/json
{
  • "curp": "PESJ880212HDFHLX01"
}

Response samples

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

Descargar información de personas en formato CSV.

Authorizations:
apiKey
Request Body schema: application/json
start_date
string <date>
end_date
string <date>
exclude
Array of strings
Items Enum: "address" "contact"

Responses

Request samples

Content type
application/json
{
  • "start_date": "2022-07-29",
  • "end_date": "2022-07-29",
  • "exclude": [
    ]
}

Response samples

Content type
application/json
{
  • "success": false,
  • "code": 401,
  • "error": "Failed authorization"
}

Importar personas desde un archivo para registrar en el sistema.

Authorizations:
apiKey
Request Body schema: multipart/form-data
file
string <binary>

Archivo CSV o XLSX

tmp_file_id
string

Id del archivo temporal

Responses

Response samples

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

Buscar personas utilizando una lista de IDs externos.

Authorizations:
apiKey
Request Body schema: application/json
external_ref_id
Array of strings

Responses

Request samples

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

Response samples

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

Recuperar datos de una persona por su ID externo.

Authorizations:
apiKey
path Parameters
external_id
required
string

Responses

Response samples

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

Crear o actualizar una persona usando el ID Nacional.

Authorizations:
apiKey
Request Body schema: application/json
national_id
required
string

CURP oficial de la persona en México, clave única nacional.

name
string

Nombre oficial de la persona.

first_lastname
string

Primer apellido registrado de la persona.

second_lastname
string

Segundo apellido registrado de la persona.

birthdate
string <date>

Fecha oficial de nacimiento de la persona.

gender
string
Enum: "MALE" "FEMALE"

Sexo registrado de la persona.

tax_id
string

RFC de la persona en México.

nationality_id
integer

Identificador del catálogo de nacionalidades utilizado, 144 corresponde, por ejemplo, a México.

state_id
integer

Identificador de estado dentro del catálogo nacional.

entity_of_birth
string

Texto libre para el nombre del estado de nacimiento.

external_ref_id
string

Identificador externo personalizado de la persona.

facetec_ref_id
string

Referencia a registro en la base de Facetec.

biometrics
object

Datos biométricos almacenados sobre la persona.

marital_status_id
integer

Identificador del estado civil de la persona según catálogos internos.

people_group_id
string <uuid>

Identificador del grupo de pertenencia de la persona.

extra_data
object

Campo de uso libre para información adicional sobre la persona.

ignore_curp_validation
boolean

Indica si se debe omitir la validación del CURP (ID nacional) para esta persona.

Responses

Request samples

Content type
application/json
{
  • "national_id": "PESJ880212HDFHLX01",
  • "name": "Juan",
  • "first_lastname": "Perez",
  • "second_lastname": "Suares",
  • "birthdate": "1988-02-12T00:00:00Z",
  • "gender": "MALE",
  • "tax_id": null,
  • "nationality_id": 144,
  • "state_id": 7,
  • "entity_of_birth": "DF",
  • "external_ref_id": null,
  • "facetec_ref_id": null,
  • "biometrics": null,
  • "marital_status_id": null,
  • "people_group_id": null,
  • "extra_data": null,
  • "ignore_curp_validation": false
}

Response samples

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

Registrar un firmante para una persona en la plataforma Signt.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
document_id
required
string <uuid>
password
required
string
elements
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
  • "password": "sg3sd2g1",
  • "elements": [
    ]
}

Response samples

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

Realizar comparación facial entre el rostro y su INE.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: multipart/form-data
selfie
required
string <binary>

Imagen del rostro de la persona, JPG o PNG

ine_front
required
string <binary>

Imagen del frente del INE de la persona

Responses

Response samples

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

Obtener los documentos vinculados a esta persona en la plataforma Signt.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Asociar imágenes de INE a una persona.

Permite subir imágenes del INE a una persona. Si la validación automática de INE está activa, se iniciará el proceso correspondiente.

Este flujo agiliza la verificación de identidad.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: multipart/form-data
ine_front
required
string <binary>

Imagen frontal del INE en formato JPG o PNG

ine_reverse
required
string <binary>

Imagen trasera del INE en formato JPG o PNG

ocr_data_front
string <json>

Informacion del OCR de la parte frontal del INE de los servicios de REM en caso de que no se quiera repetir el prceso de OCR

ocr_data_reverse
string <json>

Informacion del OCR de la parte trasera del INE de los servicios de REM en caso de que no se quiera repetir el prceso de OCR

Responses

Response samples

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

Ejecutar las validaciones activas de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
validations
Array of strings <uuid>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Validations running on background"
}

Ejecutar validaciones activas para direcciones de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
validations
Array of strings <uuid>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Validations running on background"
}

Obtener los resultados de las últimas validaciones realizadas a una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Consultar los resultados biométricos de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Consultar los valores dinámicos asociados a una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
query Parameters
all
boolean

Indicador de si se quieren obtener todos los valores dinamicos o solo los ultimos de cada tipo

descriptor_id
string <uuid>
Example: descriptor_id=2b7c7b3b-5d4f-4c3d-8b1e-4b8e6c4c5f69

Id de la propiedad dinamica para los valores que se quieren obtener (Solo aplica si all esta presente)

Responses

Response samples

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

Consulta de persona por su ID Nacional.

Authorizations:
apiKey
path Parameters
national_id
required
string

Responses

Response samples

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

Obtener una persona utilizando su ID de Facetec.

Authorizations:
apiKey
path Parameters
facetec_id
required
string

Responses

Response samples

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

Consultar persona usando su ID externo.

Authorizations:
apiKey
path Parameters
externalId
required
string

Responses

Response samples

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

Addresses

Informacion de las direcciones de las personas registradas

Consultar todas las direcciones registradas en el sistema.

Authorizations:
apiKey

Responses

Response samples

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

Agregar una nueva dirección para una persona.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

ID de la persona con la que se relaciona la dirección.

street
required
string

Calle en la que se encuentra la vivienda.

ext_num
required
string

Número exterior registrado.

int_num
string

Número interior del domicilio, si aplica.

state
required
string

Entidad federativa de la dirección.

municipality
required
string

Municipio o alcaldía correspondiente.

colony
required
string

Colonia, fraccionamiento o barrio.

zip_code
required
string

Código postal especificado.

references
required
string

Cadena de referencias complementarias.

latitude
number

Latitud de la dirección.

longitude
string

Longitud de la vivienda.

ownership
boolean

Persona que figura como propietario o responsable.

dwelling_age
integer

Tiempo viviendo en la dirección registrada.

source
string

Fuente u origen de la dirección.

device_coordinates
Array of numbers

Coordenadas proporcionadas por el dispositivo.

is_current_address
boolean

Marca si la dirección es actual para la persona.

verified_at
string <date-time>

Fecha en la que la dirección fue verificada.

metadata
object

Información adicional relacionada con la dirección.

Responses

Request samples

Content type
application/json
{
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "street": "Marte",
  • "ext_num": "12",
  • "int_num": "DEP 8",
  • "state": "DF",
  • "municipality": "IZTACALCO",
  • "colony": "Cristobal Colon",
  • "zip_code": "08016",
  • "references": "Al lado de una tienda",
  • "latitude": null,
  • "longitude": null,
  • "ownership": null,
  • "dwelling_age": null,
  • "source": null,
  • "device_coordinates": null,
  • "is_current_address": null,
  • "verified_at": "2022-07-29T21:54:22Z",
  • "metadata": null
}

Response samples

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

Obtener la información de una dirección específica por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar los datos de una dirección existente.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
person_id
string <uuid>

ID de la persona con la que se relaciona la dirección.

street
string

Calle en la que se encuentra la vivienda.

ext_num
string

Número exterior registrado.

int_num
string

Número interior del domicilio, si aplica.

state
string

Entidad federativa de la dirección.

municipality
string

Municipio o alcaldía correspondiente.

colony
string

Colonia, fraccionamiento o barrio.

zip_code
string

Código postal especificado.

references
string

Cadena de referencias complementarias.

latitude
number

Latitud de la dirección.

longitude
string

Longitud de la vivienda.

ownership
boolean

Persona que figura como propietario o responsable.

dwelling_age
integer

Tiempo viviendo en la dirección registrada.

source
string

Fuente u origen de la dirección.

device_coordinates
Array of numbers

Coordenadas proporcionadas por el dispositivo.

is_current_address
boolean

Marca si la dirección es actual para la persona.

verified_at
string <date-time>

Fecha en la que la dirección fue verificada.

metadata
object

Información adicional relacionada con la dirección.

Responses

Request samples

Content type
application/json
{
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "street": "Marte",
  • "ext_num": "12",
  • "int_num": "DEP 8",
  • "state": "DF",
  • "municipality": "IZTACALCO",
  • "colony": "Cristobal Colon",
  • "zip_code": "08016",
  • "references": "Al lado de una tienda",
  • "latitude": null,
  • "longitude": null,
  • "ownership": null,
  • "dwelling_age": null,
  • "source": null,
  • "device_coordinates": null,
  • "is_current_address": null,
  • "verified_at": "2022-07-29T21:54:22Z",
  • "metadata": null
}

Response samples

Content type
application/json
{
  • "id": "acaef745-b616-4c91-99c4-b8fd2dc8a83c",
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "street": "Marte",
  • "ext_num": "12",
  • "int_num": "DEP 8",
  • "state": "DF",
  • "state_id": 7,
  • "city": "Ciudad de Mexico",
  • "municipality": "IZTACALCO",
  • "colony": "Cristobal Colon",
  • "zip_code": "08016",
  • "references": "Al lado de una tienda",
  • "latitude": null,
  • "longitude": null,
  • "source": "ine",
  • "ownership": null,
  • "dwelling_age": null,
  • "device_coordinates": null,
  • "is_current_address": null,
  • "verified_at": "2022-07-29T21:54:22Z",
  • "metadata": null,
  • "created_at": "2022-07-29T21:54:22Z",
  • "updated_at": "2022-07-29T21:54:22Z"
}

Eliminar una dirección del registro.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Biometrics

Resultados biometricos

Consultar el registro de resultados biométricos.

Authorizations:
apiKey
query Parameters
person_id
string <uuid>
page
integer
Example: page=1

Responses

Response samples

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

Guardar el resultado de un proceso biométrico en el sistema.

Authorizations:
apiKey
Request Body schema: application/json
person_id
string <uuid>
type
string
Enum: "LIVENESS" "ENROLL" "FACE_3D_MATCH" "FACE_2D_MATCH" "FACE_MATCH_ID"
facetec_id
string
execution_date
string <date>
metadata
object

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "type": "LIVENESS",
  • "facetec_id": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
  • "execution_date": "2022-07-29T21:54:55",
  • "metadata": {
    }
}

Response samples

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

Obtener un resultado biométrico específico por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar un resultado biométrico existente.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
person_id
string <uuid>
type
string
Enum: "LIVENESS" "ENROLL" "FACE_3D_MATCH" "FACE_2D_MATCH" "FACE_MATCH_ID"
facetec_id
string
execution_date
string <date>
metadata
object

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "type": "LIVENESS",
  • "facetec_id": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
  • "execution_date": "2022-07-29T21:54:55",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "type": 0,
  • "typeName": "LIVENESS",
  • "facetec_id": "string",
  • "execution_date": "2022-07-29T21:54:55Z",
  • "metadata": {
    }
}

Person Contacts

Informacion de contacto de las personas registradas

Recuperar la información de contacto de todas las personas.

Authorizations:
apiKey

Responses

Response samples

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

Registrar información de contacto para una persona.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

ID único de la persona asociada a este recurso.

email
required
string <email>
phone
required
string

Número celular de contacto incluyendo clave internacional (Ejemplo México: +52).

Responses

Request samples

Content type
application/json
{
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "email": "user@example",
  • "phone": "525591038054"
}

Response samples

Content type
application/json
{
  • "id": "e291d356-c78c-495b-898b-9f951ac9dbb1",
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "email": "user@example",
  • "phone": "525591038054",
  • "email_confirmation": false,
  • "sms_confirmation": false,
  • "created_at": "2022-07-29T21:54:55Z",
  • "updated_at": "2022-07-29T21:54:55Z"
}

Consultar una información de contacto específica.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Consultar información de contacto de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
person_id
string <uuid>

ID único de la persona asociada a este recurso.

email
string <email>
phone
string

Número celular de contacto incluyendo clave internacional (Ejemplo México: +52).

Responses

Request samples

Content type
application/json
{
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "email": "user@example",
  • "phone": "525591038054"
}

Response samples

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

Eliminar un registro de información de contacto.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Enviar código SMS para la verificación de número telefónico.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

Id de la persona a la que se quiere validar su telefono

phone
required
string

Numero de contacto de la persona con clave del pais incluida

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "phone": "525546134819"
}

Response samples

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

Validar código de verificación recibido por SMS.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

Id de la persona a la que se quiere validar su telefono

phone
required
string

Numero de contacto de la persona con clave del pais incluida

code
required
string

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "phone": "525546134819",
  • "code": "006421"
}

Response samples

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

Enviar código de verificación al correo electrónico.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

Id de la persona a la que se quiere validar su telefono

email
required
string <email>

Email de contacto de la persona

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "email": "test@example.com"
}

Response samples

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

Validar código de verificación recibido por email.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

Id de la persona a la que se quiere validar su telefono

email
required
string <email>

Email de contacto de la persona

code
required
string

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "email": "test@example.com",
  • "code": "006421"
}

Response samples

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

Person References

Informacion de las referencias personales

Consultar todas las referencias registradas.

Authorizations:
apiKey

Responses

Response samples

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

Registrar una nueva referencia personal para una persona.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>

ID de la persona asociada a la referencia.

name
required
string
phone
required
string
person_relation_id
required
integer

Identificador del tipo de relación en el catálogo correspondiente.

Responses

Request samples

Content type
application/json
{
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "name": "Juan Perez Suares",
  • "phone": "525586128954",
  • "person_relation_id": 1
}

Response samples

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

Obtener información de una referencia personal.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar la información de una referencia personal.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
person_id
string <uuid>

ID de la persona asociada a la referencia.

name
string
phone
string
person_relation_id
integer

Identificador del tipo de relación en el catálogo correspondiente.

Responses

Request samples

Content type
application/json
{
  • "person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "name": "Juan Perez Suares",
  • "phone": "525586128954",
  • "person_relation_id": 1
}

Response samples

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

Eliminar una referencia personal.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Validations

Informacion de las validaciones registradas

Obtener todas las validaciones registradas.

Authorizations:
apiKey

Responses

Response samples

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

Registrar una nueva validación en el sistema.

Authorizations:
apiKey
Request Body schema: application/json
name
required
string
required
curp (string) or rfc (string) or blacklist (string) or document (string) or external (string) or ine (string) or anti_spoofing (string) or face_duplicity (string)
active
boolean

Marca si la validación está activa y puede ejecutarse.

execution_type
string
Enum: "auto" "manual"

Tipo de ejecución definido para la validación.

required
INE, RFC, CURP (object) or Blacklist (object) or External (object) or Documents (object)

Responses

Request samples

Content type
application/json
{
  • "name": "LicenseValidation",
  • "class": "curp",
  • "active": true,
  • "execution_type": "auto",
  • "config": { }
}

Response samples

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

Obtener los detalles de una validación específica.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar detalles de una validación.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
name
string
active
boolean

Indica si la validación se encuentra actualmente activa.

CURP, INE, RFC (object) or Blacklist (object) or External (object) or Document (object)

Responses

Request samples

Content type
application/json
{
  • "name": "LicenseValidation",
  • "active": true,
  • "config": { }
}

Response samples

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

Eliminar una validación existente.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Validation Results

Informacion de los resultados de las validaciones

Recuperar resultados de las validaciones ejecutadas.

Authorizations:
apiKey

Responses

Response samples

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

Consultar un resultado de validación específico.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Eliminar un resultado de validación.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Ejecutar una validación sobre un registro o elemento.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
query Parameters
force
string <boolean>
Enum: "true" "false"

Forzar la validacion a ejecutarse independientemente del estado actual

Responses

Response samples

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

Files

Manejo de los archivos relacionados a un modelo

Guardar un archivo vinculado a un modelo.

Authorizations:
apiKey
Request Body schema: multipart/form-data
file
required
string <binary>

Archivo que se desea guardar, maximo 2mb

file_tmp_id
string <uuid>

uuid from file uploaded to temporary files api

collection
string

Categoria del archivo para clasificarlo

model
required
string
Enum: "address" "person" "person_contact" "person_reference" "validation" "person_financial_data" "person_employment_data" "person_bank_data"

Tipo de modelo al que se va a relacionar el archivo

model_id
required
string <uuid>

Identificador del modelo al que se va a relacionar el archivo

metadata
object

Metadatos del archivo, se guardan como JSON

Responses

Response samples

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

Guardar archivos desde URLs al modelo correspondiente.

Authorizations:
apiKey
Request Body schema: application/json
Array of objects >= 1

URLs de archivo que se desean guardar

Array of objects

Uuids de archivos temporales que se desean guardar

Responses

Request samples

Content type
application/json
{
  • "files": [
    ],
  • "files_tmp_id": [
    ]
}

Response samples

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

Guardar archivos recibidos por API de archivos temporales.

Authorizations:
apiKey
Request Body schema: application/json
async
boolean
Default: false

Indica si se desea que la operacion se ejecute de forma asincrona

object

Responses

Request samples

Content type
application/json
{
  • "async": false,
  • "files": {
    }
}

Response samples

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

Recupera archivos asociados a un modelo especificado.

Authorizations:
apiKey
query Parameters
collection
string
Example: collection=license

Si no se especifica se regresan todos los archivos del modelo y no solo los de la collection

model
required
string
Enum: "address" "person" "person_contact" "person_reference" "validation" "person_financial_data" "person_employment_data" "person_bank_data"
Example: model=person
model_id
required
string <uuid>
Example: model_id=14f209d5-2793-4561-ac95-ab8a03aa7dbd
expires_in_min
integer
Example: expires_in_min=2

Tiempo de expiracion de la URL en minutos

page
integer
Default: 1
Example: page=1

Numero de pagina para paginacion

include_tmp_url
boolean
Default: false
Example: include_tmp_url=false

Incluir URL temporal de los archivos

Responses

Response samples

Content type
application/json
{}

Obtener una URL temporal para acceder a un archivo.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 14f209d5-2793-4561-ac95-ab8a03aa7dbd
query Parameters
expires_in_min
integer
Example: expires_in_min=2

Tiempo de expiracion de la URL en minutos

Responses

Response samples

Content type
application/json
{}

Eliminar un archivo de un modelo asociado.

Authorizations:
apiKey
query Parameters
collection
string
Example: collection=license

Si no se especifica se utiliza la collection 'default'

model
required
string
Enum: "address" "person" "person_contact" "person_reference" "validation"
Example: model=person
model_id
required
string <uuid>
Example: model_id=14f209d5-2793-4561-ac95-ab8a03aa7dbd
media_uuid
required
string
Example: media_uuid=393612eb-dc24-407a-874f-cf04935fe4b

uuid de identificacion de media

Responses

Response samples

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

Notification Channels

Manejo de los canales de notificacion de los eventos predeterminados

Listar los canales de notificación registrados.

Authorizations:
apiKey

Responses

Response samples

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

Registrar un nuevo canal de notificaciones.

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

Nombre descriptivo del canal de notificaciones.

type
required
string
Enum: "email" "slack" "webhook"

Canal o medio de envío de notificaciones asociadas.

active
required
boolean

Estado de activación de las notificaciones para el canal.

events
required
Array of strings unique
Items Enum: "person_register" "person_pass_validation" "person_fail_validation" "person_restore" "updated_data_to_person" "media_added_to_model"
required
Email (object) or Slack (object) or Webhook (object)

Responses

Request samples

Content type
application/json
{
  • "name": "SlackFailValidations",
  • "type": "slack",
  • "active": true,
  • "events": [
    ],
  • "config": {
    }
}

Response samples

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

Consultar un canal de notificaciones específico.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar un canal de notificaciones existente.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Request Body schema: application/json
name
string

Nombre descriptivo del canal de notificaciones.

type
string
Enum: "email" "slack" "webhook"

Canal o medio de envío de notificaciones asociadas.

active
boolean

Estado de activación de las notificaciones para el canal.

events
Array of strings unique
Items Enum: "person_register" "person_pass_validation" "person_fail_validation" "person_restore" "updated_data_to_person" "media_added_to_model"
Email (object) or Slack (object) or Webhook (object)

Responses

Request samples

Content type
application/json
{
  • "name": "SlackFailValidations",
  • "type": "slack",
  • "active": true,
  • "events": [
    ],
  • "config": {
    }
}

Response samples

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

Eliminar un canal de notificaciones del sistema.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Person Employment Data

Informacion de los empleos de las personas registradas

Consultar los datos laborales de una persona.

Authorizations:
apiKey

Responses

Response samples

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

Registrar información laboral de una persona.

Authorizations:
apiKey
Request Body schema: application/json
person_id
string <uuid>
current_occupation
string

Ocupación actual de la persona.

position
string

Cargo o puesto en el entorno laboral.

industry
string

Industria profesional o sector económico correspondiente.

company_name
string

Nombre de la empresa empleadora.

company_phone
string

Teléfono de contacto de la compañía.

company_address
string

Dirección registrada de la empresa.

seniority
integer

Antigüedad en años en la empresa actual.

employee_id
string <uuid>

ID único de empleado dentro de la organización.

employee_type
string

Clasificación del empleado según contrato u ocupación.

employee_status
string

Estado laboral actual: activo, suspendido, baja, etc.

hiring_date
string <date>

Fecha de contratación registrada.

termination_date
string <date>

Fecha de baja o terminación laboral, si aplica.

payment_frequency
string

Frecuencia de pago del salario, por ejemplo mensual, quincenal.

gross_salary
number <float>

Monto bruto de salario registrado para la persona.

net_salary
number <float>

Monto neto recibido después de descuentos legales.

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "current_occupation": "Desarrollador",
  • "position": "Desarrollador",
  • "industry": "Tecnologia",
  • "company_name": "Rem",
  • "company_phone": 5512345678,
  • "company_address": "Av. Insurgentes Sur 1234",
  • "seniority": 2,
  • "employee_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "employee_type": "Full Time",
  • "employee_status": "Active",
  • "hiring_date": "2022-01-01",
  • "termination_date": null,
  • "payment_frequency": "Mensual",
  • "gross_salary": 30000,
  • "net_salary": 25000
}

Response samples

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

Obtener datos laborales de una persona por ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 1f1b0c0a-1b1c-1d1e-1f1g-1h1i1j1k1l1m

Id del dato laboral de la persona

Responses

Response samples

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

Actualizar la información laboral de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 1f1b0c0a-1b1c-1d1e-1f1g-1h1i1j1k1l1m

Id del dato laboral de la persona

Request Body schema: application/json
person_id
string <uuid>
current_occupation
string

Ocupación actual de la persona.

position
string

Cargo o puesto en el entorno laboral.

industry
string

Industria profesional o sector económico correspondiente.

company_name
string

Nombre de la empresa empleadora.

company_phone
string

Teléfono de contacto de la compañía.

company_address
string

Dirección registrada de la empresa.

seniority
integer

Antigüedad en años en la empresa actual.

employee_id
string <uuid>

ID único de empleado dentro de la organización.

employee_type
string

Clasificación del empleado según contrato u ocupación.

employee_status
string

Estado laboral actual: activo, suspendido, baja, etc.

hiring_date
string <date>

Fecha de contratación registrada.

termination_date
string <date>

Fecha de baja o terminación laboral, si aplica.

payment_frequency
string

Frecuencia de pago del salario, por ejemplo mensual, quincenal.

gross_salary
number <float>

Monto bruto de salario registrado para la persona.

net_salary
number <float>

Monto neto recibido después de descuentos legales.

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "current_occupation": "Desarrollador",
  • "position": "Desarrollador",
  • "industry": "Tecnologia",
  • "company_name": "Rem",
  • "company_phone": 5512345678,
  • "company_address": "Av. Insurgentes Sur 1234",
  • "seniority": 2,
  • "employee_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
  • "employee_type": "Full Time",
  • "employee_status": "Active",
  • "hiring_date": "2022-01-01",
  • "termination_date": null,
  • "payment_frequency": "Mensual",
  • "gross_salary": 30000,
  • "net_salary": 25000
}

Response samples

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

Eliminar información laboral de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 1f1b0c0a-1b1c-1d1e-1f1g-1h1i1j1k1l1m

Id del dato laboral de la persona

Responses

Response samples

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

Person Bank Data

Informacion de los bancos de las personas registradas

Recuperar los datos bancarios asociados a una persona.

Authorizations:
apiKey

Responses

Response samples

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

Crear un registro bancario para una persona.

Authorizations:
apiKey
Request Body schema: application/json
person_id
required
string <uuid>
bank
required
string

Nombre del banco registrado.

account
required
string

Número de cuenta bancaria asociado.

clabe
required
string

CLABE interbancaria asociada.

card_number
string

Número de tarjeta bancaria registrada.

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "bank": "Banamex",
  • "account": 1234567890,
  • "clabe": 12345678901234568,
  • "card_number": 1234567890123456
}

Response samples

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

Consultar datos bancarios de una persona por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 1d0b0c0a-0b0c-0d0e-0f0a-1b2c3d4e5f6a

Id del dato bancario de la persona

Responses

Response samples

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

Actualizar información bancaria de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 1d0b0c0a-0b0c-0d0e-0f0a-1b2c3d4e5f6a

Id del dato bancario de la persona

Request Body schema: application/json
person_id
string <uuid>
bank
string

Nombre del banco registrado.

account
string

Número de cuenta bancaria asociado.

clabe
string

CLABE interbancaria asociada.

card_number
string

Número de tarjeta bancaria registrada.

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "bank": "Banamex",
  • "account": 1234567890,
  • "clabe": 12345678901234568,
  • "card_number": 1234567890123456
}

Response samples

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

Eliminar información bancaria de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 1d0b0c0a-0b0c-0d0e-0f0a-1b2c3d4e5f6a

Id del dato bancario de la persona

Responses

Response samples

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

Person Financial Data

Informacion financiera de las personas registradas

Obtener datos financieros asociados a una persona.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crear información financiera para una persona.

Authorizations:
apiKey
Request Body schema: application/json
person_id
string <uuid>
monthly_income
number <float>

Ingreso mensual registrado para fines financieros.

monthly_expenses
number <float>

Egresos mensuales reportados para análisis financiero.

dependents
integer

Total de personas que dependen económicamente del titular.

metadata
object

Campo para información extra en el contexto financiero.

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "monthly_income": 0,
  • "monthly_expenses": 0,
  • "dependents": 2,
  • "metadata": {
    }
}

Response samples

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

Consultar datos financieros de una persona por ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del dato financiero de la persona

Responses

Response samples

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

Actualizar datos financieros de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del dato financiero de la persona

Request Body schema: application/json
person_id
string <uuid>
monthly_income
number <float>

Ingreso mensual registrado para fines financieros.

monthly_expenses
number <float>

Egresos mensuales reportados para análisis financiero.

dependents
integer

Total de personas que dependen económicamente del titular.

metadata
object

Campo para información extra en el contexto financiero.

Responses

Request samples

Content type
application/json
{
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "monthly_income": 0,
  • "monthly_expenses": 0,
  • "dependents": 2,
  • "metadata": {
    }
}

Response samples

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

Eliminar datos financieros de una persona.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del dato financiero de la persona

Responses

Response samples

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

Custom Catalogs

Catalogos personalizados

Listar los catálogos personalizados disponibles.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crear un nuevo catálogo personalizado.

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

Responses

Request samples

Content type
application/json
{
  • "name": "Catalogo de prueba",
  • "description": "Catalogo de prueba"
}

Response samples

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

Obtener catálogo personalizado por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del catalogo personalizado

Responses

Response samples

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

Actualizar un catálogo personalizado.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del catalogo personalizado

Request Body schema: application/json
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "Catalogo de prueba",
  • "description": "Catalogo de prueba"
}

Response samples

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

Eliminar un catálogo personalizado.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del catalogo personalizado

Responses

Response samples

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

Custom Catalog Values

Valores de los catalogos personalizados

Obtener valores de un catálogo personalizado.

Authorizations:
apiKey
query Parameters
custom_catalog_id
string <uuid>
Example: custom_catalog_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Identificador único del catálogo personalizado del cual se consultan los valores.

Responses

Response samples

Content type
application/json
{}

Agregar un nuevo valor a un catálogo personalizado.

Authorizations:
apiKey
Request Body schema: application/json
custom_catalog_id
string <uuid>
label
string
type
string
Enum: "string" "integer" "number" "boolean" "datetime" "array"
string or integer or number or boolean or string or Array of strings
groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "label": "Test 01",
  • "type": "string",
  • "value": "test_01",
  • "groups": [
    ]
}

Response samples

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

Consultar el valor de un catálogo personalizado por ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor de catalogo personalizado

Responses

Response samples

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

Actualizar el valor de un catálogo personalizado.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor de catalogo personalizado

Request Body schema: application/json
custom_catalog_id
string <uuid>
label
string
type
string
Enum: "string" "integer" "number" "boolean" "datetime" "array"
string or integer or number or boolean or string or Array of strings
groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "label": "Test 01",
  • "type": "string",
  • "value": "test_01",
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "label": "Test 01",
  • "type": "string",
  • "value": "test_01",
  • "groups": [
    ],
  • "created_at": "2022-07-29T21:54:55Z",
  • "updated_at": "2022-07-29T21:54:55Z"
}

Eliminar un valor de un catálogo personalizado.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor de catalogo personalizado

Responses

Response samples

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

Insertar varios valores en un catálogo personalizado de forma masiva.

Authorizations:
apiKey
Request Body schema: multipart/form-data
custom_catalog_id
string <uuid>

Id del catalogo personalizado

csv_file
string <binary>

Archivo csv con los valores a insertar incluyendo el renglon header con la siguiente estructura: type,label,value

Responses

Response samples

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

Dynamic Properties

Propiedades dinamicas de las personas

Listar propiedades dinámicas registradas en el sistema.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok",
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "https://api.test.rem.tools/onboarding/dynamic-properties?page=1",
  • "from": 1,
  • "next_page_url": null,
  • "path": "http://api.test.rem.tools/onboarding/dynamic-properties",
  • "per_page": 20,
  • "prev_page_url": null,
  • "to": 1
}

Registrar una nueva propiedad dinámica.

Authorizations:
apiKey
Request Body schema: application/json
name
string
description
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "Test 01",
  • "description": "Test 01",
  • "descriptor": [
    ]
}

Response samples

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

Consultar una propiedad dinámica por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la propiedad dinamica

Responses

Response samples

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

Actualizar una propiedad dinámica existente.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la propiedad dinamica

Request Body schema: application/json
name
string
description
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "Test 01",
  • "description": "Test 01",
  • "descriptor": [
    ]
}

Response samples

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

Eliminar una propiedad dinámica.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la propiedad dinamica

Responses

Response samples

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

Guardar valores asociados a una propiedad dinámica.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la propiedad dinamica

Request Body schema: application/json
person_id
string <uuid>
dynamic_property_id
string <uuid>
object

Listado de valores asociados a las propiedades dinámicas existentes.

Responses

Request samples

Content type
application/json
{
  • "person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "dynamic_property_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "values": {
    }
}

Response samples

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

Dynamic Values

Valores de las propiedades dinamicas de las personas

Recuperar valores dinámicos de una persona o entidad.

Authorizations:
apiKey
query Parameters
descriptor_id
string <uuid>
Example: descriptor_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Identificador único de la propiedad dinámica a consultar.

person_id
string <uuid>
Example: person_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Identificador único de la persona cuyos valores se consultan.

Responses

Response samples

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

Consultar un valor dinámico por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor dinamico

Responses

Response samples

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

Eliminar un valor dinámico.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor dinamico

Responses

Response samples

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

Public

API publica para el manejo de personas

Webhooks

Webhooks que se hacen llegar a traves de el canal de notificacion previamente configurado

Nueva Persona Registrada Webhook

Webhook enviado si hay un canal de notificaciones por webhook activo al registrar una persona, en los canales de slack y email llega informacion similar

Authorizations:
apiKey
Request Body schema: application/json

Datos enviados en el webhook

event
string

Nombre del evento

resource_id
string <uuid>

Id del recurso afectado, en este caso de la persona

resource_name
string

Nombre del recurso afectado, en este caso de la persona

object (person)

Responses

Request samples

Content type
application/json
{
  • "event": "person_register",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "resource_name": "person",
  • "payload": {
    }
}

Validacion aprobada Webhook

Webhook enviado si hay un canal de notificaciones por webhook activo al pasar una validacion, en los canales de slack y email llega informacion similar

Authorizations:
apiKey
Request Body schema: application/json

Datos enviados en el webhook

event
string

Nombre del evento

resource_id
string <uuid>

Id del recurso afectado, en este caso de la validacion

resource_name
string

Nombre del recurso afectado, en este caso de la persona

object

Responses

Request samples

Content type
application/json
{
  • "event": "person_pass_validation",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "resource_name": "person",
  • "payload": {
    }
}

Validacion fallida Webhook

Webhook enviado si hay un canal de notificaciones por webhook activo al fallar una validacion, en los canales de slack y email llega informacion similar

Authorizations:
apiKey
Request Body schema: application/json

Datos enviados en el webhook

event
string

Nombre del evento

resource_id
string <uuid>

Id del recurso afectado, en este caso de la validacion

resource_name
string

Nombre del recurso afectado, en este caso de la persona

object

Responses

Request samples

Content type
application/json
{
  • "event": "person_fail_validation",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "resource_name": "person",
  • "payload": {
    }
}

Persona restaurada Webhook

Webhook enviado si hay un canal de notificaciones por webhook activo al restaurar una persona, en los canales de slack y email llega informacion similar

Authorizations:
apiKey
Request Body schema: application/json

Datos enviados en el webhook

event
string

Nombre del evento

resource_id
string <uuid>

Id del recurso afectado, en este caso de la persona

resource_name
string

Nombre del recurso afectado, en este caso de la persona

object (person)

Responses

Request samples

Content type
application/json
{
  • "event": "person_restore",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "resource_name": "person",
  • "payload": {
    }
}

Datos actualizados a persona Webhook

Webhook enviado si hay un canal de notificaciones por webhook activo al actualizar datos de una persona, en los canales de slack y email llega informacion similar

Authorizations:
apiKey
Request Body schema: application/json

Datos enviados en el webhook

event
string

Nombre del evento

resource_id
string <uuid>

Id del recurso afectado, en este caso de la persona

resource_name
string

Nombre del recurso afectado, en este caso de la persona

Address (object) or EmploymentData (object) or BankData (object) or PersonFinancialData (object) or ContactData (object) or Reference (object) or Biometric (object)

Responses

Request samples

Content type
application/json
{
  • "event": "updated_data_to_person",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "resource_name": "person_contact",
  • "payload": {
    }
}

Media agregada a modelo Webhook

Webhook enviado si hay un canal de notificaciones por webhook activo al agregar una media a un modelo, en los canales de slack y email llega informacion similar

Authorizations:
apiKey
Request Body schema: application/json

Datos enviados en el webhook

event
string

Nombre del evento

resource_id
string <uuid>

Id del recurso afectado, en este caso de la media

resource_name
string

Nombre del recurso afectado, en este caso de la media

object (media)

Datos de la media

Responses

Request samples

Content type
application/json
{
  • "event": "added_media_to_model",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "resource_name": "media",
  • "payload": {}
}

Temporary People

Consultar personas temporales registradas en el sistema.

Authorizations:
apiKey

Responses

Response samples

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

Registrar una nueva persona temporal.

Authorizations:
apiKey
Request Body schema: application/json
facetec_ref_id
string
external_ref_id
string
callback_url
string <url>
name
string
first_lastname
string
second_lastname
string
national_id
string
tax_id
string
birthdate
string <date>
gender
string
Enum: "MALE" "FEMALE"
extra_data
object

Información adicional de la persona temporal.

bank_data
object

Datos bancarios de la persona temporal.

employment_data
object

Información laboral registrada para la persona temporal.

Responses

Request samples

Content type
application/json
{
  • "facetec_ref_id": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
  • "external_ref_id": "external-123456789",
  • "callback_url": "https://example.com/callback",
  • "name": "John Doe",
  • "first_lastname": "Doe",
  • "second_lastname": "Smith",
  • "national_id": "123456789012",
  • "tax_id": "1234567890",
  • "birthdate": "1990-01-01",
  • "gender": "MALE",
  • "extra_data": { },
  • "bank_data": { },
  • "employment_data": { }
}

Response samples

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

Obtener los datos de una persona temporal por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la persona temporal

Responses

Response samples

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

Actualizar los datos de una persona temporal existente.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la persona temporal

Request Body schema: application/json
facetec_ref_id
string
external_ref_id
string
callback_url
string <url>
name
string
first_lastname
string
second_lastname
string
national_id
string
tax_id
string
birthdate
string <date>
gender
string
Enum: "MALE" "FEMALE"
extra_data
object

Información adicional de la persona temporal.

bank_data
object

Datos bancarios de la persona temporal.

employment_data
object

Información laboral registrada para la persona temporal.

Responses

Request samples

Content type
application/json
{
  • "facetec_ref_id": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
  • "external_ref_id": "external-123456789",
  • "callback_url": "https://example.com/callback",
  • "name": "John Doe",
  • "first_lastname": "Doe",
  • "second_lastname": "Smith",
  • "national_id": "123456789012",
  • "tax_id": "1234567890",
  • "birthdate": "1990-01-01",
  • "gender": "MALE",
  • "extra_data": { },
  • "bank_data": { },
  • "employment_data": { }
}

Response samples

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

Eliminar una persona temporal del registro.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la persona temporal

Responses

Response samples

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

Crear persona definitiva a partir de una persona temporal.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la persona temporal

Request Body schema: application/json
person_data
object

Datos de la persona a crear

employment_data
object

Datos del empleo de la persona a crear

bank_data
object

Datos bancarios de la persona a crear

extra_data
object

Datos extra de la persona a crear

Responses

Request samples

Content type
application/json
{
  • "person_data": { },
  • "employment_data": { },
  • "bank_data": { },
  • "extra_data": { }
}

Response samples

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

Credit Bureau Requests

Consultar solicitudes de buró de crédito registradas.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Registrar una nueva solicitud de buró de crédito.

Authorizations:
apiKey
Request Body schema: application/json

Contiene los datos completos de la solicitud de buró de crédito.

person_id
string <uuid>
report_provider
string
Enum: "cdc" "credit_buro"
report_type
string
Enum: "ingresos" "credito" "buro"
verification_code
string
verification_contact
string
config
object

Configuración adicional utilizada en la solicitud de buró.

created_at
string <date>
updated_at
string <date>

Responses

Request samples

Content type
application/json
{
  • "person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
  • "report_provider": "cdc",
  • "report_type": "ingresos",
  • "verification_code": "123456",
  • "verification_contact": "example@mail.com",
  • "config": {
    },
  • "created_at": "2022-07-29T21:54:55Z",
  • "updated_at": "2022-07-29T21:54:55Z"
}

Response samples

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

Consultar una solicitud de buró de crédito por su ID.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Identificador de la solicitud de buró de crédito consultada.

Responses

Response samples

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

Eliminar una solicitud de buró de crédito.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Identificador asociado a la solicitud de buró a eliminar.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}
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.