Skip to main content

πŸ”“ 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​

NameTypeRequiredDescription
codestringRequiredDocument code concatenated with the signer ID e.g. ['DOCUMENTCODEID']
emailstringRequiredEmail of the company user who approves or rejects the blocked participant
statusstringRequiredAction to perform: approve, reject, reset, cancel
messagestringConditionalCancellation 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 --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"
}'

Cancel process with reason​

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"
}'

Response Examples​

Successful response​

{
"message": "OK"
}

⚠️ Error Responses​

CodeDescription
400Missing parameters, or some validations do not meet applicability conditions
401Invalid or missing authentication
404Missing signer ID in code or signer is not blocked