Create a signing request

Authorization

basicAuth

AuthorizationBasic <token>

In: header

Path Parameters

organizationId*string

signingRoomId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

callbackUrl?string

Endpoint URL listening to the callback sent by the system once the request is completed, cancelled or expired. Intermediate callbacks can be activated from the signature options to be notified of intermediate responses in the particular case of collective signature.

Formaturl

deliveryOptions?

Additional options for the delivery of the signing request.

documents*array<>

List of the documents to be sent.

locale?string

Default correspondence language for the new users

message?string

Additional information provided to the signatories when the signing request was submitted

signatoriesEmails?array<string>

List of the signatories defined by their emails. The document will be delivered and signed in the same order of the given list.Must not be set if signatoriesIds is already provided.

signatoriesEmailsSize?integer

Formatint32

signatoriesIds?array<string>

List of the signatories defined by their signing room user ID. The document will be delivered and signed in the same order of the given list.Must not be set if signatoriesEmails is already provided.

signatoriesIdsSize?integer

Formatint32

signatureOptions?

Additional options for the signing request.

signingOrder*string

The signing order to be used for multi signatories request

Default"SEQUENTIAL"

Value in

"SEQUENTIAL"
"PARALLEL"

workflowId?string

The workflow id to be used for the signing request. May be null if a unique workflow is configured to the signing room

Response Body

`application/json`

Callbacks

curl -X POST "https://example.com/admin/api/v3/organizations/string/rooms/string/requests" \  -H "Content-Type: application/json" \  -d '{    "documents": [      {        "title": "string"      }    ],    "signingOrder": "SEQUENTIAL"  }'

[  {    "auditTrailAvailable": true,    "canceledAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": {      "displayName": "string"    },    "deliveryOptions": {      "recipients": [        {          "email": "string",          "locale": "string"        }      ]    },    "documents": [      {        "id": "string",        "payloadSigned": true,        "payloadType": "PDF",        "responses": [          {            "decision": "ACCEPTED",            "id": "string",            "payloadSigned": true,            "rejectionMessage": "string",            "repliedAt": "2019-08-24T14:15:22Z",            "signatory": {              "displayName": "string",              "email": "string",              "firstname": "string",              "id": "string",              "lastname": "string",              "locale": "string",              "manager": true,              "phoneNumber": "string",              "signatoryAttributes": [                {                  "displayName": "string",                  "key": "string",                  "required": true,                  "value": "string"                }              ],              "signingRoomPermission": "SIGNATORY",              "username": "string"            }          }        ],        "thumbnail": "string",        "title": "string"      }    ],    "expiresAt": "2019-08-24T14:15:22Z",    "id": "string",    "lastModifiedAt": "2019-08-24T14:15:22Z",    "message": "string",    "retainedUntil": "2019-08-24T14:15:22Z",    "signatories": [      {        "displayName": "string",        "email": "string",        "firstname": "string",        "id": "string",        "lastname": "string",        "locale": "string",        "manager": true,        "phoneNumber": "string",        "signatoryAttributes": [          {            "displayName": "string",            "key": "string",            "required": true,            "value": "string"          }        ],        "signingRoomPermission": "SIGNATORY",        "username": "string"      }    ],    "signingOrder": "SEQUENTIAL",    "state": "PENDING",    "workflow": {      "authenticationProvider": "string",      "deliveryOptions": {        "allowManagerToAddRecipients": true,        "domainNames": [          "string"        ],        "sendSigningReportToAllManager": true      },      "description": "string",      "electronicSeal": true,      "enabledByDefault": true,      "id": "string",      "identification": true,      "name": "string",      "preassignedSignatories": {        "allowEdition": true,        "signatories": [          {            "email": "string",            "locale": "string"          }        ]      },      "regulation": "EIDAS",      "signatureLevel": "SES",      "smartContractIdentifier": "string"    }  }]

Create a signing request

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401

404

428

Callbacks

signingRequestCompletedPOST{$request.body#/callbackUrl}

`application/json`

`application/json`