v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Signer Consent Request

Add Signer Consent Request to a Signature Request

Adds a Signer Consent Request to a given Signature Request. This action is only permitted when the Signature Request is a draft or paused.

post/signature_requests/{signatureRequestId}/consent_requests

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

Request body

type'checkbox' | 'text_to_copy' required

Type of the Signer Consent Request

optionalboolean required

Define if the Signer Consent Request is optional for Signers

signer_idsstring[] required

Ids of Signers to request a consent

insert_after_idstring uuid nullable

Insert just after the position of the specified Signer Consent Request id

document_idstring uuid nullable

Link the Signer Consent Request to a given Document by its id.

Example request

{
  "type": "checkbox",
  "settings": {
    "text": "I agree with..."
  },
  "signer_ids": [
    "71517741-a4a8-4f25-8496-6e9c6d2b7791",
    "0c42e1ae-1cac-457b-9a09-5fda5f735bd8"
  ],
  "document_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
}

Response

Created

idstring uuid required

Unique identifier of the Consent Request.

{"stackTrail":"components:schemas:SignerConsentRequest:properties:type","oasType":"schema","type":"unknown","description":"Type of the consent request."}

optionalboolean required

Indicates whether fulfilling this Consent Request is optional for completing the signature process.

document_idstring required

Identifier of the document associated with this Consent Request.

Example response

{
  "id": "550e8402-e29b-41d4-a716-446655440000",
  "optional": true,
  "document_id": "550e8402-e29b-41d4-a716-446655440000"
}