/members
POST {{base-api-url}}/members
There are 2 kinds of signers.
On the one hand, there are the signers who do not have any account at the Yousign application and in this case these participants will be defined by the following information: firstname, lastname, email, phone.
On the other hand, there are signatories who already have an account on the Yousign application. In this case, it's sufficient to add them via their ID:
Or, if the signer has a personal account on Yousign application: "user": "/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",.
The status field for a member can have many values:
| Status | Description |
|---|---|
pending | The signer has been invited to sign but has not yet signed. |
processing | The signatory has signed and our system has received this request and is processing it (it's a temporary status). |
done | The signer has signed and our system has carried out the signature on all documents. If the documents are downloaded from this moment on, they will contain the signature of the signer concerned. |
refused | The participant refused to sign or validate the procedure. This usually means that he does not agree with the content of a document. A rejection message can be added by the participant. |
Request Body
{"firstname"=>"John", "lastname"=>"Doe", "email"=>"john.doe@yousign.fr", "phone"=>"+33612345678", "procedure"=>"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}
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":"/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","user":null,"type":"signer","firstname":"John","lastname":"Doe","email":"john.doe@yousign.fr","phone":"+33612345678","position":1,"createdAt":"2018-12-01T14:01:53+01:00","updatedAt":"2018-12-01T14:01:53+01:00","finishedAt":null,"status":"pending","fileObjects":[],"procedure":"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","comment":null,"notificationsEmail":[],"operationLevel":"custom","operationCustomModes":["sms"],"operationModeSmsConfig":null,"parent":null}