IRironcladapp
Workflows

Send Signature Request

Changed on

Send a signature request.

OAuth Scope required: public.workflows.sendSignatureRequests

Note: You can only send a packet out for signature if all signers have an associated signature or initials tag (tag requirements are dependent on the signature provider).

post/workflows/{id}/sign-status/send-signature-request

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/sign-status/send-signature-request
  • 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.sendSignatureRequests

Path parameters

idstring required

The unique identifier or Ironclad ID 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.

Response

200

routing'sequential' | 'parallel'

Indicates if routing is sequential (signatures collected in order) or parallel (all signers receive request simultaneously).

status'not_sent' | 'sent' | 'action_required' | 'complete'

Indicates the status of the signature request. NOTE: If status is 'action_required,' that means signature tags are missing for document.

requireSignedDocumentUploadboolean

Indicates if the document requires a signed document to be uploaded.

provider'Ironclad Clickwrap' | 'Ironclad Signature' | 'Ironclad Signature (Legacy)' | 'DocuSign' | 'Adobe Sign' | 'DropboxSign' | 'Custom Provider' | 'Demo' | 'None'

Indicates the signature provider used for the signature request, if any.

Example response

{
  "signers": [
    {
      "name": "Jane Doe",
      "email": "janedoe@example.com",
      "roleName": "Counterparty Signer",
      "status": "pending",
      "delegates": [
        {
          "name": "Kim Lam",
          "email": "kimlam@example.com"
        }
      ],
      "routingOrder": 1,
      "signsOutsideIronclad": true,
      "type": "internal",
      "userId": "63d415e0dd0d828c3a878548"
    }
  ],
  "routing": "sequential",
  "status": "sent",
  "provider": "Ironclad Signature"
}

Changes

  • 435da5a4396eRevision changes
    • warning

      added the new Custom Provider enum value to the response property for the response status

    • info

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

    • info

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