IRironcladapp

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.

post/send

Request

  • Base URL
    https://pactsafe.io
  • URL
    https://pactsafe.io/send
  • Auth
    none required

Query parameters

sidstring required

The Site Access ID for the Ironclad Clickwrap Site.

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

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

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

cidstring

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

gidinteger

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

gkeystring

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.

cnfstring

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

first_namestring

Reserved property of Signer.

last_namestring

Reserved property of Signer.

namestring

Reserved property of Signer (alternative to first_name / last_name).

emailstring

Reserved property of Signer.

company_namestring

Reserved property of Signer.

titlestring

Reserved property of Signer.

customer_idstring

Example of a custom property.

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.

CompanyNamestring

Example - use token name to dynamically inject data into final acceptance record.

SignerNamestring

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

slostring

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

tmboolean

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

server_sideboolean

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.

Response

200

integer required

Example response

200

Changes

No recorded changes to this operation across all 1 revision of this API.