Retrieve Published Versions for a Group

"Published" versions for the Contracts included in a Group. The purpose of the "Published" call is so that you can get a fast, real-time response to get the Version IDs of the Contracts you'e displaying to your Signer. If you're doing a full server-side flow using the Activity API, you'll be able to follow this flow on the Activity API:

  1. To get the Versions your signer should be accepting, use HTTP GET => /published?sid={site_access_id}&gkey={group_key}

  2. If you want to get the latest Version IDs already accepted by your user, do something like HTTP GET => /latest?sig={signer_id}&sid={site_access_id}&gkey={group_key}

  3. Load form on the page to capture user sign up and acceptance.

  4. Pass Version IDs and Contract IDs to HTTP POST => /send?sid={site_access_id}&cid={contract_ids}&vid={version_ids}&sig={signer_ids}&gid={group-id}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

What's required?

In order to get the information back you'd like, we give you the flexibility to decide what you want to query against to get the info you need. Only one of the following is required:

  • Include a Group Key to check against all Contracts in a specific Group.
  • Specify Contract IDs — If you don't use Groups or prefer to just check the latest by Contract ID, include a comma-separated set of Contract IDs.
Query Params
string
required

The Site Access ID for the Ironclad Clickwrap Site.

string

Optional. The key for a group of Contracts that will be evaluated, with all the latest versions being accepted and returned as true or false.

string

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

Responses

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