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

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": 1,
"code": "hermano",
"name": "Hermano",
"created_at": null,
"updated_at": null
}
]
}

Elemento del catalogo de relaciones

Authorizations:

apiKey

path Parameters

id

required

integer

Example: 1

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": 1,
"code": "hermano",
"name": "Hermano",
"created_at": null,
"updated_at": null
}
]
}

Catalogo de estados civiles

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": "1,",
"code": "soltero",
"name": "Soltero",
"created_at": null,
"updated_at": null
}
]
}

Elemento del catalogo de estados civiles

Authorizations:

apiKey

path Parameters

id

required

integer

Example: 1

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": "1,",
"code": "soltero",
"name": "Soltero",
"created_at": null,
"updated_at": null
}
]
}

Catalogo de nacionalidades

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": 144,
"code": "MEX",
"name": "Mexican",
"country": "Mexico",
"created_at": null,
"updated_at": null
}
]
}

Elemento del catalogo de nacionalidades

Authorizations:

apiKey

path Parameters

id

required

integer

Example: 1

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": 144,
"code": "MEX",
"name": "Mexican",
"country": "Mexico",
"created_at": null,
"updated_at": null
}
]
}

Catalogo de estados

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": 7,
"code": "DF",
"name": "Ciudad de México",
"country": "México",
"created_at": null,
"updated_at": null
}
]
}

Elemento del catalogo de estados

Authorizations:

apiKey

path Parameters

id

required

integer

Example: 1

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": 7,
"code": "DF",
"name": "Ciudad de México",
"country": "México",
"created_at": null,
"updated_at": null
}
]
}

People Groups

Administracion de los grupos de personas

Recupera la lista de grupos de personas registrados

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "71266b80-f04b-4a2c-9314-963d3a182f2a",
"name": "Deudores",
"description": "Grupo donde entran las personas con deuda pendiente de pagar",
"created_at": "2022-07-29T19:59:40Z",
"updated_at": "2022-07-29T19:59:40Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/people-groups?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/people-groups?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/people-groups?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/people-groups",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

Crea un nuevo grupo de personas

Authorizations:

apiKey

Request Body schema: application/json

name required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Deudores",
"description": "Grupo donde entran las personas con deuda pendiente de pagar"
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "71266b80-f04b-4a2c-9314-963d3a182f2a",
"name": "Deudores",
"description": "Grupo donde entran las personas con deuda pendiente de pagar",
"created_at": "2022-07-29T19:59:40Z",
"updated_at": "2022-07-29T19:59:40Z"
}
}

Recupera la lista de grupos de personas registrados

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "71266b80-f04b-4a2c-9314-963d3a182f2a",
"name": "Deudores",
"description": "Grupo donde entran las personas con deuda pendiente de pagar",
"created_at": "2022-07-29T19:59:40Z",
"updated_at": "2022-07-29T19:59:40Z"
}
}

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

Payload

Content type

application/json

{"name": "Deudores",
"description": "Grupo donde entran las personas con deuda pendiente de pagar"
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "71266b80-f04b-4a2c-9314-963d3a182f2a",
"name": "Deudores",
"description": "Grupo donde entran las personas con deuda pendiente de pagar",
"created_at": "2022-07-29T19:59:40Z",
"updated_at": "2022-07-29T19:59:40Z"
}
}

Borra un grupo de personas

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

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

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/people?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/people?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/people?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/people",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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
addresses_similarity	number Porcentaje de similitud entre las direcciones registradas
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

Payload

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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

Obtener la persona por id

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67,
"marital_status": {"id": "1,",
"code": "soltero",
"name": "Soltero",
"created_at": null,
"updated_at": null
},
"nationality": {"id": 144,
"code": "MEX",
"name": "Mexican",
"country": "Mexico",
"created_at": null,
"updated_at": null
},
"state": {"id": 7,
"code": "DF",
"name": "Ciudad de México",
"country": "México",
"created_at": null,
"updated_at": null
}
}
}

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
addresses_similarity	number Porcentaje de similitud entre las direcciones registradas
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

Payload

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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

Borra una persona

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

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

Payload

Content type

application/json

{"curp": "PESJ880212HDFHLX01"
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

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

Payload

Content type

application/json

{"start_date": "2022-07-29",
"end_date": "2022-07-29",
"exclude": ["address"
]
}

Response samples

403
422
500

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

200
403
422
500

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

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67,
"addresses": [{"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,
"created_at": "2022-07-29T21:54:22.000000Z",
"updated_at": "2022-07-29T21:54:22.000000Z"
}
],
"contact_data": [{"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"
}
],
"references": [{"id": "840c8d68-6e39-4390-8062-176151f8ff29",
"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Ruiz",
"phone": "5548694812",
"person_relation_id": 7,
"created_at": "2022-07-29T22:00:26.000000Z",
"updated_at": "2022-07-29T22:00:26.000000Z"
}
],
"marital_status": {"id": "1,",
"code": "soltero",
"name": "Soltero",
"created_at": null,
"updated_at": null
},
"nationality": {"id": 144,
"code": "MEX",
"name": "Mexican",
"country": "Mexico",
"created_at": null,
"updated_at": null
},
"state": {"id": 7,
"code": "DF",
"name": "Ciudad de México",
"country": "México",
"created_at": null,
"updated_at": null
}
}
}

