Skip to main content
Documentation Powered by Redocly

People API (stable)

Download OpenAPI specification:Download

API para el manejo de personas

Las personas son el elemento principal de la API, y se pueden crear, modificar, eliminar y consultar. Las personas pueden tener direcciones, referencias, validaciones, archivos, canales de notificacion, empleos, bancos y datos financieros.

Catalogs

Catalogos para personas

Catalogo de relaciones de personas

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catalogo de relaciones

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Catalogo de estados civiles

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catalogo de estados civiles

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Catalogo de nacionalidades

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catalogo de nacionalidades

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Catalogo de estados

Authorizations:
apiKey

Responses

Response samples

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

Elemento del catalogo 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

Recupera la lista de grupos de personas registrados

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crea 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 la lista de grupos de personas registrados

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualiza 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": {
    }
}

Borra un grupo de personas

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

Obtiene una lista de personas registradas

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

Responses

Response samples

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

Crea una nueva persona

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

Id Nacional de identificacion de la persona en Mexico CURP

name
required
string

Nombre de la persona

first_lastname
required
string

Primer apellido de la persona

second_lastname
required
string

Segundo apellido de la persona

birthdate
string <date>

Fecha de nacimento de la persona

gender
string
Enum: "MALE" "FEMALE"

Sexo de la persona

tax_id
string

Id fiscal de la person en Mexico RFC

nationality_id
integer

Id del catalogo de Nacionalidades y Paises 144 para Mexico

state_id
integer

Id del catalogo de Estados de Mexico

entity_of_birth
string

Estado de Nacimiento, campo libre

external_ref_id
string

Referencia externa de la persona

facetec_ref_id
string

Referencia de la base de datos de facetec

biometrics
object

Informacion referente a los biometricos

marital_status_id
integer

Id del catalogo de Estado Civil de la persona

people_group_id
string <uuid>

Id del grupo de personas a las que pertenece

extra_data
object

Informacion adicional libre a agregar a la persona

Responses

Request samples

Content type
application/json
{
  • "national_id": "PESJ880212HDFHLX01",
  • "name": "Juan",
  • "first_lastname": "Perez",
  • "second_lastname": "Suares",
  • "birthdate": "1988-02-12T00:00:00.000000Z",
  • "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
}

Response samples

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

Obtener la persona por id

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualiza una persona por Id

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

Id Nacional de identificacion de la persona en Mexico CURP

name
string

Nombre de la persona

first_lastname
string

Primer apellido de la persona

second_lastname
string

Segundo apellido de la persona

birthdate
string <date>

Fecha de nacimento de la persona

gender
string
Enum: "MALE" "FEMALE"

Sexo de la persona

tax_id
string

Id fiscal de la person en Mexico RFC

nationality_id
integer

Id del catalogo de Nacionalidades y Paises 144 para Mexico

state_id
integer

Id del catalogo de Estados de Mexico

entity_of_birth
string

Estado de Nacimiento, campo libre

external_ref_id
string

Referencia externa de la persona

facetec_ref_id
string

Referencia de la base de datos de facetec

biometrics
object

Informacion referente a los biometricos

marital_status_id
integer

Id del catalogo de Estado Civil de la persona

people_group_id
string <uuid>

Id del grupo de personas a las que pertenece

extra_data
object

Informacion adicional libre a agregar a la persona

Responses

Request samples

Content type
application/json
{
  • "national_id": "PESJ880212HDFHLX01",
  • "name": "Juan",
  • "first_lastname": "Perez",
  • "second_lastname": "Suares",
  • "birthdate": "1988-02-12T00:00:00.000000Z",
  • "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
}

Response samples

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

Borra una persona

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Crea una persona a partir del CURP (Id Nacional de Mexico)

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 la informacion 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 al sistema

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

Archivo CSV o XLSX

s3_path
string

Path de S3 donde se encuentra el archivo CSV o XLSX

