=========== API methods =========== .. hint:: All api requests will be send to: https://api.platform_address_here Authorization endpoints ======================= .. list-table:: :widths: 10 40 50 :header-rows: 1 * - Method - URL - Description * - POST - ``api/login`` - `Authorization `__ Template endpoints ================== .. list-table:: :widths: 10 40 50 :header-rows: 1 * - Method - URL - Description * - POST - ``/api/v1/template`` - `Create template `__ Envelope endpoints ================== .. list-table:: :widths: 10 40 50 :header-rows: 1 * - 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 ===================== .. list-table:: :widths: 10 40 50 :header-rows: 1 * - 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 ================= .. list-table:: :widths: 10 40 50 :header-rows: 1 * - Method - URL - Description * - GET - ``/api/v1/mailbox/search`` - `Search mailbox `__ * - GET - ``/api/v1/mailbox/{uuid}`` - `Check envelope status `__ Account endpoints ================= .. list-table:: :widths: 10 40 50 :header-rows: 1 * - 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 ====================== .. list-table:: :widths: 10 40 50 :header-rows: 1 * - 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** .. toctree:: methods/authorization.rst methods/templateCreation.rst methods/envelopeFill.rst methods/envelopeSend.rst methods/uploadAttachment.rst methods/documentsForSign.rst methods/signDocument.rst methods/downloadEnvelopeZip.rst methods/auditTrailGetByEnvelope.rst methods/auditTrailEntryCreate.rst methods/auditTrailDownloadPdf.rst methods/searchMailbox.rst methods/checkEnvelopeStatus.rst methods/account/users.rst methods/account/domains.rst