/operations
POST {{base-api-url}}/operations
The operations allow you to create an authentication request for the list of members. You also will be able to define the authentication mode used for the defined participants.
Only one member can be defined for an external signer while one to several members can be defined for internal signers (users) in connected mode.
Finally, the metadas on operations allow you to specify additional information on the signer. This is generally the case for his IP address in order to trace it within the proof file compiled by Yousign (within a specific section).
Request Body
{"mode"=>"sms", "type"=>"accept", "members"=>["/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"], "metadata"=>{"John Doe - IP address"=>"1.1.1.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":"/operations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","createdAt":"2018-12-28T14:56:43+01:00","updatedAt":"2018-12-28T14:56:43+01:00","authentication":{"id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","status":"active","type":"sms"},"mode":"sms","status":"pending","type":"accept","metadata":{"John Doe - IP address":"1.1.1.1"}}