Send Email OTP

Endpoint que envía un código de verificación mediante correo electrónico. Al enviarse el mensaje, este endpoint genera un id para poder ser utilizado en el endpoint de verificación.

Es necesario ingresar 2 campos para hacer uso de este endpoint:

Key	Data Type	Example	Description
email	String	user@email.com	Correo de destino para el OTP
nin	String	19332147-4	Número identificador de una persona

Endpoint

Headers

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {{access_token}}	access_token obtained in Atenea

Url

Method: POST
URL: https://api.trust.lat/verification/api/v2/verification/mail

caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea

Como obtener un access token

info

Este servicio soporta personalización, para usarla, tiene que ingresar su configuración en el siguiente servicio:

Como ingresar configuraciones de personalización

Body

Para ingresar los datos se hará mediante la selección de form-data en la herramienta Postman.

Key	Value
number	user@email.com
nin	19332147-4

Code Examples

Curl

curl --location --request POST 'https://api.trust.lat/verification/api/v2/verification/mail' \
--header 'Authorization: Bearer {{accessToken}}' \
--form 'email="user@email.com"' \
--form 'nin="15668951-9"'

JavaScript

import requests

url = "https://api.trust.lat/verification/api/v2/verification/mail"

payload={'email': 'user@email.com',
'nin': '15668951-9'}
files=[

]
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Python

var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();
data.append('email', 'user@email.com');
data.append('nin', '15668951-9');

var config = {
  method: 'post',
  url: 'https://api.trust.lat/verification/api/v2/verification/mail',
  headers: { 
    'Authorization': 'Bearer {{accessToken}}', 
    ...data.getHeaders()
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Responses

HTTP Code: 200 OK - Verify

{
    "status": true,
    "message": "El correo electrónico se envió correcamente al email: user@email.com",
    "obj": {
        "id": "b4acf5f5-4179-4dab-b3f4-82d55740a362"
    }
}

HTTP Code: 401 Error

{
    "status": false,
    "message": "Datos insuficientes."
}

HTTP Code: 422 Unprocessable Entity

{
    "status": false,
    "message": "El formato del correo electrónico es inválido"
}

{
    "status": false,
    "message": "El correo electrónico es requerido"
}