API methods

Hint

All api requests will be send to: https://api.platform_address_here

Authorization endpoints

Method	URL	Description
POST	api/login	Authorization

Template endpoints

Method	URL	Description
POST	/api/v1/template	Create template

Envelope endpoints

Method	URL	Description
PUT	/api/v1/envelope/send	Fill envelope
POST	/api/v1/envelope/send	Send envelope
POST	/api/v1/envelope/attachment	Upload attachment or external documents
GET	/api/v1/envelope/{envelopeUuid}/for-sign	Get document(s) for sign
GET	/api/v1/envelope/{envelopeUuid}/sign	Sign document(s) in envelope
GET	/api/v1/envelope/{envelopeUuid}/zip	Download documents
POST	/api/v1/envelope/{envelopeUuid}/for-print	Get document for print. Document should be completed.

Audit trail endpoints

Method	URL	Description
PUT	/api/v1/audittrail/envelope/{uuid}	Create audit trail record
GET	/api/v1/audittrail/envelope/{uuid}	Get envelope audit trail
GET	/api/v1/audittrail/pdf/{uuid}	Export envelope audit trail PDF file

Mailbox endpoints

Method	URL	Description
GET	/api/v1/mailbox/search	Search mailbox
GET	/api/v1/mailbox/{uuid}	Check envelope status

Account endpoints

Method	URL	Description
POST	/api/v1/account/{accountUuid}/domain	Add new account domain
PATCH	/api/v1/account/{accountUuid}/domain/{domainUuid}/verify	Verify domain
PATCH	/api/v1/account/{accountUuid}/domain/{domainUuid}/confirm	Confirm domain verification
PATCH	/api/v1/account/{accountUuid}/domain/{domainUuid}/activate	Activate domain
PATCH	/api/v1/account/{accountUuid}/domain/{domainUuid}/deactivate	Deactivate domain
PATCH	/api/v1/account/{accountUuid}/domain/{domainUuid}/check	Check domain
DELETE	/api/v1/account/{accountUuid}/domain/{domainUuid}	Delete domain
GET	/api/v1/account/{accountUuid}/domain	Search domains
GET	/api/v1/account/{accountUuid}/users/example	Get example file
POST	/api/v1/account/{accountUuid}/users	Mass create users

User/Profile endpoints

Method	URL	Description
POST	/api/v1/account/{accountUuid}/user	Create new corporate user in domain which has to be verified and activated.
DELETE	/api/v1/account/{accountUuid}/user	Account admin can delete many corporate users at once. In case of exception, no user will be deleted.

Content list

• Authorization
• Template creation
• Fill envelope
  • sendEnvelopeDTO
• Send envelope
  • sendEnvelopeDto
• Upload attachment or external documents
• Get document(s) for sign
  • Request
  • Response
• 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