Get document(s) for sign

Customer can sign document if document has signature field inside assigned to the particular customer. Using this endpoint customer can get the list of the documents to sign.

To get documents list for sign customer should send the following api request.

Request

URL

Method

POST

Request URL

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

envelopeUuid (required)

Envelope UUID - which you want to download

Headers

authorization (require)

Bearer “token” – token, which get after Authorization

Mailbox (require)

mailboxUuid: mailbox id

Content-Type

application/json

Body

docIds (required)

array of the documents ids (array[string])

Depends on body of the request customer can get two type of the response:

  1. Send request with empty array in body - get all documents from the envleope with signature related to particular customer

  2. Send request with particular documentID in body - get particular document for sign

In response we get an array with information about documents for sign.

Response

Status code: 200 OK

[
    {
        "documentId": "string",
        "pdf": "string",
        "pdfName": "string",
        "signatureName": "string",
        "xml": "string",
        "xmlName": "string"
    }
]

Description of the response data:

Response content

documentId

id of the particular document(s)

pdf

binary data of the document in fromat .pdf

pdfName

name of the file in format .pdf

signatureName

name of the signature field in the document

xml

structured document in format .xml

xmlName

name of the structured document