IRironcladapp
Workflows

Create an Embeddable Recipient URL for a Signer

Changed on

Create an embeddable recipient URL for a signer 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.createEmbeddableSignerUrls

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

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/signatures/recipient-urls/embedded
  • 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.createEmbeddableSignerUrls

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.

Request body

type'signer' required

The type of recipient.

roleNamestring required

The role name of the signer. A full list of role names can be located using the List All Workflow Signers endpoint.

frameAncestorstring required

The hostname of the parent frame that the recipient URL can be embedded in. Can optionally include a URL scheme and/or port number. Wildcards (i.e. '*') are not allowed.

allowMultipleUsagesboolean

Whether or not the embeddable recipient URL can be used multiple times before it expires. Defaults to false if not set.

Example request

{
  "roleName": "Counterparty Signer",
  "frameAncestor": "https://example.com",
  "allowMultipleUsages": true
}

Response

201

urlstring required

The embeddable URL for the recipient to access the signature request. The URL can only be embedded in a parent matching the host specified in frameAncestor.

Example response

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

Changes