Approver
What is an Approver?
An Approver represents any person that needs to validate the content of a Signature Request before it can be signed. It can be, for example, a manager or a member of the legal service.
The use of Approvers allows you to build up a validation workflow for your Signature Requests. Indeed, a Signer will NOT be notified and therefore won't be able to sign a Signature Request until every Approver attached to it has given its approbation.
As mentioned above, an Approver can be any person implied in the validation process of a Signature Request. Therefore, it can be added in several ways:
- as an existing User through its unique identifier
- as an existing Contact through its unique identifier
- as an existing Signer through its unique identifier
- through its first name, last name and email
You'll find code examples for each case below.
If a person is intended to approve and sign a Signature request, it MUST be added as a Signer AND an Approver. This can be done by using one of those two options:
- adding it as a Signer first then adding it as an Approver through its Signer unique identifier
- adding it as a Signer through its first name, last name and email and as an Approver the same way.
Limitation
A maximum of 10 approvers can be added per Signature Request.
All the endpoints available to manage Approvers can be found in our API Reference.
What if an Approver rejects a Signature Request?
If an Approver refuses to validate a Signature Request, it is possible for him to add a refusal reason. This value can be retrieved in approver.rejected
webhook's payload.
Delivery mode of the Signature Request to the approver
Each Approver can access and approve the Signature Request through a unique link. Depending on the delivery_mode configured for the Signature Request, this link will be sent to each one of them by email or returned in response to the Signature Request activation call. For more information about the Signature Request activation call, take a look at this page.
How to add an Approver
POST /signature_requests/{signatureRequestId}/approvers
Add an ad hoc Approver
{
"info": {
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+33700000000",
"locale": "fr"
}
}
Add an Approver from a User
HTTP POST
{
"user_id": "{{userId}}",
}
Add an Approver from a Contact
HTTP POST
{
"contact_id": "{{contactId}}"
}
Add an Approver from a Signer
HTTP POST
{
"signer_id": "{{signerId}}"
}
Response example
HTTP 201
{
"id": "{{approverId}}",
"status": "initiated | notified | approved | rejected"
"info": {
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+33700000000",
"locale": "fr"
}
}
Updated 7 months ago