Obtiene una persona por su Id de Facetec

Authorizations:

apiKey

path Parameters

facetec_id

required

string

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

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
addresses_similarity	number Porcentaje de similitud entre las direcciones registradas
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

Payload

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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67,
"addresses": [{"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,
"created_at": "2022-07-29T21:54:22.000000Z",
"updated_at": "2022-07-29T21:54:22.000000Z"
}
],
"contact_data": [{"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"
}
],
"references": [{"id": "840c8d68-6e39-4390-8062-176151f8ff29",
"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Ruiz",
"phone": "5548694812",
"person_relation_id": 7,
"created_at": "2022-07-29T22:00:26.000000Z",
"updated_at": "2022-07-29T22:00:26.000000Z"
}
],
"marital_status": {"id": "1,",
"code": "soltero",
"name": "Soltero",
"created_at": null,
"updated_at": null
},
"nationality": {"id": 144,
"code": "MEX",
"name": "Mexican",
"country": "Mexico",
"created_at": null,
"updated_at": null
},
"state": {"id": 7,
"code": "DF",
"name": "Ciudad de México",
"country": "México",
"created_at": null,
"updated_at": null
}
}
}

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

Payload

Content type

application/json

{"document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
"password": "sg3sd2g1",
"elements": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"is_permanent": false,
"external_person_id": null,
"expires_in": 15,
"metadata": null,
"fillable_elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filled_at": "2021-08-04T15:14:56.000000Z",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z"
}
]
}
}

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

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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": [{"liveness": false,
"match_id": true,
"executed_at": "2022-07-27T17:23:27.590942Z",
"match_level": 6
}
],
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

Obtener los documentos relacionados a esta persona en la plataforma Signt

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"is_permanent": false,
"external_person_id": null,
"expires_in": 15,
"metadata": null,
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null
}
}
]
}

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

200
403
404
422
500

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

Payload

Content type

application/json

{"validations": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
403
404
422
500

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

Payload

Content type

application/json

{"validations": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
403
404
422
500

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

200
403
404
500

Content type

application/json

{"success": true,
"result": [{"id": "004804fe-b074-46d3-9c61-66c02f5fd6d2",
"model_type": "App\\Models\\Person",
"model_id": "16e06a78-d2ea-4396-b866-340da00dc9d6",
"validation_id": "7c75f50d-28b4-4041-86ea-29d6280ea2c7",
"status": 0,
"content": {"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT"
},
"metadata": null,
"error": null,
"retries": 0,
"executed_at": "2022-07-29T17:16:20.000000Z",
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z"
}
]
}

Obtener los resultados biometricos de una persona

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": [{"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": {"safe": true,
"success": true,
"matchLevel": 7,
"executed_at": "2022-11-30T16:37:39.239Z",
"referenceId": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
"wasProcessed": true,
"nfcStatusEnumInt": 0,
"fullIDStatusEnumInt": 0,
"barcodeStatusEnumInt": 0,
"matchLevelNFCToFaceMap": 0,
"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
"idScanAgeEstimateGroupEnumInt": 4
}
}
]
}

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

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"dynamic_property_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"values": {"example": "test_01"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/person/2b7c7b3b-5d4f-4c3d-8b1e-4b8e6c4c5f69/dynamic-values?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/person/2b7c7b3b-5d4f-4c3d-8b1e-4b8e6c4c5f69/dynamic-values?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/person/2b7c7b3b-5d4f-4c3d-8b1e-4b8e6c4c5f69/dynamic-values?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/person/2b7c7b3b-5d4f-4c3d-8b1e-4b8e6c4c5f69/dynamic-values",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

Addresses

Informacion de las direcciones de las personas registradas

Obtener todas las direcciones registradas

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"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,
"created_at": "2022-07-29T21:54:22.000000Z",
"updated_at": "2022-07-29T21:54:22.000000Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/addresses?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/addresses?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/addresses?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/addresses",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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

Responses

Request samples

Payload

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
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"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,
"created_at": "2022-07-29T21:54:22.000000Z",
"updated_at": "2022-07-29T21:54:22.000000Z"
}
}

Obtener una direccion por Id

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"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,
"created_at": "2022-07-29T21:54:22.000000Z",
"updated_at": "2022-07-29T21:54:22.000000Z"
}
}

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

