Get Document

curl --request GET \
  --url https://api.hopnow.io/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}"

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/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}', 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/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}",
  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/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}")

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

{
  "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",
  "rejection_reason": null,
  "created": "2026-06-12T09:30:00Z",
  "updated": "2026-06-12T10:05:00Z",
  "created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
  "updated_by": null
}

GET

customers

{customer_id}

accounts

{account_id}

documents

{document_id}

Get Document

curl --request GET \
  --url https://api.hopnow.io/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}"

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/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}', 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/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}",
  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/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/va/v1/customers/{customer_id}/accounts/{account_id}/documents/{document_id}")

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

{
  "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",
  "rejection_reason": null,
  "created": "2026-06-12T09:30:00Z",
  "updated": "2026-06-12T10:05:00Z",
  "created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
  "updated_by": null
}

Fetches a single document’s metadata and review state by id. The document must belong to the given account, otherwise the request fails with 404. File contents are not returned. There is no request body.

Path Parameters

string

required

Id of the Platform customer.

string

required

Id of the account.

string

required

Id of the document (e.g. doc_…).

Response

Returns 200 with the document object.

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 stored file (e.g. application/pdf).

int

Size of the raw file in bytes.

enum

One of staged (accepted, queued for the next submission), submitted (sent for verification review), rejected (the verification provider could not process the file — see rejection_reason; it no longer counts toward its requirement), or replaced (a newer upload for the same requirement superseded this staged file).

string | null

Verification-provider rejection detail (e.g. unreadable_document); set only when status is rejected.

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.

{
  "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",
  "rejection_reason": null,
  "created": "2026-06-12T09:30:00Z",
  "updated": "2026-06-12T10:05:00Z",
  "created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
  "updated_by": null
}

Getting Started

Integration Flows

Webhooks

Endpoints

Get Document

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response