v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Create a Signed Document on a Workflow

Upload a fully or partially signed document to a specified workflow that is in sign step.

OAuth Scope required: public.workflows.uploadSignedDocuments

post/workflows/{id}/upload-signed

Path parameters

idstring required

The unique identifier of a workflow

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

POST Signed Documents Response

OR

Example response

{
  "workflowId": "6dac47a10b1242d1f7df688d",
  "title": "Goldendoodle Adoption Contract",
  "signed": {
    "version": "B1QePArXb",
    "versionNumber": 2,
    "filename": "file.pdf",
    "key": "rJklwCHQ",
    "download": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download",
    "lastModified": {
      "timestamp": "2016-11-17T00:37:22.318Z",
      "author": {
        "type": "internalUser",
        "companyName": "Jabba the Hutt Industries",
        "displayName": "Boba Fett",
        "email": "boba@example.com",
        "userId": "63d415e0dd0d828c3a878548"
      }
    }
  }
}