Responses

Request samples

Payload

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
}

Response samples

200
403
404
422
500

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,
"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

200
403
404
500

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

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"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": {"safe": true,
"success": true,
"matchLevel": 7,
"executed_at": "2022-11-30T16:37:39.239Z",
"referenceId": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
"wasProcessed": true,
"nfcStatusEnumInt": 0,
"fullIDStatusEnumInt": 0,
"barcodeStatusEnumInt": 0,
"matchLevelNFCToFaceMap": 0,
"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
"idScanAgeEstimateGroupEnumInt": 4
}
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/biometrics?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/biometrics?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/biometrics?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/biometrics",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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

Payload

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": {"safe": true,
"success": true,
"matchLevel": 7,
"executed_at": "2022-11-30T16:37:39.239Z",
"referenceId": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
"wasProcessed": true,
"nfcStatusEnumInt": 0,
"fullIDStatusEnumInt": 0,
"barcodeStatusEnumInt": 0,
"matchLevelNFCToFaceMap": 0,
"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
"idScanAgeEstimateGroupEnumInt": 4
}
}

Obtener un resultado biometrico por id

Authorizations:

apiKey

path Parameters

id	string <uuid>

Responses

Response samples

200
403
404

Content type

application/json

{"success": true,
"result": {"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": {"safe": true,
"success": true,
"matchLevel": 7,
"executed_at": "2022-11-30T16:37:39.239Z",
"referenceId": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
"wasProcessed": true,
"nfcStatusEnumInt": 0,
"fullIDStatusEnumInt": 0,
"barcodeStatusEnumInt": 0,
"matchLevelNFCToFaceMap": 0,
"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
"idScanAgeEstimateGroupEnumInt": 4
}
}
}

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

Payload

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": {"safe": true,
"success": true,
"matchLevel": 7,
"executed_at": "2022-11-30T16:37:39.239Z",
"referenceId": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
"wasProcessed": true,
"nfcStatusEnumInt": 0,
"fullIDStatusEnumInt": 0,
"barcodeStatusEnumInt": 0,
"matchLevelNFCToFaceMap": 0,
"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
"idScanAgeEstimateGroupEnumInt": 4
}
}

Response samples

200
403
404
422
500

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": {"safe": true,
"success": true,
"matchLevel": 7,
"executed_at": "2022-11-30T16:37:39.239Z",
"referenceId": "dev-71266b80-f04b-4a2c-9314-963d3a182f2a",
"wasProcessed": true,
"nfcStatusEnumInt": 0,
"fullIDStatusEnumInt": 0,
"barcodeStatusEnumInt": 0,
"matchLevelNFCToFaceMap": 0,
"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT",
"idScanAgeEstimateGroupEnumInt": 4
}
}

Person Contacts

Informacion de contacto de las personas registradas

Obtener la informacion de contacto de todas las personas

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"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"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/person-contact?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/person-contact?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/person-contact?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/person-contact",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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

Payload

Content type

application/json

{"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"email": "user@example",
"phone": "525591038054"
}

Response samples

201
403
422
500

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

200
403
404
500

Content type

application/json

{"success": true,
"result": {"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>

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

Payload

Content type

application/json

{"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"email": "user@example",
"phone": "525591038054"
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"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"
}
}

Borrar la informacion de contacto

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

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

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"phone": "525546134819"
}

Response samples

200
403
404
422
500

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

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"phone": "525546134819",
"code": "006421"
}

Response samples

200
403
404
422
500

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

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"email": "test@example.com"
}

Response samples

200
403
404
422
500

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

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"email": "test@example.com",
"code": "006421"
}

Response samples

200
403
404
422
500

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

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "840c8d68-6e39-4390-8062-176151f8ff29",
"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Ruiz",
"phone": "5548694812",
"person_relation_id": 7,
"created_at": "2022-07-29T22:00:26.000000Z",
"updated_at": "2022-07-29T22:00:26.000000Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/person-references?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/person-references?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/person-references?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/person-references",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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

Payload

Content type

application/json

{"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Suares",
"phone": "525586128954",
"person_relation_id": 1
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "840c8d68-6e39-4390-8062-176151f8ff29",
"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Ruiz",
"phone": "5548694812",
"person_relation_id": 7,
"created_at": "2022-07-29T22:00:26.000000Z",
"updated_at": "2022-07-29T22:00:26.000000Z"
}
}

Obtener una referencia personal

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "840c8d68-6e39-4390-8062-176151f8ff29",
"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Ruiz",
"phone": "5548694812",
"person_relation_id": 7,
"created_at": "2022-07-29T22:00:26.000000Z",
"updated_at": "2022-07-29T22:00:26.000000Z"
}
}

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

Payload

Content type

