API Reference

Create dossier

post
https://api.cm.com/sign/v1/dossiers

Create a new dossier to sign. For the webhook event structure see the Callbacks tab.

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

You need to provide one or more file id's you've uploaded previously and add the invitees and fields for the persons that need to sign or review the document(s).

A dossier owner can be specified, but this is optional.

uuid

Id of the dossier

string
required
length ≤ 255

human readable name for this dossier

string
enum

Every dossier is initialized with the draft state. When the dossier is pending, it will have sent out any invitations for signing. From this point, the dossier is mostly no longer editable. Once the everyone has signed, the state becomes completed and the signed dossier will be ready for retrieval. If any invitee declines the state of the dossier will become delinced. After the dossier expiry time has passed, a dossier will always enter the expired state. In the expired state a dossier can no longer be completed or declined. Once the state is deleted the signed contracts are no longer downloadable and all contracts and sensitive information are removed from the system.

Allowed:
string
enum
Defaults to en-US

Locale of the language to be used in the dossier

boolean | null

Place fields using the web interface

string | null

Optionally redirect the user to your website after the fields are placed. The url must begin with https://

string | null

The identifier of a time zone in the IANA database. This will change the time zone of dates used in communication to the recipient and dossier owner. By default Etc/UTC is used when no value is set.

number
60 to 7776000
Defaults to 2592000

The expiry in seconds since the dossier was created

number | null
86400 to 7776000

The time in seconds after the invite was sent to an invitee, after which an automatic reminder will be sent. Reminders only work if the invite emails were sent by Sign. To cancel all reminders for an existing dossier set value to null

boolean
Defaults to false

This determines if the dossier needs to be archived.

files
array of objects
required
files*
attachments
array of objects
attachments
owners
array of objects
owners
invitees
array of objects
invitees
uuid | null
Defaults to null

Create a dossier from a template. This means that files and field positions are automatically copied from the template. You can find the template ID in the dashboard.

templateLabelValues
object

Key-value pairs for template labels. The key must match the exact value of the predefined label in the template. It will then be overwritten by the value in the request.

Responses

Callback

Updated 29 days ago

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

Updated 29 days ago