Responses

Response samples

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

Obtiene una persona por su Id Nacional

Authorizations:
apiKey
path Parameters
national_id
required
string

Responses

Response samples

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

Obtiene una persona por su Id de Facetec

Authorizations:
apiKey
path Parameters
facetec_id
required
string

Responses

Response samples

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

Obtiene 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 por Id Nacional

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

Id Nacional de identificacion de la persona en Mexico CURP

name
string

Nombre de la persona

first_lastname
string

Primer apellido de la persona

second_lastname
string

Segundo apellido de la persona

birthdate
string <date>

Fecha de nacimento de la persona

gender
string
Enum: "MALE" "FEMALE"

Sexo de la persona

tax_id
string

Id fiscal de la person en Mexico RFC

nationality_id
integer

Id del catalogo de Nacionalidades y Paises 144 para Mexico

state_id
integer

Id del catalogo de Estados de Mexico

entity_of_birth
string

Estado de Nacimiento, campo libre

external_ref_id
string

Referencia externa de la persona

facetec_ref_id
string

Referencia de la base de datos de facetec

biometrics
object

Informacion referente a los biometricos

marital_status_id
integer

Id del catalogo de Estado Civil de la persona

people_group_id
string <uuid>

Id del grupo de personas a las que pertenece

extra_data
object

Informacion adicional libre a agregar a la persona

Responses

Request samples

Content type
application/json
{
  • "national_id": "PESJ880212HDFHLX01",
  • "name": "Juan",
  • "first_lastname": "Perez",
  • "second_lastname": "Suares",
  • "birthdate": "1988-02-12T00:00:00.000000Z",
  • "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
}

Response samples

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

Crea un firmante para la 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": {
    }
}

Comparacion basica entre el rostro y la INE de la persona

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 relacionados 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": [
    ]
}

Subir imagenes del INE a la persona

Asocia las imagenes del INE a una persona y en caso de estar activada dispara la validacion de INE

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 para 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 las validaciones activas para las 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 validaciones de una persona

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Obtener los resultados biometricos de una persona

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Obtener los valores dinamicos de 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
{}

Addresses

Informacion de las direcciones de las personas registradas

Obtener todas las direcciones registradas

Authorizations:
apiKey

Responses

Response samples

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

Agregar nueva direccion

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

id de la direccion

person_id
required
string <uuid>

id de la persona relacionada a esta direccion

street
required
string

Calle

ext_num
required
string

Numero exterior

int_num
string

Numero interior

state
required
string

Estado

municipality
required
string

Alcaldia o Municipio

colony
required
string

Colonia

zip_code
required
string

Codigo postal

references
required
string

Referencias

latitude
number

Latitud de la ubicacion

longitude
string

Longitud de la ubicacion

source
string

De donde se obtuvo la direccion

device_coordinates
Array of numbers

Coordenadas del dispositivo

is_current_address
boolean

Bandera que indica si es la direccion actual

Responses

Request 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",
  • "municipality": "IZTACALCO",
  • "colony": "Cristobal Colon",
  • "zip_code": "08016",
  • "references": "Al lado de una tienda",
  • "latitude": null,
  • "longitude": null,
  • "source": null,
  • "device_coordinates": null,
  • "is_current_address": null
}

Response samples

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

Obtener una direccion por Id

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar una direccion

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

id de la direccion

person_id
string <uuid>

id de la persona relacionada a esta direccion

street
string

Calle

ext_num
string

Numero exterior

int_num
string

Numero interior

state
string

Estado

municipality
string

Alcaldia o Municipio

colony
string

Colonia

zip_code
string

Codigo postal

references
string

Referencias

latitude
number

Latitud de la ubicacion

longitude
string

Longitud de la ubicacion

source
string

De donde se obtuvo la direccion

device_coordinates
Array of numbers

Coordenadas del dispositivo

is_current_address
boolean

Bandera que indica si es la direccion actual

