Get a document
This will retrieve the document object. To download attachments, you should use the download attachment image endpoint.
Performing a get document request on a document with attachments will return details on the document and all its attachments.
get
https://api.complycube.com
/v1/documents/:id
Get a document
Retrieves an existing document.
Parameters
Path
id*
string
The ID of the document.
Header
Authorization*
string
The live or sandbox API key.
Responses
200
Document, with an attachment, successfully retrieved.
404
Could not find a document matching provided id.
cURL
Node.js
Python
PHP
.NET
curl -X GET https://api.complycube.com/v1/documents/{:documentId} \
-H 'Authorization: <YOUR_API_KEY>'
const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const document = await complycube.document.get("DOCUMENT_ID");
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
document = cc_api.documents.get('DOCUMENT_ID')
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$document = $ccapi->documents()->get('DOCUMENT_ID');
using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;
var docApi = new DocumentApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var document = await docApi.GetAsync("DOCUMENT_ID");
Last modified 5mo ago