π Unlock Signer
POST /document/unlock
This service allows you to manage blocked signers during the identity validation process. This service enables you to approve, reject, restart, or cancel the process for signers who have been blocked by the security system.
info
This service only applies to signers who are in a blocked state during identity validation.
Authenticationβ
Include your private key in the Authorization
header.
Authorization: prk_xxx...
Creation Parametersβ
Name | Type | Required | Description |
---|---|---|---|
code | string | Required | Document code concatenated with the signer ID e.g. ['DOCUMENTCODEID'] |
email | string | Required | Email of the company user who approves or rejects the blocked participant |
status | string | Required | Action to perform: approve , reject , reset , cancel |
message | string | Conditional | Cancellation reason. This field is required only when status is cancel . For other actions this field is not accepted |
Available Actionsβ
- approve: Approves the signer's identity validation
- reject: Rejects the signer's identity validation
- reset: Restarts the process (Only applies to WhatsApp signing, otherwise works the same as reject)
- cancel: Cancels the signing process (requires
message
field)
π§ͺ Usage Examplesβ
Approve blocked signerβ
- 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);
});
Cancel process with reasonβ
- 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": "Fraud attempt detected"
}'
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": "Fraud attempt detected"
})
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: 'Fraud attempt detected'
});
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);
});
Response Examplesβ
Successful responseβ
{
"message": "OK"
}
β οΈ Error Responsesβ
Code | Description |
---|---|
400 | Missing parameters, or some validations do not meet applicability conditions |
401 | Invalid or missing authentication |
404 | Missing signer ID in code or signer is not blocked |