application/json

{"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Suares",
"phone": "525586128954",
"person_relation_id": 1
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "840c8d68-6e39-4390-8062-176151f8ff29",
"person_id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"name": "Juan Perez Ruiz",
"phone": "5548694812",
"person_relation_id": 7,
"created_at": "2022-07-29T22:00:26.000000Z",
"updated_at": "2022-07-29T22:00:26.000000Z"
}
}

Borrar una referencia personal

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Validations

Informacion de las validaciones registradas

Obtener todas las validacions

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"currelected bank id is invalid.ent_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "LicenseValidation",
"class": "App\\Validations\\DocumentValidation",
"active": true,
"config": {"url": "https://api.test.rem.tools/qr/license",
"body": [ ],
"type": "document",
"headers": [ ],
"collection": "license",
"success_if": "true",
"file_field_name": "document"
},
"created_at": "2022-07-20T00:23:04.000000Z",
"updated_at": "2022-07-20T00:23:04.000000Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/validations?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/validations?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/validations?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/validations",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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

Payload

Content type

application/json

{"name": "LicenseValidation",
"class": "curp",
"active": true,
"config": { }
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "LicenseValidation",
"class": "App\\Validations\\DocumentValidation",
"active": true,
"config": {"url": "https://api.test.rem.tools/qr/license",
"body": [ ],
"type": "document",
"headers": [ ],
"collection": "license",
"success_if": "true",
"file_field_name": "document"
},
"created_at": "2022-07-20T00:23:04.000000Z",
"updated_at": "2022-07-20T00:23:04.000000Z"
}
}

Obtener los detalles de la validacion

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "LicenseValidation",
"class": "App\\Validations\\DocumentValidation",
"active": true,
"config": {"url": "https://api.test.rem.tools/qr/license",
"body": [ ],
"type": "document",
"headers": [ ],
"collection": "license",
"success_if": "true",
"file_field_name": "document"
},
"created_at": "2022-07-20T00:23:04.000000Z",
"updated_at": "2022-07-20T00:23:04.000000Z"
}
}

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

Payload

Content type

application/json

{"name": "LicenseValidation",
"active": true,
"config": { }
}

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "LicenseValidation",
"class": "App\\Validations\\DocumentValidation",
"active": true,
"config": {"url": "https://api.test.rem.tools/qr/license",
"body": [ ],
"type": "document",
"headers": [ ],
"collection": "license",
"success_if": "true",
"file_field_name": "document"
},
"created_at": "2022-07-20T00:23:04.000000Z",
"updated_at": "2022-07-20T00:23:04.000000Z"
}
}

Borrar una validacion

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

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

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "004804fe-b074-46d3-9c61-66c02f5fd6d2",
"model_type": "App\\Models\\Person",
"model_id": "16e06a78-d2ea-4396-b866-340da00dc9d6",
"validation_id": "7c75f50d-28b4-4041-86ea-29d6280ea2c7",
"status": 0,
"content": {"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT"
},
"metadata": null,
"error": null,
"retries": 0,
"executed_at": "2022-07-29T17:16:20.000000Z",
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/validation-results?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/validation-results?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/validation-results?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/validation-results",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

Obtener un resultado de validacion

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "004804fe-b074-46d3-9c61-66c02f5fd6d2",
"model_type": "App\\Models\\Person",
"model_id": "16e06a78-d2ea-4396-b866-340da00dc9d6",
"validation_id": "7c75f50d-28b4-4041-86ea-29d6280ea2c7",
"status": 0,
"content": {"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT"
},
"metadata": null,
"error": null,
"retries": 0,
"executed_at": "2022-07-29T17:16:20.000000Z",
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z"
}
}

Borrar un resultado de validacion

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

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

200
403
422
500

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

200
403
422
500

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

200
403
422
500

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

200
403
422
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": 1,
"model_type": "App\\Models\\Person",
"model_id": "d77d9617-0d66-4d6a-827e-f0fe86b5fb17",
"uuid": "393612eb-dc24-407a-874f-cf04935fe4b7",
"collection_name": "ine_front",
"name": "ine_front",
"file_name": "ine_front.png",
"mime_type": "image/jpeg",
"disk": "s3",
"conversions_disk": "s3",
"size": 167805,
"manipulations": [ ],
"custom_properties": null,
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/files/get-from-model?model_id=14f209d5-2793-4561-ac95-ab8a03aa7dbd&model=person&page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/files/get-from-model?model_id=14f209d5-2793-4561-ac95-ab8a03aa7dbd&model=person&page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/files/get-from-model?model_id=14f209d5-2793-4561-ac95-ab8a03aa7dbd&model=person&page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/files/get-from-model",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

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

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": 1,
"model_type": "App\\Models\\Person",
"model_id": "d77d9617-0d66-4d6a-827e-f0fe86b5fb17",
"uuid": "393612eb-dc24-407a-874f-cf04935fe4b7",
"collection_name": "ine_front",
"name": "ine_front",
"file_name": "ine_front.png",
"mime_type": "image/jpeg",
"disk": "s3",
"conversions_disk": "s3",
"size": 167805,
"manipulations": [ ],
"custom_properties": null,
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z",
"tmp_url": "http://api.test.rem.tools/tmp/14f209d5-2793-4561-ac95-ab8a03aa7dbd?expires_in_min=2"
}
}

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

