Get document(s) for sign

You can sign document if document has signature field inside assigned to the particular customer. Using this endpoint you can get the list of the documents to sign. To get documents list for sign you should send the following api request:

Request

Method

POST

URL

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

Authorization

Bearer {token}

content-type

application/json

mailboxUuid

{uuid}

envelopeUuid

{uuid}

docIds

(array[string])

Depending 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:

documentId

id of the document

pdf

PDF binary data

pdfName

Name of the docuemnt

signatureName

Name of the signature field

xml

Document in .xml format

xmlName

Structured document name