API

Full API documentation (Redoc)

Full API documentation (Swagger)

Content list

• API methods
  • Authorization endpoints
  • Template endpoints
  • Envelope endpoints
  • Audit trail endpoints
  • Mailbox endpoints
  • Account endpoints
  • User/Profile endpoints
    • Authorization
    • Template creation
    • Fill envelope
      • sendEnvelope
    • Send envelope
      • sendEnvelopeDto
    • Upload attachment or external documents
    • Get document(s) for sign
      • Request details
      • Response details
    • Sign document(s) with QES
      • Request
      • Request structure example
      • Response
    • Download envelope documents archive
      • Query parameters for ZIP contents configuration
      • ZIP content depending on the document state
    • Get envelope audit trail
    • Create audit trail record
    • Export envelope audit trail PDF file
    • Search mailbox
    • Check envelope status
    • Account corporate users
      • Download example file
      • Mass create users
    • Account domains
      • Add account domain
      • Verify account domain
      • Confirm account domain verification
      • Activate account domain
      • Deactivate account domain
      • Check account domain
      • Delete account domain
      • Search account domains
      • Domain statuses
      • Domain verify methods
• Common API error codes
• Template structure
  • Template Static Elements
  • Template dynamic fields
  • PDF fields on template
• Envelope Structure
  • How to fill each single field
• Dictionary
  • Import Dictionary