Send Acceptance

The purpose of the "Send" call is so that you can send a fast, real-time call to Ironclad to capture an electronic signature of your Contracts.

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

The Site Access ID for the Ironclad Clickwrap Site.

string
required

Signer ID. The unique identifier used to save your signer's signature. Can be email, mobile number, GUID, UUID, or any integer. Should be URL encoded.

string
required

Version IDs. Note: NOT an integer, this is a UUID found in the version details of your contract. A set of comma separated values requesting if a Signer has accepted the latest version of a set of Contract IDs. *Only optional if passing an updated event type.

string
required

Event Type. Any value can be accepted here, but the default events you can pass to the Activity API are displayed, updated, agreed, visited, sent, and disagreed.

string

Optional. Contract IDs. A set of comma separated values requesting if a Signer has accepted the latest version of a set of Contract IDs.

int32

Optional. The Group ID that all the Contracts are a part of will also be added to your call if added.

string

Optional. The Group key that all the Contracts are a part of. If only Group key is provided, the associated Group ID would be added to the acceptance.

string

Optional. Email Confirmation. Use 1 or true here to send an email confirmation to the signer.

cus
object

Optional. Custom Data. URL encode a JSON object to attach custom data to your Activity. The example is URL encoded for { "first name": "Eric" } Using this in an updated Activity will append the data to the Signer, otherwise it will be added to the specific Activity call/transaction.

rnd
object

Optional. Render Data. URL encode a JSON object to attach render data to your Activity and populate tokens on your final contract. The example is URL encoded for { "CompanyName": "Ironclad" }.

string

Optional. The location key for the Snapshot Location that should be linked to this acceptance.

boolean

Optional. Test Mode. Whether or not to process the acceptance in test_mode. Defaults to false, pass either 1 or true to enable it.

boolean

If sending via server-side, this parameter should be set to true. Additionally, this will give you a JSON response with a 200 status code and a body of 200 rather than a 1x1 pixel image.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

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