Platform Endpoints

This document contains a categorized list of platform API endpoints, including the base URL and common authorization, template, envelope, and account routes.

circle-info

Read Swagger UIarrow-up-right to inspect endpoints and test requests.

Authorization endpoints

Method
URL
Description

POST

api/login

Template endpoints

Method
URL
Description

POST

/api/v1/template

Envelope endpoints

Method
URL
Description

PUT

/api/v1/envelope/send

POST

/api/v1/envelope/send

POST

/api/v1/envelope/attachment

GET

/api/v1/envelope/{envelopeUuid}/for-sign

GET

/api/v1/envelope/{envelopeUuid}/zip

POST

/api/v1/envelope/{envelopeUuid}/for-print

To fill envelope you should provide data to field which assigned to him by request below.

Method
PUT

URL

/api/v1/envelope/mailbox/{uuid}/{action}

Authorization

Bearer {token}

content-type

application/json

Body

“{“”data””: “”string””}”

Audit trail endpoints

Method
URL
Description

PUT

/api/v1/audittrail/envelope/{uuid}

GET

/api/v1/audittrail/envelope/{uuid}

GET

/api/v1/audittrail/pdf/{uuid}

Mailbox endpoints

Method
URL
Description

GET

/api/v1/mailbox/search

GET

/api/v1/mailbox/{uuid}

Account endpoints

Method
URL
Description

POST

/api/v1/account/{accountUuid}/domain

PATCH

/api/v1/account/{accountUuid}/domain/{domainUuid}/verify

PATCH

/api/v1/account/{accountUuid}/domain/{domainUuid}/confirm

PATCH

/api/v1/account/{accountUuid}/domain/{domainUuid}/activate

PATCH

/api/v1/account/{accountUuid}/domain/{domainUuid}/deactivate

PATCH

/api/v1/account/{accountUuid}/domain/{domainUuid}/check

DELETE

/api/v1/account/{accountUuid}/domain/{domainUuid}

GET

/api/v1/account/{accountUuid}/domain

GET

/api/v1/account/{accountUuid}/users/example

POST

/api/v1/account/{accountUuid}/users

User/Profile endpoints

Last updated