The Signing Document object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

document_type string

Default: document

template_type string

template_id string

source string

Default: document

title string required

company string

external_id string

signing_status string

Default: pending

completed_at string

signing_order string

Default: parallel

allow_dictate_next_signer boolean

Default: false

typed_signature_enabled boolean

Default: true

draw_signature_enabled boolean

Default: true

upload_signature_enabled boolean

Default: true

distribution_method string

Default: email

email_subject string

email_message string

redirect_url string

timezone string

Default: Etc/UTC

date_format string

Default: yyyy-MM-dd hh:mm a

language string

Default: en

expires_at string

reminder_settings string

auth_options string

form_values string

visibility string

Default: everyone

public_title string

public_description string

reference_doctype string

reference_name string

party_type string

party_name string

The Signing Document object

{
  "id": "signing-document_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "document_type": "document",
  "template_type": "template_type_example",
  "template_id": "template_id_example",
  "source": "document",
  "title": "title_example",
  "company": "Example Corp",
  "external_id": "external_id_example",
  "signing_status": "pending",
  "completed_at": "2024-01-15",
  "signing_order": "parallel",
  "allow_dictate_next_signer": false,
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "distribution_method": "email",
  "email_subject": "user@example.com",
  "email_message": "user@example.com",
  "redirect_url": "redirect_url_example",
  "timezone": "Etc/UTC",
  "date_format": "yyyy-MM-dd hh:mm a",
  "language": "en",
  "expires_at": "2024-01-15",
  "reminder_settings": "reminder_settings_example",
  "auth_options": "auth_options_example",
  "form_values": "form_values_example",
  "visibility": "everyone",
  "public_title": "public_title_example",
  "public_description": "public_description_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

GET /api/signing/signing-document/{id}

Retrieve a signing document

Retrieves the details of an existing signing document. Supply the unique signing document ID that was returned from a previous request.

Path parameters

id string required

The identifier of the signing document to retrieve.

Returns

Returns the signing document object if a valid identifier was provided.

GET /api/signing/signing-document/{id}

curl https://api.overplane.dev/api/signing/signing-document/signing-document_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "signing-document_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "document_type": "document",
  "template_type": "template_type_example",
  "template_id": "template_id_example",
  "source": "document",
  "title": "title_example",
  "company": "Example Corp",
  "external_id": "external_id_example",
  "signing_status": "pending",
  "completed_at": "2024-01-15",
  "signing_order": "parallel",
  "allow_dictate_next_signer": false,
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "distribution_method": "email",
  "email_subject": "user@example.com",
  "email_message": "user@example.com",
  "redirect_url": "redirect_url_example",
  "timezone": "Etc/UTC",
  "date_format": "yyyy-MM-dd hh:mm a",
  "language": "en",
  "expires_at": "2024-01-15",
  "reminder_settings": "reminder_settings_example",
  "auth_options": "auth_options_example",
  "form_values": "form_values_example",
  "visibility": "everyone",
  "public_title": "public_title_example",
  "public_description": "public_description_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

GET /api/signing/signing-document

List all signing documents

Returns a list of signing documents. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of signing document objects.

GET /api/signing/signing-document

curl https://api.overplane.dev/api/signing/signing-document \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "signing-document_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "document_type": "document",
      "template_type": "template_type_example",
      "template_id": "template_id_example",
      "source": "document",
      "title": "title_example",
      "company": "Example Corp",
      "external_id": "external_id_example",
      "signing_status": "pending",
      "completed_at": "2024-01-15",
      "signing_order": "parallel",
      "allow_dictate_next_signer": false,
      "typed_signature_enabled": true,
      "draw_signature_enabled": true,
      "upload_signature_enabled": true,
      "distribution_method": "email",
      "email_subject": "user@example.com",
      "email_message": "user@example.com",
      "redirect_url": "redirect_url_example",
      "timezone": "Etc/UTC",
      "date_format": "yyyy-MM-dd hh:mm a",
      "language": "en",
      "expires_at": "2024-01-15",
      "reminder_settings": "reminder_settings_example",
      "auth_options": "auth_options_example",
      "form_values": "form_values_example",
      "visibility": "everyone",
      "public_title": "public_title_example",
      "public_description": "public_description_example",
      "reference_doctype": "reference_doctype_example",
      "reference_name": "reference_name_example",
      "party_type": "party_type_example",
      "party_name": "party_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/signing/signing-document

Create a signing document

Creates a new signing document object.

Body parameters

status string

Default: draft

document_type string

Default: document

template_type string

template_id string

source string

Default: document

title string required

company string

external_id string

signing_status string

Default: pending

completed_at string

signing_order string

Default: parallel

allow_dictate_next_signer boolean

Default: false

typed_signature_enabled boolean

Default: true

draw_signature_enabled boolean

Default: true

upload_signature_enabled boolean

Default: true

distribution_method string

Default: email

email_subject string

email_message string

redirect_url string

timezone string

Default: Etc/UTC

date_format string

Default: yyyy-MM-dd hh:mm a

language string

Default: en

expires_at string

reminder_settings string

auth_options string

form_values string

visibility string

Default: everyone

public_title string

public_description string

reference_doctype string

reference_name string

party_type string

party_name string

Returns

Returns the newly created signing document object if the call succeeded.

POST /api/signing/signing-document

curl https://api.overplane.dev/api/signing/signing-document \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example"}'

Response

{
  "id": "signing-document_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "document_type": "document",
  "template_type": "template_type_example",
  "template_id": "template_id_example",
  "source": "document",
  "title": "title_example",
  "company": "Example Corp",
  "external_id": "external_id_example",
  "signing_status": "pending",
  "completed_at": "2024-01-15",
  "signing_order": "parallel",
  "allow_dictate_next_signer": false,
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "distribution_method": "email",
  "email_subject": "user@example.com",
  "email_message": "user@example.com",
  "redirect_url": "redirect_url_example",
  "timezone": "Etc/UTC",
  "date_format": "yyyy-MM-dd hh:mm a",
  "language": "en",
  "expires_at": "2024-01-15",
  "reminder_settings": "reminder_settings_example",
  "auth_options": "auth_options_example",
  "form_values": "form_values_example",
  "visibility": "everyone",
  "public_title": "public_title_example",
  "public_description": "public_description_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

PATCH /api/signing/signing-document/{id}

Update a signing document

Updates the specified signing document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the signing document to update.

Body parameters

status string

Default: draft

document_type string

Default: document

template_type string

template_id string

source string

Default: document

title string

company string

external_id string

signing_status string

Default: pending

completed_at string

signing_order string

Default: parallel

allow_dictate_next_signer boolean

Default: false

typed_signature_enabled boolean

Default: true

draw_signature_enabled boolean

Default: true

upload_signature_enabled boolean

Default: true

distribution_method string

Default: email

email_subject string

email_message string

redirect_url string

timezone string

Default: Etc/UTC

date_format string

Default: yyyy-MM-dd hh:mm a

language string

Default: en

expires_at string

reminder_settings string

auth_options string

form_values string

visibility string

Default: everyone

public_title string

public_description string

reference_doctype string

reference_name string

party_type string

party_name string

Returns

Returns the updated signing document object.

PATCH /api/signing/signing-document/{id}

curl https://api.overplane.dev/api/signing/signing-document/signing-document_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","document_type":"document"}'

Response

{
  "id": "signing-document_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "document_type": "document",
  "template_type": "template_type_example",
  "template_id": "template_id_example",
  "source": "document",
  "title": "title_example",
  "company": "Example Corp",
  "external_id": "external_id_example",
  "signing_status": "pending",
  "completed_at": "2024-01-15",
  "signing_order": "parallel",
  "allow_dictate_next_signer": false,
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "distribution_method": "email",
  "email_subject": "user@example.com",
  "email_message": "user@example.com",
  "redirect_url": "redirect_url_example",
  "timezone": "Etc/UTC",
  "date_format": "yyyy-MM-dd hh:mm a",
  "language": "en",
  "expires_at": "2024-01-15",
  "reminder_settings": "reminder_settings_example",
  "auth_options": "auth_options_example",
  "form_values": "form_values_example",
  "visibility": "everyone",
  "public_title": "public_title_example",
  "public_description": "public_description_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

DELETE /api/signing/signing-document/{id}

Delete a signing document

Permanently deletes a signing document. This cannot be undone.

Path parameters

id string required

The identifier of the signing document to delete.

Returns

Returns a confirmation that the signing document has been deleted.

DELETE /api/signing/signing-document/{id}

curl https://api.overplane.dev/api/signing/signing-document/signing-document_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "signing-document_abc123",
  "deleted": true
}

POST /api/signing/signing-document/{id}/submit

Submit a signing document

Submits a draft signing document, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the signing document to act on.

Returns

Returns the signing document object with updated status.

POST /api/signing/signing-document/{id}/submit

curl https://api.overplane.dev/api/signing/signing-document/signing-document_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "signing-document_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "document_type": "document",
  "template_type": "template_type_example",
  "template_id": "template_id_example",
  "source": "document",
  "title": "title_example",
  "company": "Example Corp",
  "external_id": "external_id_example",
  "signing_status": "pending",
  "completed_at": "2024-01-15",
  "signing_order": "parallel",
  "allow_dictate_next_signer": false,
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "distribution_method": "email",
  "email_subject": "user@example.com",
  "email_message": "user@example.com",
  "redirect_url": "redirect_url_example",
  "timezone": "Etc/UTC",
  "date_format": "yyyy-MM-dd hh:mm a",
  "language": "en",
  "expires_at": "2024-01-15",
  "reminder_settings": "reminder_settings_example",
  "auth_options": "auth_options_example",
  "form_values": "form_values_example",
  "visibility": "everyone",
  "public_title": "public_title_example",
  "public_description": "public_description_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

POST /api/signing/signing-document/{id}/cancel

Cancel a signing document

Cancels a submitted signing document, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the signing document to act on.

Returns

Returns the signing document object with updated status.

POST /api/signing/signing-document/{id}/cancel

curl https://api.overplane.dev/api/signing/signing-document/signing-document_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "signing-document_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "document_type": "document",
  "template_type": "template_type_example",
  "template_id": "template_id_example",
  "source": "document",
  "title": "title_example",
  "company": "Example Corp",
  "external_id": "external_id_example",
  "signing_status": "pending",
  "completed_at": "2024-01-15",
  "signing_order": "parallel",
  "allow_dictate_next_signer": false,
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "distribution_method": "email",
  "email_subject": "user@example.com",
  "email_message": "user@example.com",
  "redirect_url": "redirect_url_example",
  "timezone": "Etc/UTC",
  "date_format": "yyyy-MM-dd hh:mm a",
  "language": "en",
  "expires_at": "2024-01-15",
  "reminder_settings": "reminder_settings_example",
  "auth_options": "auth_options_example",
  "form_values": "form_values_example",
  "visibility": "everyone",
  "public_title": "public_title_example",
  "public_description": "public_description_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

Line items

Child objects that belong to this signing document. These are accessed via the parent's ID.

Signing Field

Attributes

idx integer

signing_document_id string required

signing_document_data_id string

signing_recipient_id string required

field_type string required

page integer

position_x number

position_y number

width number

height number

required boolean

inserted boolean

custom_text string

field_meta string

Endpoints

GET /api/signing/signing-field?parent_id={id}

POST /api/signing/signing-field

PATCH /api/signing/signing-field/{id}

DELETE /api/signing/signing-field/{id}

POST /api/signing/signing-field/reorder

Signing Field object

{
  "id": "signing-field_abc123",
  "idx": 1,
  "signing_document_id": "signing_document_id_example",
  "signing_document_data_id": "signing_document_data_id_example",
  "signing_recipient_id": "signing_recipient_id_example",
  "field_type": "field_type_example",
  "page": 1,
  "position_x": 0,
  "position_y": 0,
  "width": -1,
  "height": -1,
  "required": true,
  "inserted": false,
  "custom_text": "custom_text_example",
  "field_meta": "field_meta_example"
}

Signing Recipient

Attributes

idx integer

signing_document_id string required

email string required

name string required

token string

role string

read_status string

send_status string

signing_status string

signing_order integer

sent_at string

signed_at string

expires_at string

expiration_notified_at string

last_reminder_sent_at string

next_reminder_at string

rejection_reason string

auth_options string

contact_id string

party_type string

party_name string

Endpoints

GET /api/signing/signing-recipient?parent_id={id}

POST /api/signing/signing-recipient

PATCH /api/signing/signing-recipient/{id}

DELETE /api/signing/signing-recipient/{id}

POST /api/signing/signing-recipient/reorder

Signing Recipient object

{
  "id": "signing-recipient_abc123",
  "idx": 1,
  "signing_document_id": "signing_document_id_example",
  "email": "user@example.com",
  "name": "name_example",
  "token": "token_example",
  "role": "signer",
  "read_status": "not_opened",
  "send_status": "not_sent",
  "signing_status": "not_signed",
  "signing_order": 0,
  "sent_at": "2024-01-15",
  "signed_at": "2024-01-15",
  "expires_at": "2024-01-15",
  "expiration_notified_at": "2024-01-15",
  "last_reminder_sent_at": "2024-01-15",
  "next_reminder_at": "2024-01-15",
  "rejection_reason": "rejection_reason_example",
  "auth_options": "auth_options_example",
  "contact_id": "contact_id_example",
  "party_type": "party_type_example",
  "party_name": "party_name_example"
}

The Signing Document object

Attributes

Retrieve a signing document

Path parameters

Returns

List all signing documents

Query parameters

Returns

Create a signing document

Body parameters

Returns

Update a signing document

Path parameters

Body parameters

Returns

Delete a signing document

Path parameters

Returns

Submit a signing document

Path parameters

Returns

Cancel a signing document

Path parameters

Returns

Line items

Signing Field

Attributes

Endpoints

Signing Recipient

Attributes

Endpoints

Coming Soon