The Signing Signature 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_field_id string required
signing_recipient_id string required
signature_type string required
signature_image string
typed_value string
value string
The Signing Signature object 
{
  "id": "signing-signature_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_field_id": "signing_field_id_example",
  "signing_recipient_id": "signing_recipient_id_example",
  "signature_type": "signature_type_example",
  "signature_image": "signature_image_example",
  "typed_value": "typed_value_example",
  "value": "value_example"
}
GET /api/signing/signing-signature/{id}

Retrieve a signing signature

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

Path parameters

id string required

The identifier of the signing signature to retrieve.

Returns

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

GET /api/signing/signing-signature/{id} 
curl https://api.overplane.dev/api/signing/signing-signature/signing-signature_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "signing-signature_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_field_id": "signing_field_id_example",
  "signing_recipient_id": "signing_recipient_id_example",
  "signature_type": "signature_type_example",
  "signature_image": "signature_image_example",
  "typed_value": "typed_value_example",
  "value": "value_example"
}
GET /api/signing/signing-signature

List all signing signatures

Returns a list of signing signatures. 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 signature objects.

GET /api/signing/signing-signature 
curl https://api.overplane.dev/api/signing/signing-signature \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "signing-signature_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "signing_field_id": "signing_field_id_example",
      "signing_recipient_id": "signing_recipient_id_example",
      "signature_type": "signature_type_example",
      "signature_image": "signature_image_example",
      "typed_value": "typed_value_example",
      "value": "value_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/signing/signing-signature

Create a signing signature

Creates a new signing signature object.

Body parameters

signing_field_id string required
signing_recipient_id string required
signature_type string required
signature_image string
typed_value string
value string

Returns

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

POST /api/signing/signing-signature 
curl https://api.overplane.dev/api/signing/signing-signature \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"signing_field_id":"signing_field_id_example","signing_recipient_id":"signing_recipient_id_example","signature_type":"signature_type_example"}'
Response 
{
  "id": "signing-signature_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_field_id": "signing_field_id_example",
  "signing_recipient_id": "signing_recipient_id_example",
  "signature_type": "signature_type_example",
  "signature_image": "signature_image_example",
  "typed_value": "typed_value_example",
  "value": "value_example"
}
PATCH /api/signing/signing-signature/{id}

Update a signing signature

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

Body parameters

signing_field_id string
signing_recipient_id string
signature_type string
signature_image string
typed_value string
value string

Returns

Returns the updated signing signature object.

PATCH /api/signing/signing-signature/{id} 
curl https://api.overplane.dev/api/signing/signing-signature/signing-signature_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"signing_field_id":"signing_field_id_example","signing_recipient_id":"signing_recipient_id_example"}'
Response 
{
  "id": "signing-signature_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_field_id": "signing_field_id_example",
  "signing_recipient_id": "signing_recipient_id_example",
  "signature_type": "signature_type_example",
  "signature_image": "signature_image_example",
  "typed_value": "typed_value_example",
  "value": "value_example"
}
DELETE /api/signing/signing-signature/{id}

Delete a signing signature

Permanently deletes a signing signature. This cannot be undone.

Path parameters

id string required

The identifier of the signing signature to delete.

Returns

Returns a confirmation that the signing signature has been deleted.

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