/consent_processes
POST {{base-api-url}}/consent_processes
Here are the details of parameters:
| Param | Description |
|---|---|
template | As with procedure templates, consent process templates may be reused several times through several procedures. |
members | List of members who will be attached to this consent process. |
file | This value is optional. If necessary, it’s possible to specify a particular file for a checkbox or text to be copied. If no file is specified, then the item will be global to the signature procedure. |
description | Text to copy by the signer. |
type | Type of the item of the consent process: checkbox or text. |
required | Specify whether this item of the consent process is mandatory (true) or optional (false). |
expectedValue | Expected value for a checkbox needs to be true and if the item is a text to write, then the expected value will be Text to write. |
position | Position allows you to define the ordre of each item in the signature process. |
Request Body
{"template"=>false, "members"=>["/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"], "file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "description"=>"Here is the text to copy of my first consent process.", "type"=>"checkbox", "required"=>true, "expectedValue"=>true, "position"=>1}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | This value is a secret and needs to be replaced by your API Key (Bearer). | |
Content-Type | string | This header specifies the format of the exchanges in JSON. |
RESPONSES
status: Created
{"id":"/consent_processes/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","type":"checkbox","description":"Here is the text to copy of my first consent process.","required":true,"position":1,"expectedValue":true,"members":["/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"],"file":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}