List Documents
curl --request GET \
--url https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"object": "document",
"id": "doc_5kqw8n2v4x7c1m9p3r6t0y2u",
"account_id": "acct_3mnq7c1e6a2b4f3c9b8d2e5a",
"requirement_key": "company.certificate_of_incorporation",
"type": "certificate_of_incorporation",
"file_name": "acme-coi.pdf",
"content_type": "application/pdf",
"size_bytes": 248811,
"status": "staged",
"created": "2026-06-12T09:30:00Z",
"updated": null,
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
Documents
List Documents
Returns a paginated list of entity documents on the account
GET
/
ads
/
v1
/
customers
/
{customer_id}
/
accounts
/
{account_id}
/
documents
List Documents
curl --request GET \
--url https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"object": "document",
"id": "doc_5kqw8n2v4x7c1m9p3r6t0y2u",
"account_id": "acct_3mnq7c1e6a2b4f3c9b8d2e5a",
"requirement_key": "company.certificate_of_incorporation",
"type": "certificate_of_incorporation",
"file_name": "acme-coi.pdf",
"content_type": "application/pdf",
"size_bytes": 248811,
"status": "staged",
"created": "2026-06-12T09:30:00Z",
"updated": null,
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
Returns a paginated list of entity documents on the account.
Path Parameters
string
required
Id of the Platform customer.
string
required
Id of the account.
Query Parameters
int
Page number, ≥ 1. Defaults to 1.
int
Items per page, 1–100. Defaults to 10.
Response
Returns200 with a paginated list of document objects. file contents are not returned.
array
The document objects on this page.
Show child attributes
Show child attributes
string
Always
"document".string
Id of the document (e.g.
doc_…).string
Id of the account the document belongs to.
string | null
Requirement key this document satisfies, if any.
enum
Account document type (e.g.
certificate_of_incorporation).string | null
Original file name, if provided.
string
MIME type of the uploaded file (e.g.
application/pdf).int
Size of the raw file in bytes.
enum
One of
staged, submitted.string
ISO 8601 timestamp when created.
string | null
ISO 8601 timestamp when last updated.
string
Id of the API key that created the document.
string | null
Id of the API key that last updated the document.
int
Current page number.
int
Items per page.
int
Total number of items.
int
Total number of pages.
{
"items": [
{
"object": "document",
"id": "doc_5kqw8n2v4x7c1m9p3r6t0y2u",
"account_id": "acct_3mnq7c1e6a2b4f3c9b8d2e5a",
"requirement_key": "company.certificate_of_incorporation",
"type": "certificate_of_incorporation",
"file_name": "acme-coi.pdf",
"content_type": "application/pdf",
"size_bytes": 248811,
"status": "staged",
"created": "2026-06-12T09:30:00Z",
"updated": null,
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
⌘I