IRironcladapp
Workflows

Create a Signed Document on a Workflow

Changed on

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

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/upload-signed
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.uploadSignedDocuments

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. 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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body multipart/form-data

attachmentobject required

Must be a binary. Base64 is not accepted at this time.

Example request

{
  "metadata": {
    "signerRoleNames": [
      "Counterparty Signer"
    ],
    "muteCancellationNotifications": true
  }
}

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"
      }
    },
    "fileHash": "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12",
    "hashAlgorithm": "sha1"
  }
}

Changes

  • 435da5a4396eRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status