200
403
422
500

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

200
403
500

Content type

application/json

{"success": true,
"result": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "SlackFailValidations",
"type": "slack",
"active": true,
"events": ["person_register"
],
"config": {"emails": ["user@example.com"
]
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
]
}

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

Payload

Content type

application/json

{"name": "SlackFailValidations",
"type": "slack",
"active": true,
"events": ["person_register"
],
"config": {"emails": ["user@example.com"
]
}
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "SlackFailValidations",
"type": "slack",
"active": true,
"events": ["person_register"
],
"config": {"emails": ["user@example.com"
]
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Obtener un canal de notificaciones

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "SlackFailValidations",
"type": "slack",
"active": true,
"events": ["person_register"
],
"config": {"emails": ["user@example.com"
]
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

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

Payload

Content type

application/json

{"name": "SlackFailValidations",
"type": "slack",
"active": true,
"events": ["person_register"
],
"config": {"emails": ["user@example.com"
]
}
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "SlackFailValidations",
"type": "slack",
"active": true,
"events": ["person_register"
],
"config": {"emails": ["user@example.com"
]
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Borrar un canal de notificaciones

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Person Employment Data

Informacion de los empleos de las personas registradas

Obtener datos laborales de una persona

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
],
"first_page_url": "http://api.test.rem.tools/onboarding/person-employment-data?page=1",
"from": null,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/person-employment-data?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/person-employment-data?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/person-employment-data",
"per_page": 20,
"prev_page_url": null,
"to": null,
"total": 0
}
}

Crear datos laborales de una persona

Authorizations:

apiKey

Request Body schema: application/json

person_id	string <uuid>
current_occupation	string Ocupacion actual
position	string Puesto
industry	string Industria
company_name	string Nombre de la empresa
company_phone	string Telefono de la empresa
company_address	string Direccion de la empresa
seniority	integer Antiguedad en años

Responses

Request samples

Payload

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
}

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

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

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

Actualizar datos laborales 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 Ocupacion actual
position	string Puesto
industry	string Industria
company_name	string Nombre de la empresa
company_phone	string Telefono de la empresa
company_address	string Direccion de la empresa
seniority	integer Antiguedad en años

Responses

Request samples

Payload

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
}

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

Eliminar datos laborales 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

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Person Bank Data

Informacion de los bancos de las personas registradas

Obtener datos bancarios de una persona

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"bank": "Banamex",
"account": 1234567890,
"clabe": 12345678901234568,
"metadata": {"ok": true,
"formatOk": true,
"error": null,
"message": "Valid",
"clabe": "002010077777777771",
"tag": "BANAMEX",
"bank": "Banco Nacional de México",
"city": "Aguascalientes MX-AGU",
"multiple": false,
"total": 1,
"account": "07777777777",
"code": {"bank": "002",
"city": "010"
},
"checksum": 1
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/person-bank-data?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/person-bank-data?page=1",
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/person-bank-data",
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
}
}

Crear datos bancarios de una persona

Authorizations:

apiKey

Request Body schema: application/json

person_id	string <uuid>
bank	string Nombre del banco
account	string Numero de cuenta
clabe	string Clabe interbancaria

Responses