Responses

Request 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",
  • "municipality": "IZTACALCO",
  • "colony": "Cristobal Colon",
  • "zip_code": "08016",
  • "references": "Al lado de una tienda",
  • "latitude": null,
  • "longitude": null,
  • "source": null,
  • "device_coordinates": null,
  • "is_current_address": 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",
  • "city": "Ciudad de Mexico",
  • "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,
  • "is_current_address": null,
  • "device_coordinates": null,
  • "created_at": "2022-07-29T21:54:22.000000Z",
  • "updated_at": "2022-07-29T21:54:22.000000Z"
}

Borrar una direccion

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Biometrics

Resultados biometricos

Obtener el registro de resultados biometricos

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 biometrico

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

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": {
    }
}

Obtener un resultado biometrico por id

Authorizations:
apiKey
path Parameters
id
string <uuid>

Responses

Response samples

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

Actualiza un Biometrico

Authorizations:
apiKey
path Parameters
id
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:55.000000Z",
  • "metadata": {
    }
}

Person Contacts

Informacion de contacto de las personas registradas

Obtener la informacion de contacto de todas las personas

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crear Informacion de contacto para una persona

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

Id de la persona relacionada

email
required
string <email>
phone
required
string

Numero celular de contacto con la clave del pais incluida, (Mexico: 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:55.000000Z",
  • "updated_at": "2022-07-29T21:54:55.000000Z"
}

Obtener una informacion de contacto

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Obtener una informacion de contacto

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

Id de la persona relacionada

email
string <email>
phone
string

Numero celular de contacto con la clave del pais incluida, (Mexico: 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": {
    }
}

Borrar la informacion de contacto

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Enviar codigo de verificacion 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

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 codigo de verificacion de 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 codigo de verificacion 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

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 codigo de verificacion de 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

Obtener todas las referencias registradas

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crear una referencia para una persona

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

Id de la persona relacionada

name
required
string
phone
required
string
person_relation_id
required
integer

Id del catalogo de relaciones

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 una referencia personal

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar una referencia personal

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

Id de la persona relacionada

name
string
phone
string
person_relation_id
integer

Id del catalogo de relaciones

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": {
    }
}

Borrar 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 validacions

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Crear una validacion nueva

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

Indicador si la validacion esta activa

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,
  • "config": { }
}

Response samples

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

Obtener los detalles de la validacion

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar una validacion

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

Indicador si la validacion esta 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": {
    }
}

Borrar una validacion

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

Obtener los resultados de las validaciones

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{}

Obtener un resultado de validacion

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Borrar un resultado de validacion

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Correr una validacion

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 archivo en 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

Responses

Response samples

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

Guardar archivos desde URLs a un modelo

Authorizations:
apiKey
Request Body schema: multipart/form-data
files
required
Array of strings <url> >= 1

URLs de archivo que se desean guardar

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

Responses

Response samples

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

Guardar archivos desde el api de archivos temporales a un modelo

Authorizations:
apiKey
Request Body schema: multipart/form-data
async
boolean
Default: false

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

object

Responses

Response samples

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

Obtener archivos de un modelo

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

Responses

Response samples

Content type
application/json
{}

Obtener URL temporal de 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
{
  • "success": true,
  • "result": {
    }
}

Borrar un archivo de un modelo

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

Obtener los canales de notificacion registrados

Authorizations:
apiKey

Responses

Response samples

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

Crear canal de notificaciones

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

Nombre descriptivo del canal

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

Canal por el que enviaran las notificaciones

active
required
boolean

Indicador si las notificaciones de este canal estan activas

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": {
    }
}

Obtener un canal de notificaciones

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Actualizar un canal de notificaciones

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

Nombre descriptivo del canal

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

Canal por el que enviaran las notificaciones

active
boolean

Indicador si las notificaciones de este canal estan activas

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": {
    }
}

Borrar un canal de notificaciones

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
applicat