🔓 Desbloquear Firmante
POST /document/unlock
Con este servicio puedes gestionar firmantes bloqueados durante el proceso de validación de identidad. Este servicio permite aprobar, rechazar, reiniciar o cancelar el proceso para firmantes que han sido bloqueados por el sistema de seguridad.
info
Este servicio solo aplica para firmantes que se encuentren en estado bloqueado durante la validación de identidad.
Autenticación
Incluye tu llave privada en el encabezado Authorization
.
Authorization: prk_xxx...
Parámetros de creación
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
code | string | Requerido | Código del documento concatenado al ID del firmante ej: ['DOCUMENTCODEID'] |
email | string | Requerido | Email del usuario de la compañía que aprueba o rechaza el participante bloqueado |
status | string | Requerido | Acción a realizar: approve , reject , reset , cancel |
message | string | Condicional | Motivo de cancelación. Este campo es requerido únicamente cuando status es cancel . Para otras acciones no se acepta este campo |
Acciones disponibles
- approve: Aprueba la validación de identidad del firmante
- reject: Rechaza la validación de identidad del firmante
- reset: Reinicia el proceso (Solo aplica para firma por WhatsApp, en caso contrario funciona igual que reject)
- cancel: Cancela el proceso de firma (requiere campo
message
)
🧪 Ejemplos de uso
Aprobar firmante bloqueado
- curl
- Python
- Node.js
curl --location 'https://dev.auco.ai/v1.5/ext/document/unlock' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "DOCUMENTCODEID",
"email": "approver@auco.ai",
"status": "approve"
}'
import requests
import json
url = "https://dev.auco.ai/v1.5/ext/document/unlock"
payload = json.dumps({
"code": "DOCUMENTCODEID",
"email": "approver@auco.ai",
"status": "approve"
})
headers = {
'Authorization': 'prk_private_key_company',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
let data = JSON.stringify({
code: 'DOCUMENTCODEID',
email: 'approver@auco.ai',
status: 'approve'
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://dev.auco.ai/v1.5/ext/document/unlock',
headers: {
Authorization: 'prk_private_key_company',
'Content-Type': 'application/json',
},
data: data,
};
axios
.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
Cancelar proceso con motivo
- curl
- Python
- Node.js
curl --location 'https://dev.auco.ai/v1.5/ext/document/unlock' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "DOCUMENTCODEID",
"email": "approver@auco.ai",
"status": "cancel",
"message": "Intento de fraude detectado"
}'
import requests
import json
url = "https://dev.auco.ai/v1.5/ext/document/unlock"
payload = json.dumps({
"code": "DOCUMENTCODEID",
"email": "approver@auco.ai",
"status": "cancel",
"message": "Intento de fraude detectado"
})
headers = {
'Authorization': 'prk_private_key_company',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
let data = JSON.stringify({
code: 'DOCUMENTCODEID',
email: 'approver@auco.ai',
status: 'cancel',
message: 'Intento de fraude detectado'
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://dev.auco.ai/v1.5/ext/document/unlock',
headers: {
Authorization: 'prk_private_key_company',
'Content-Type': 'application/json',
},
data: data,
};
axios
.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
Ejemplos de respuesta
Respuesta exitosa
{
"message": "OK"
}
⚠️ Respuestas de error
Código | Descripción |
---|---|
400 | Faltan parámetros, o alguna de las validaciones no coinciden con las condiciones de aplicabilidad |
401 | Autenticación inválida o ausente |
404 | Falta ID del firmante en el código o no se encuentra bloqueado |