The Signing Document Data 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.

signing_document_id string required
title string
display_order integer

Default: 1

storage_type string

Default: r2

data string required
initial_data string
page_count integer
content_type string

Default: application/pdf

file_size integer
The Signing Document Data object 
{
  "id": "signing-document-data_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "title": "title_example",
  "display_order": 1,
  "storage_type": "r2",
  "data": "data_example",
  "initial_data": "initial_data_example",
  "page_count": 0,
  "content_type": "application/pdf",
  "file_size": 0
}
GET /api/signing/signing-document-data/{id}

Retrieve a signing document data

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

Path parameters

id string required

The identifier of the signing document data to retrieve.

Returns

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

GET /api/signing/signing-document-data/{id} 
curl https://api.overplane.dev/api/signing/signing-document-data/signing-document-data_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "signing-document-data_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "title": "title_example",
  "display_order": 1,
  "storage_type": "r2",
  "data": "data_example",
  "initial_data": "initial_data_example",
  "page_count": 0,
  "content_type": "application/pdf",
  "file_size": 0
}
GET /api/signing/signing-document-data

List all signing document datas

Returns a list of signing document datas. 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 data objects.

GET /api/signing/signing-document-data 
curl https://api.overplane.dev/api/signing/signing-document-data \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "signing-document-data_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "signing_document_id": "signing_document_id_example",
      "title": "title_example",
      "display_order": 1,
      "storage_type": "r2",
      "data": "data_example",
      "initial_data": "initial_data_example",
      "page_count": 0,
      "content_type": "application/pdf",
      "file_size": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/signing/signing-document-data

Create a signing document data

Creates a new signing document data object.

Body parameters

signing_document_id string required
title string
display_order integer

Default: 1

storage_type string

Default: r2

data string required
initial_data string
page_count integer
content_type string

Default: application/pdf

file_size integer

Returns

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

POST /api/signing/signing-document-data 
curl https://api.overplane.dev/api/signing/signing-document-data \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"signing_document_id":"signing_document_id_example","data":"data_example"}'
Response 
{
  "id": "signing-document-data_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "title": "title_example",
  "display_order": 1,
  "storage_type": "r2",
  "data": "data_example",
  "initial_data": "initial_data_example",
  "page_count": 0,
  "content_type": "application/pdf",
  "file_size": 0
}
PATCH /api/signing/signing-document-data/{id}

Update a signing document data

Updates the specified signing document data 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 data to update.

Body parameters

signing_document_id string
title string
display_order integer

Default: 1

storage_type string

Default: r2

data string
initial_data string
page_count integer
content_type string

Default: application/pdf

file_size integer

Returns

Returns the updated signing document data object.

PATCH /api/signing/signing-document-data/{id} 
curl https://api.overplane.dev/api/signing/signing-document-data/signing-document-data_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"signing_document_id":"signing_document_id_example","title":"title_example"}'
Response 
{
  "id": "signing-document-data_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "title": "title_example",
  "display_order": 1,
  "storage_type": "r2",
  "data": "data_example",
  "initial_data": "initial_data_example",
  "page_count": 0,
  "content_type": "application/pdf",
  "file_size": 0
}
DELETE /api/signing/signing-document-data/{id}

Delete a signing document data

Permanently deletes a signing document data. This cannot be undone.

Path parameters

id string required

The identifier of the signing document data to delete.

Returns

Returns a confirmation that the signing document data has been deleted.

DELETE /api/signing/signing-document-data/{id} 
curl https://api.overplane.dev/api/signing/signing-document-data/signing-document-data_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "signing-document-data_abc123",
  "deleted": true
}