Qodex.ai

/procedures

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

Now that the file is uploaded, send the following request to create a procedure.

It's important to underline that email addresses need to have an existing domain. In addition, the phone numbers need to be valid numbers and follow the E.164 recommendation. Finally, please note that the page number of the documents starts at 1 and not 0.

The status field for a procedure can have many values:

StatusDescription
draftThe signing process is not started, so no one can sign it. However, it is still possible to edit the procedure.
activeThe procedure is started, members can sign it.
finishedAll members have finished to sign the procedure.
expiredYou can set an expiration date in the expiresAt field (in ISO format like the createdAt field above - e.g. 2018-08-05T07:46:45+02:00). After this date, members can't sign it anymore.
refusedAt least, one of members decided to refuse the procedure. It mainly means that he did not agree with the content of the documents to sign or maybe it is not the right contact to make on this signature.

Request Body

{"name"=>"My first procedure", "description"=>"Awesome! Here is the description of my first procedure", "members"=>[{"firstname"=>"John", "lastname"=>"Doe", "email"=>"john.doe@yousign.fr", "phone"=>"+33612345678", "fileObjects"=>[{"file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "page"=>2, "position"=>"230,499,464,589", "mention"=>"Read and approved", "mention2"=>"Signed by John Doe"}]}]}

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":"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"My first procedure","description":"Awesome! Here is the description of my first procedure","createdAt":"2018-12-01T11:49:11+01:00","updatedAt":"2018-12-01T11:49:11+01:00","finishedAt":null,"expiresAt":null,"status":"active","creator":null,"creatorFirstName":null,"creatorLastName":null,"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","template":false,"ordered":false,"parent":null,"metadata":[],"config":[],"members":[{"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-01T11:49:11+01:00","updatedAt":"2018-12-01T11:49:11+01:00","finishedAt":null,"status":"pending","fileObjects":[{"id":"/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","file":{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-01T11:36:20+01:00","updatedAt":"2018-12-01T11:49:11+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null},"page":2,"position":"230,499,464,589","fieldName":null,"mention":"Read and approved","mention2":"Signed by John Doe","createdAt":"2018-12-01T11:49:11+01:00","updatedAt":"2018-12-01T11:49:11+01:00","parent":null,"reason":"Signed by Yousign"}],"comment":null,"notificationsEmail":[],"operationLevel":"custom","operationCustomModes":["sms"],"operationModeSmsConfig":null,"parent":null}],"subscribers":[],"files":[{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-01T11:36:20+01:00","updatedAt":"2018-12-01T11:49:11+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null}],"relatedFilesEnable":false,"archive":false,"archiveMetadata":[],"fields":[],"permissions":[]}