Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Create a Recipient URL for a Signer

Create a recipient URL for a signer or viewer to access the signature request.

This functionality is exclusive to Ironclad Signature. See this help center article for more information.

OAuth Scope required: public.workflows.createSignatureRecipientUrls

post/workflows/{id}/signatures/recipient-urls

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. 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.

Request body

OR

Example request

{
  "roleName": "Counterparty Signer"
}

Response

201

urlstring required

The URL for the recipient to access the signature request.

Example response

{
  "url": "https://na1.ironcladapp.com/sign?r=5e51f2b9-a684-4c50-887c-32911b661300&s=b2a303cd-f7a0-425e-8f36-d94e38c4e1a8"
}