API Reference
Status PageRoadmapTestimoniesShare feedback

Add Signer Consent Request to a Signature Request

post
https://api-sandbox.yousign.app/v3/signature_requests//consent_requests

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Signature Request Id

Body Params
string
enum
required

Type of the Signer Consent Request

Allowed:
settings
object
required

Settings relative to Signer Consent Request's type

boolean
required

Define if the Signer Consent Request is optional for Signers

signer_ids
array of uuids
required
length ≥ 1

Ids of Signers to request a consent

signer_ids*
uuid | null

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

uuid | null

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

Responses

Updated 9 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago