A consent is a text that the participant can agree to before signing a document. Universign’s default consent on a document is “I have read, and I accept this document”. Consents are added at field level and are therefore specific to each participant. You can create up to 10 custom consents per field in addition to Universign’s default consent. They will add up on the signature page underneath each document for each participant to agree to.
There are 2 types of consents :
- mandatory consents: The participant must agree to before signing a document.
- optional consents: The participant has the choice to agree to or not before signing a document.
Before you can set optional_consents, ensure with us that this feature is activated on your workspace.
Note that you can add consents only for signature and visa field types.
You can add consents in 2 ways:
- when creating a field,
- when updating a field.
Note that if you pass URLs, they will not be interpreted.
Add mandatory consents when creating a field
To add mandatory consents when you create a field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields and pass the consents argument in plain text:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d consents= "I do accept all terms and conditions stated in this document".
Add or update mandatory consents on an existing field
To add or update mandatory consents on an existing field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id} and pass the consents argument in plain text:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields/fld_a998 \
-d consents= "I do accept all terms and conditions stated in this document."
Add optional consents when creating a field
To add optional consents when you create a field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields and pass the optional_consents argument in plain text:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d optional_consents= "I do accept to be contacted by the signature service provider once the document is signed".
Add or update optional consents on an existing field
To add or update optional consents on an existing field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id} and pass the optional_consents argument in plain text:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields/fld_a998 \
-d optional_consents= "I do agree to be phone called by the signature service provider once the document is signed."
