GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Create an Embeddable Recipient URL for a Signer

post
https://na1.ironcladapp.com/public/api/v1/workflows//signatures/recipient-urls/embedded

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier or Ironclad ID of a workflow.

Body Params
string
enum
required

The type of recipient.

Allowed:
string
required

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

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

boolean

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

Headers
string

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.

string

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.

Responses

Updated 7 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago