Get documents

AI Tools

Once signed, a full copy of the completed document can be obtained in a zip file by calling the 'completed document' endpoint. This will include the files uploaded, a coversheet and a XML signature for a fully signed envelope.

Sandbox: GET https://demo.api.yotisign.com/v2/envelopes/<envelopeId>/completed-documents
Production: GET https://api.yotisign.com/v2/envelopes/<envelopeId>/completed-documents

Where envelopeID is the ID generated when creating the envelope request. this will be in the response body of the create envelope request.

Header explained

The following elements are needed:

Headers

Content

Content-Type

application/json

Authorization

API Key to call the Yoti Sign API. This should be sent as a bearer token.

Example code

const rp = require("request-promise"); const fs = require("fs"); const getDocuments = () => { const documents = { method: "GET", uri: "<BASE_URL>/v2/envelopes/<envelopeId>/completed-documents", headers: { authorization: "Bearer <API_KEY>", }, encoding: null, }; return rp(documents) .then((body) => fs.writeFileSync("example.zip", body)) .catch((err) => err); }; //send request let results = await getDocuments();
package com.yoti.sign; import java.io.IOException; import java.net.URI; import org.apache.http.HttpResponse; import org.apache.http.client.methods.HttpGet; import org.apache.http.impl.client.CloseableHttpClient; import org.apache.http.impl.client.HttpClients; public class MainGetDocument { private static final String YOTI_SIGN_AUTH_TOKEN = "<YOUR_AUTH_TOKEN>"; private static final String YOTI_SIGN_BASE_URL = "https://api.yotisign.com/v2"; public static void main(String[] args) { CloseableHttpClient client = HttpClients.createDefault(); final String envelopeId = "<YOUR_ENVELOPE_ID>"; HttpGet httpGet = new HttpGet(); httpGet.setHeader("Authorization", "Bearer " + YOTI_SIGN_AUTH_TOKEN); URI uri = URI.create(YOTI_SIGN_BASE_URL + "/envelopes/" + envelopeId + "/completed-documents"); httpGet.setURI(uri); try { HttpResponse response = client.execute(httpGet); InputStream fileContents = response.getEntity().getContent(); } catch (IOException e) { e.printStackTrace(); } } }
<?php use GuzzleHttp\Client; use GuzzleHttp\Psr7\Request; $request = new Request( 'GET', API_BASE_URL . "/envelopes/{$envelope_id}/completed-documents", [ 'Authorization' => 'Bearer ' . YOUR_API_KEY, ] ); $client = new Client(); $response = $client->send($request); $zip_file = $response->getBody();
req, err := http.NewRequest("GET", "<BASE_URL>/v2/envelopes/<envelopeId>/completed-documents", nil) req.Header.Add("Authorization", "Bearer <API_KEY>") client := &http.Client{} response, err := client.Do(req) if err != nil { fmt.Println(err) } else { file,err := os.Create("example.zip") defer file.Close() io.Copy(file,response.Body) }

If your GET request is successful, you will receive a zip file with the documents inside.

Good to know
You will need to wait for all recipients to sign the documents before you can make this request

Error codes

Error Code

Description

400

Bad Request or invalid payload

401

Unauthorised request, example: invalid API key

403

Forbidden, requesting user did not create the envelope

404

The envelope ID couldn’t be found


Next to read:
Get envelope

Got a question? Contact us here.

On This Page
Get documentsHeader explainedExample codeError codes