Request samples

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"bank": "Banamex",
"account": 1234567890,
"clabe": 12345678901234568
}

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"bank": "Banamex",
"account": 1234567890,
"clabe": 12345678901234568,
"metadata": {"ok": true,
"formatOk": true,
"error": null,
"message": "Valid",
"clabe": "002010077777777771",
"tag": "BANAMEX",
"bank": "Banco Nacional de México",
"city": "Aguascalientes MX-AGU",
"multiple": false,
"total": 1,
"account": "07777777777",
"code": {"bank": "002",
"city": "010"
},
"checksum": 1
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

Obtener datos bancarios de una persona por 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

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"bank": "Banamex",
"account": 1234567890,
"clabe": 12345678901234568,
"metadata": {"ok": true,
"formatOk": true,
"error": null,
"message": "Valid",
"clabe": "002010077777777771",
"tag": "BANAMEX",
"bank": "Banco Nacional de México",
"city": "Aguascalientes MX-AGU",
"multiple": false,
"total": 1,
"account": "07777777777",
"code": {"bank": "002",
"city": "010"
},
"checksum": 1
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

Actualizar datos bancarios 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
account	string Numero de cuenta
clabe	string Clabe interbancaria

Responses

Request samples

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"bank": "Banamex",
"account": 1234567890,
"clabe": 12345678901234568
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"bank": "Banamex",
"account": 1234567890,
"clabe": 12345678901234568,
"metadata": {"ok": true,
"formatOk": true,
"error": null,
"message": "Valid",
"clabe": "002010077777777771",
"tag": "BANAMEX",
"bank": "Banco Nacional de México",
"city": "Aguascalientes MX-AGU",
"multiple": false,
"total": 1,
"account": "07777777777",
"code": {"bank": "002",
"city": "010"
},
"checksum": 1
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

Eliminar datos bancarios 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

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Person Financial Data

Informacion financiera de las personas registradas

Obtener datos financieros de una persona

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"monthly_income": 0,
"monthly_expenses": 0,
"metadata": {"credit_amount": 1000000,
"credit_frequency": "MENSUAL",
"credit_periods": 12
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/person-financial-data?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/person-financial-data?page=1",
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/person-financial-data",
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
}
}

Crear datos financieros de una persona

Authorizations:

apiKey

Request Body schema: application/json

person_id	string <uuid>
monthly_income	number <float> Ingreso mensual
monthly_expenses	number <float> Egresos mensuales
metadata	object Informacion adicional

Responses

Request samples

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"monthly_income": 0,
"monthly_expenses": 0,
"metadata": {"credit_amount": 1000000,
"credit_frequency": "MENSUAL",
"credit_periods": 12
}
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"monthly_income": 0,
"monthly_expenses": 0,
"metadata": {"credit_amount": 1000000,
"credit_frequency": "MENSUAL",
"credit_periods": 12
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

Obtener 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

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"monthly_income": 0,
"monthly_expenses": 0,
"metadata": {"credit_amount": 1000000,
"credit_frequency": "MENSUAL",
"credit_periods": 12
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

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
monthly_expenses	number <float> Egresos mensuales
metadata	object Informacion adicional

Responses

Request samples

Payload

Content type

application/json

{"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"monthly_income": 0,
"monthly_expenses": 0,
"metadata": {"credit_amount": 1000000,
"credit_frequency": "MENSUAL",
"credit_periods": 12
}
}

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
"monthly_income": 0,
"monthly_expenses": 0,
"metadata": {"credit_amount": 1000000,
"credit_frequency": "MENSUAL",
"credit_periods": 12
},
"created_at": "2019-08-24",
"updated_at": "2019-08-24"
}
}

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

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Custom Catalogs

Catalogos personalizados

Obtener catalogos personalizados

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Catalogo de prueba",
"description": "Catalogo de prueba",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/custom-catalogs?page=1",
"from": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/custom-catalogs?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/custom-catalogs?page=1",
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/custom-catalogs",
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
}
}

Crear catalogo personalizado

Authorizations:

apiKey

Request Body schema: application/json

name	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Catalogo de prueba",
"description": "Catalogo de prueba"
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Catalogo de prueba",
"description": "Catalogo de prueba",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Obtener catalogo personalizado por id

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del catalogo personalizado

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Catalogo de prueba",
"description": "Catalogo de prueba",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z",
"values": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"label": "Test 01",
"type": "string",
"value": "test_01",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
]
}
}

Actualizar catalogo 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

Payload

Content type

application/json

{"name": "Catalogo de prueba",
"description": "Catalogo de prueba"
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Catalogo de prueba",
"description": "Catalogo de prueba",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Eliminar catalogo personalizado

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del catalogo personalizado

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Custom Catalog Values

Valores de los catalogos personalizados

Obtener valores de catalogos personalizados

Authorizations:

apiKey

query Parameters

custom_catalog_id

string <uuid>

Example: custom_catalog_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del catalogo personalizado

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"label": "Test 01",
"type": "string",
"value": "test_01",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/custom-catalog-values?page=1",
"from": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/custom-catalog-values?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/custom-catalog-values?page=1",
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/custom-catalog-values",
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
}
}

Crear valor de catalogo 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

Responses

Request samples

Payload

Content type

application/json

{"custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"label": "Test 01",
"type": "string",
"value": "test_01"
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"label": "Test 01",
"type": "string",
"value": "test_01",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Obtener valor de catalogo 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

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"label": "Test 01",
"type": "string",
"value": "test_01",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Actualizar valor de catalogo 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

Responses

Request samples

Payload

Content type

application/json

{"custom_catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"label": "Test 01",
"type": "string",
"value": "test_01"
}

Response samples

200
403
404
422
500

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",
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}

Eliminar valor de catalogo personalizado

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor de catalogo personalizado

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Insertar valores de catalogos personalizados en masa

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

