v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Electronic Seal

Create an Electronic Seal

Create a new Electronic Seal

post/electronic_seals

Request body

document_idstring uuid required

Specify which Electronic Seal Document to use for creating an Electronic Seal.

image_idstring uuid nullable

Specify which Electronic Seal Image to use for creating an Electronic Seal.

external_idstring nullable

Store a custom id that will be added to webhooks

signature_level'electronic_signature' | 'advanced_electronic_signature' nullable

Level of Electronic Seal for your Document

certificate_idstring uuid nullable

Specify which certificate to use for creating an Electronic Seal (only available for advanced_electronic_signature level).

Example request

{
  "document_id": "160473f9-156f-4583-848c-cbc3dec49b4a",
  "image_id": "333fa90a-a629-4708-8fe9-160dcb055a9b",
  "external_id": "externalId-123",
  "fields": [
    {
      "type": "seal",
      "height": 200,
      "width": 250,
      "page": 1
    }
  ],
  "certificate_id": "a3d84df7-b45e-4321-ae9e-7f5397acb225"
}

Response

Created

idstring uuid required

Unique identifier of the Electronic Seal.

status'pending' | 'done' | 'error' required

Status of the Electronic Seal.

signature_level'electronic_signature' | 'advanced_electronic_signature' | 'qualified_electronic_signature' required

Electronic seal level used for of the Electronic Seal.

created_atstring date-time required

Electronic Seal creation date and time.

external_idstring required

Custom identifier added to webhook.

timestampboolean required

Boolean indicating whether this Electronic Seal contains a qualified timestamp. For Advanced and Qualified Electronic Seal level, the value will be set to true. For Simple Electronic Seal level, the value will be set to false.

document_idstring uuid required

Unique identifier of the Document.

image_idstring uuid required

Unique identifier of the Image added to the Electronic Seal.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "signature_level": "electronic_signature",
  "created_at": "2024-01-18T22:59:00Z",
  "external_id": "ref#1234",
  "timestamp": true,
  "document_id": "550e7502-e29b-41d4-a716-446655440098",
  "image_id": "e15892b0-3d7e-4142-83c7-517082c8a85d"
}