🔓 Débloquer un signataire
/document/unlockclé privéeprk_Ce service permet de gérer les signataires bloqués pendant le processus de validation d'identité, aussi bien pour les documents que pour les packages. Il vous permet d'approuver, de rejeter, de redémarrer ou d'annuler le processus pour les signataires qui ont été bloqués par le système de sécurité.
Ce service ne s'applique qu'aux signataires qui se trouvent dans un état bloqué pendant la validation d'identité.
Authentification​
Incluez votre clé privée dans l'en-tête Authorization.
Authorization: prk_xxx...
Paramètres de création​
| Nom | Type | Description |
|---|---|---|
code | String obligatoire | Code du document ou du package concaténé avec l'ID du signataire (par ex. DOCUMENTCODEID ou PACKAGECODEID) |
email | String obligatoire | E-mail de l'utilisateur de l'organisation qui approuve ou rejette le participant bloqué |
status | String obligatoire | Action Ă effectuer : approve, reject, reset, cancel |
message | String conditionnel | Note ou motif de l'approbateur. Obligatoire lorsque status vaut approve ou cancel. Non accepté pour reject ou reset |
Le champ code identifie aussi bien les documents que les packages : il s'agit du code du document (ou du package) concaténé avec l'ID du signataire bloqué. Le système détecte automatiquement le type de processus.
Actions disponibles​
- approve : Approuve la validation d'identité du signataire (nécessite le champ
message) - reject : Rejette la validation d'identité du signataire
- reset : Redémarre le processus (ne s'applique qu'à la signature par WhatsApp ; sinon, fonctionne comme reject)
- cancel : Annule le processus de signature (nécessite le champ
message)
🧪 Exemples d'utilisation​
Approuver un signataire bloqué​
- curl
- Python
- Node.js
curl --location 'https://api.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",
"message": "Identité vérifiée avec succès"
}'
import requests
import json
url = "https://api.auco.ai/v1.5/ext/document/unlock"
payload = json.dumps({
"code": "DOCUMENTCODEID",
"email": "approver@auco.ai",
"status": "approve",
"message": "Identité vérifiée avec succès"
})
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',
message: 'Identité vérifiée avec succès',
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.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);
});
Approuver un signataire de package​
Pour les packages, le champ code correspond au code du package concaténé avec l'ID du signataire.
- curl
- Python
- Node.js
curl --location 'https://api.auco.ai/v1.5/ext/document/unlock' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "PACKAGECODEID",
"email": "approver@auco.ai",
"status": "approve",
"message": "Identité vérifiée avec succès"
}'
import requests
import json
url = "https://api.auco.ai/v1.5/ext/document/unlock"
payload = json.dumps({
"code": "PACKAGECODEID",
"email": "approver@auco.ai",
"status": "approve",
"message": "Identité vérifiée avec succès"
})
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: 'PACKAGECODEID',
email: 'approver@auco.ai',
status: 'approve',
message: 'Identité vérifiée avec succès',
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.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);
});
Annuler le processus avec un motif​
- curl
- Python
- Node.js
curl --location 'https://api.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": "Tentative de fraude détectée"
}'
import requests
import json
url = "https://api.auco.ai/v1.5/ext/document/unlock"
payload = json.dumps({
"code": "DOCUMENTCODEID",
"email": "approver@auco.ai",
"status": "cancel",
"message": "Tentative de fraude détectée"
})
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: 'Tentative de fraude détectée'
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.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);
});
Exemples de réponse​
Réponse réussie​
{
"message": "OK"
}
⚠️ Réponses d'erreur​
| Code | Description |
|---|---|
| 400 | Paramètres manquants, validations non applicables, ID du signataire manquant dans le code (MISSING_SIGNER_ID) ou processus non bloqué (NOT_BLOCKED_PROCESS) |
| 401 | Authentification invalide ou absente |