201
403
422
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Dynamic Properties

Propiedades dinamicas de las personas

Obtener propiedades dinamicas

Authorizations:

apiKey

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": "Ok",
"current_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Test 01",
"description": "Test 01",
"key": "test_01",
"descriptor": [{"title": "Test 01",
"type": "string",
"rules": ["max:50",
"min:10"
],
"catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a"
}
],
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/dynamic-properties?page=1",
"from": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/dynamic-properties?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/dynamic-properties?page=1",
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/dynamic-properties",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 1
}

Crear propiedad dinamica

Authorizations:

apiKey

Request Body schema: application/json

name	string
description	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"name": "Test 01",
"description": "Test 01",
"descriptor": [{"title": "Test 01",
"type": "string",
"rules": ["max:50",
"min:10"
],
"catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a"
}
]
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Test 01",
"description": "Test 01",
"key": "test_01",
"descriptor": [{"title": "Test 01",
"type": "string",
"rules": ["max:50",
"min:10"
],
"catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a"
}
],
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Obtener propiedad dinamica por id

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la propiedad dinamica

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Test 01",
"description": "Test 01",
"key": "test_01",
"descriptor": [{"title": "Test 01",
"type": "string",
"rules": ["max:50",
"min:10"
],
"catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a"
}
],
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Actualizar propiedad dinamica

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

Payload

Content type

application/json

{"name": "Test 01",
"description": "Test 01",
"descriptor": [{"title": "Test 01",
"type": "string",
"rules": ["max:50",
"min:10"
],
"catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a"
}
]
}

Response samples

200
403
404
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "Test 01",
"description": "Test 01",
"key": "test_01",
"descriptor": [{"title": "Test 01",
"type": "string",
"rules": ["max:50",
"min:10"
],
"catalog_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a"
}
],
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Eliminar propiedad dinamica

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la propiedad dinamica

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Guardar valores de propiedad dinamica

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 Valores de las propiedades dinamicas

Responses

Request samples

Payload

Content type

application/json

{"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"dynamic_property_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"values": {"example": "test_01"
}
}

Response samples

201
403
422
500

Content type

application/json

{"success": true,
"result": {"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"dynamic_property_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"values": {"example": "test_01"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}
}

Dynamic Values

Valores de las propiedades dinamicas de las personas

Obtener valores dinamicos

Authorizations:

apiKey

query Parameters

descriptor_id	string <uuid> Example: descriptor_id=51319186-a4a0-4497-a3c9-ebdbdaca0159 Id de la propiedad dinamica
person_id	string <uuid> Example: person_id=51319186-a4a0-4497-a3c9-ebdbdaca0159 Id de la persona

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"dynamic_property_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"values": {"example": "test_01"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/dynamic-values?page=1",
"from": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/dynamic-values?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/dynamic-values?page=1",
"next_page_url": null,
"path": "http://api.test.rem.tools/onboarding/dynamic-values",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 1
}
}

Obtener valor dinamico por id

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor dinamico

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"dynamic_property_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"values": {"example": "test_01"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Eliminar valor dinamico

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del valor dinamico

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"result": "Ok"
}

Public

API publica para el manejo de personas

Autenticar persona temporal

Authorizations:

apiKey

Request Body schema: application/json

Datos de la persona temporal

verification_fields

object

3 datos a escoger de la persona temporal

Responses

Request samples

Payload

Content type

application/json

{"verification_fields": {"name": "John",
"last_name": "Doe",
"national_id": "1234567890"
}
}

Response samples

200
401
422
500

Content type

application/json

