/members

POST {{base-api-url}}/members

Here are the regarding values for type parameter:

ParamDescription
signerParticipant who will be required to sign the documents of the procedure. This is the default value.
validatorParticipant who will NOT be required to sign the documents of the procedure. The goal for the validator is to read the documents and to agree and approve the content without signing them. This allows to set up validation workflows with for example a legal service or with a manager.

To add a validator in your procedure, simply add the type parameter with validator value.

Request Body

{"firstname"=>"John", "lastname"=>"Doe", "email"=>"john.doe@yousign.fr", "phone"=>"+33612345678", "procedure"=>"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type"=>"validator"}

HEADERS

KeyDatatypeRequiredDescription
AuthorizationstringThis value is a secret and needs to be replaced by your API Key (Bearer).
Content-TypestringThis header specifies the format of the exchanges in JSON.

RESPONSES

status: Created

{"id":"/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","user":null,"type":"validator","firstname":"John","lastname":"Doe","email":"john.doe@yousign.fr","phone":"+33612345678","position":1,"createdAt":"2018-12-02T12:04:20+01:00","updatedAt":"2018-12-02T12:04:20+01:00","finishedAt":null,"status":"pending","fileObjects":[],"procedure":"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","comment":null,"notificationsEmail":[],"operationLevel":null,"operationCustomModes":[],"operationModeSmsConfig":null,"parent":null}