Find Identity By Uuid
Este endpoint permite recuperar desde el servicio una identidad (Persona-Compañia), utilizando su identificador uuid para reconocerla. Este identificador es entregado como una variable de ruta. En caso de que el identificador apunte a una identidad fusionada, sólo se retorna el uuid de la identidad actual. (Una identidad fusionada es documento mongodb eliminado que representaba parcialmente una identidad, que fue utilizado en conjunto con otros documentos que contenian información de la misma identidad para formar un nuevo documento y así consolidar la información)
Endpoint
Headers
Key | Value | Description |
---|---|---|
Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Method: GET
URL: https://api.trust.lat/index/v1/identity/:uuid
Path Variables:
Key | Value Example | Description |
---|---|---|
uuid | ffffffff-ffff-ffff-ffff-ffffffffffff | Identificador único de la identidad. Obligatorio. |
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea
Code Examples
- Curl
- JavaScript
- Python
curl --location --request GET 'https://api.trust.lat/index/v1/identity/ffffffff-ffff-ffff-ffff-ffffffffffff' \
--header 'Authorization: Bearer ************'
import requests
url = "https://api.trust.lat/index/v1/identity/ffffffff-ffff-ffff-ffff-ffffffffffff"
payload={}
headers = {
'Authorization': 'Bearer ************'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api.trust.lat/index/v1/identity/ffffffff-ffff-ffff-ffff-ffffffffffff',
headers: {
'Authorization': 'Bearer ************'
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Response Body
Data Fields
- apps: Arreglo de apps que contiene información sobre las apps relacionadas con la identidad.
- app.app_id: Identificador de la aplicación asociada.
- app.tags: Diccionario que contiene todos los nombres de tags asociados a la aplicación como llave y su valor como la información asociada a dicha llave.
- app.version: Rótulo que señala cual versión de la aplicación Trust está asociada al dispositivo.
- company_uid: Identificador de compañia provisto por empresa Trust.
- dni: Número verificador de identidad de la persona.
- email: Número verificador de identidad de la persona.
- _former_documents: Arreglo que contiene identificadores uuid de identidades fusionadas (Ver descripción de endpoint).
- img: Dirección url donde se encuentra la imagen del perfil de la identidad.
- last_name: Apellido de la persona a la cual pertenece la identidad.
- load_uuid: Identificador otorgado a usuarios creados en carga masiva de datos.
- name: Nombre de la persona a la cual pertenece la identidad.
- nationality: Sigla que representa el país de origen de la persona.
- phone_number: Número de teléfono asociado a la identidad Persona-Compañia.
- status: Estado actual del usuario en el servicio oauth.
- trust_id: Identificador de dispositivo provisto por la empresa Trust.
- uuid: Identificador único de la identidad.
Responses Examples
HTTP Code: 200 OK
Identity found
{
"code": 200,
"resource": "Identity",
"data": {
"apps": [
{
"app_id": "99",
"created_at": null,
"person": {
"dni": "123456789",
"email": "abeta@example.test"
},
"tags": {
"systemic_client_type": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"updated_at": null,
"version": "3"
}
],
"company_uid": "99",
"created_at": "2021-07-07T21:05:43.657Z",
"dni": "12.345.678-9",
"email": "abeta@example.test",
"former_documents": null,
"img": "https://robohash.org/123456789",
"last_name": "beta",
"load_uuid": null,
"name": "alfa",
"nationality": "CHL",
"phone_number": "+56912345678",
"status": true,
"trust_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"updated_at": "2021-07-07T21:05:43.657Z",
"uuid": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"message": "Found"
}
HTTP Code: 404 Not Found
Identity not present in Index
{
"code": 404,
"resource": "Identity",
"message": "Not found in database neither in former documents"
}
Identity's uuid points to a former document
{
"code": 404,
"resource": "Identity",
"message": "Not found. Posible merge in document with uuid: ffffffff-ffff-ffff-ffff-ffffffffffff"
}