{"success": true,
"result": {"token": "1|2zOfls4wMuiZ45Jth9bAE9VEwmjbh8vGgBHr3fOE",
"tmp_person_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}
}

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

Payload

Content type

application/json

{"event": "person_register",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"resource_name": "person",
"payload": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

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

Payload

Content type

application/json

{"event": "person_pass_validation",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"resource_name": "person",
"payload": {"id": "004804fe-b074-46d3-9c61-66c02f5fd6d2",
"model_type": "App\\Models\\Person",
"model_id": "16e06a78-d2ea-4396-b866-340da00dc9d6",
"validation_id": "7c75f50d-28b4-4041-86ea-29d6280ea2c7",
"status": 0,
"content": {"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT"
},
"metadata": null,
"error": null,
"retries": 0,
"executed_at": "2022-07-29T17:16:20.000000Z",
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"validation": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "LicenseValidation",
"class": "App\\Validations\\DocumentValidation",
"active": true,
"config": {"url": "https://api.test.rem.tools/qr/license",
"body": [ ],
"type": "document",
"headers": [ ],
"collection": "license",
"success_if": "true",
"file_field_name": "document"
},
"created_at": "2022-07-20T00:23:04.000000Z",
"updated_at": "2022-07-20T00:23:04.000000Z"
}
}
}

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

Payload

Content type

application/json

{"event": "person_fail_validation",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"resource_name": "person",
"payload": {"id": "004804fe-b074-46d3-9c61-66c02f5fd6d2",
"model_type": "App\\Models\\Person",
"model_id": "16e06a78-d2ea-4396-b866-340da00dc9d6",
"validation_id": "7c75f50d-28b4-4041-86ea-29d6280ea2c7",
"status": 0,
"content": {"digitalIDSpoofStatusEnumInt": 0,
"faceOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_FACE",
"textOnDocumentStatusEnumInt": "LIKELY_ORIGINAL_TEXT"
},
"metadata": null,
"error": null,
"retries": 0,
"executed_at": "2022-07-29T17:16:20.000000Z",
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"validation": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"name": "LicenseValidation",
"class": "App\\Validations\\DocumentValidation",
"active": true,
"config": {"url": "https://api.test.rem.tools/qr/license",
"body": [ ],
"type": "document",
"headers": [ ],
"collection": "license",
"success_if": "true",
"file_field_name": "document"
},
"created_at": "2022-07-20T00:23:04.000000Z",
"updated_at": "2022-07-20T00:23:04.000000Z"
}
}
}

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

Payload

Content type

application/json

{"event": "person_restore",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"resource_name": "person",
"payload": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}

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

Payload

Content type

application/json

{"event": "updated_data_to_person",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"resource_name": "person_contact",
"payload": {"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,
"created_at": "2022-07-29T21:54:22.000000Z",
"updated_at": "2022-07-29T21:54:22.000000Z",
"person": {"id": "a777fe73-6b66-4d02-93d6-c9cc87409243",
"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,
"addresses_similarity": null,
"marital_status_id": null,
"people_group_id": null,
"extra_data": null,
"created_at": "2022-07-29T17:16:20.000000Z",
"updated_at": "2022-07-29T17:16:20.000000Z",
"age": 34,
"information_percentage": 0.67
}
}
}

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

Payload

Content type

application/json

{"event": "added_media_to_model",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"resource_name": "media",
"payload": {"id": 1,
"model_type": "App\\Models\\Person",
"model_id": "d77d9617-0d66-4d6a-827e-f0fe86b5fb17",
"uuid": "393612eb-dc24-407a-874f-cf04935fe4b7",
"collection_name": "ine_front",
"name": "ine_front",
"file_name": "ine_front.png",
"mime_type": "image/jpeg",
"disk": "s3",
"conversions_disk": "s3",
"size": 167805,
"manipulations": [ ],
"custom_properties": null,
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Credit Bureau Requests

Obtener solicitudes de buro de credito

Authorizations:

apiKey

Responses

Response samples

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"data": [{"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"report_provider": "cdc",
"report_type": "ingresos",
"verification_code": "123456",
"verification_contact": "example@mail.com",
"config": {"productoRequerido": "007"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
],
"first_page_url": "https://api.test.rem.tools/onboarding/credit-bureau-requests?page=1",
"from": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://api.test.rem.tools/onboarding/credit-bureau-requests?page=1",
"label": "1",
"active": true
},
{"url": null,
"label": "Next &raquo;",
"active": false
}
],
"last_page": 1,
"last_page_url": "http://api.test.rem.tools/onboarding/credit-bureau-requests?page=1",
"next_page_url": null
}
}

Crear solicitud de buro de credito

Authorizations:

apiKey

Request Body schema: application/json

Datos de la solicitud

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 Configuracion para la solicitud de buro de credito
created_at	string <date>
updated_at	string <date>

Responses

Request samples

Payload

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": {"productoRequerido": "007"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}

Response samples

201
422
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"report_provider": "cdc",
"report_type": "ingresos",
"verification_code": "123456",
"verification_contact": "example@mail.com",
"config": {"productoRequerido": "007"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Obtener solicitud de buro de credito por id

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la solicitud de buro de credito

Responses

Response samples

200
404
500

Content type

application/json

{"success": true,
"result": {"id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"person_id": "b94252a1-c4ef-4aa5-a799-de77dc02fd5a",
"report_provider": "cdc",
"report_type": "ingresos",
"verification_code": "123456",
"verification_contact": "example@mail.com",
"config": {"productoRequerido": "007"
},
"created_at": "2022-07-29T21:54:55.000000Z",
"updated_at": "2022-07-29T21:54:55.000000Z"
}
}

Eliminar solicitud de buro de credito

Authorizations:

apiKey

path Parameters

id

required

string <uuid>

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id de la solicitud de buro de credito

Responses

Response samples

200
404
500

Content type

application/json

{"success": true,
"result": "Ok"
}