Comercios
Obtener la URL de prueba de vida de Woovi
Obtén o regenera la URL de prueba de vida de Woovi necesaria para completar la activación de la cuenta BRL Pix - Woovi de comercios de personas físicas.
POST
/
v2
/
merchant
/
woovi
/
liveness
Obtener la URL de prueba de vida de Woovi
curl --request POST \
--url https://api-test.velafi.com/v2/merchant/woovi/liveness \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"merchantId": 123,
"generateNewLiveness": true
}
'import requests
url = "https://api-test.velafi.com/v2/merchant/woovi/liveness"
payload = {
"merchantId": 123,
"generateNewLiveness": True
}
headers = {
"X-BH-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BH-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({merchantId: 123, generateNewLiveness: true})
};
fetch('https://api-test.velafi.com/v2/merchant/woovi/liveness', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/merchant/woovi/liveness")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": 123,\n \"generateNewLiveness\": true\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"livenessId": "<string>",
"livenessUrl": "<string>",
"expiresAt": "<string>",
"status": "<string>",
"failReason": "<string>"
}
}Usa este endpoint para obtener la URL de prueba de vida de Woovi para un comercio de persona física que está activando una cuenta BRL Pix con el proveedor Woovi. El comercio debe completar la prueba de vida en la URL devuelta antes de que llames a Activar persona física con
trench: "Pix - Woovi". Si el comercio no ha completado la prueba y la URL anterior ya expiró, volver a llamar a este endpoint devuelve una URL nueva.
Todas las solicitudes deben incluir el encabezado
X-BH-TOKEN y Content-Type: application/json. Este endpoint aplica solo a comercios de personas físicas cuya verificación KYC esté aprobada (estado del comercio 2) y cuya cuenta tenga acceso al canal Pix - Woovi. Llámalo antes de la solicitud de activación: la activación falla con el código de error -5059 hasta que se complete la prueba de vida.Endpoint
POST https://api.velafi.com/v2/merchant/woovi/liveness
Parámetros de la solicitud
number
requerido
ID del comercio que requiere la prueba de vida.
boolean
Actualmente se ignora: la API no reenvía este valor, así que siempre se trata como
false. Para obtener una URL nueva después de que la anterior expire, vuelve a llamar a este endpoint.Campos de la respuesta
number
Código de respuesta tipo HTTP.
200 indica éxito.string
Mensaje de estado legible, p. ej.
SUCCESS.object
Mostrar campos de data
Mostrar campos de data
string
Identificador único de esta sesión de prueba de vida.
string
URL que el comercio debe visitar para completar la prueba de vida. Contiene un JWT de corta duración.
string
Marca de tiempo Unix (segundos) en que expira la URL de prueba de vida.
string
Estado actual de la prueba de vida:
PENDING: la prueba de vida aún no se completa; envía al comercio alivenessUrlCOMPLETED: la prueba de vida se aprobó; si todavía no activas el canal, ya puedes llamar al endpoint de activaciónKYC_APPROVED: el canal Pix - Woovi del comercio ya está activo
string
Motivo de la falla de la prueba de vida, si aplica.
Ejemplo
cURL
curl -X POST https://api.velafi.com/v2/merchant/woovi/liveness \
-H "X-BH-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"merchantId": 151209,
"generateNewLiveness": false
}'
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"livenessId": "00000000-0000-0000-0000-000000000007",
"livenessUrl": "https://app.sandbox.avenia.io/liveness/00000000-0000-0000-0000-000000000000?jwt=...",
"expiresAt": "1788244424",
"status": "PENDING",
"failReason": ""
}
}
La
livenessUrl contiene un JWT de corta duración y expira en el momento indicado en expiresAt. Si la URL expira antes de que el comercio complete la prueba, vuelve a llamar a este endpoint para recibir una URL nueva.⌘I
Obtener la URL de prueba de vida de Woovi
curl --request POST \
--url https://api-test.velafi.com/v2/merchant/woovi/liveness \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"merchantId": 123,
"generateNewLiveness": true
}
'import requests
url = "https://api-test.velafi.com/v2/merchant/woovi/liveness"
payload = {
"merchantId": 123,
"generateNewLiveness": True
}
headers = {
"X-BH-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BH-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({merchantId: 123, generateNewLiveness: true})
};
fetch('https://api-test.velafi.com/v2/merchant/woovi/liveness', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/merchant/woovi/liveness")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": 123,\n \"generateNewLiveness\": true\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"livenessId": "<string>",
"livenessUrl": "<string>",
"expiresAt": "<string>",
"status": "<string>",
"failReason": "<string>"
}
}