API Category

Documents

Documents APIs generate time-bound access links and download flows for stored source documents.

Business Use Case

Use these endpoints when reviewer workflows or external systems need secure temporary access to original uploaded files.

When To Use

You need short-lived signed URLs for secure access.
You need browser-friendly redirect download flows.
You need control over link expiry windows.

Endpoint Directory

GETGet document access URL

/api/v1/documents/{document_id}/access

GETDownload document (redirect)

/api/v1/documents/{document_id}/download

Endpoint Details

GET

Get document access URL

Generate a time-limited SAS URL to download or view a document. Requires API key authentication.

Documents

Endpoint URL

https://api.neudociq.com/api/v1/documents/{document_id}/access

Overview

Generate a time-limited SAS URL to download or view a document. Requires API key authentication.

Purpose

Get document access URL

Use Case

This endpoint is read-only and should be safe to call repeatedly for the same resource identifier.

Authentication

APIKeyHeader: API key in header (X-API-Key).

Header Example

http

X-API-Key: ndq_test_api_key

Headers

No parameters.

Query Parameters

Name	Type	Required	Description	Example
expiry_hours	integer	Optional	Number of hours the access URL should be valid (1-24 hours)	-

Path Parameters

Name	Type	Required	Description	Example
document_id	string	Required	Document ID from upload or parse endpoint	-

Request Fields

No request body fields are defined for this endpoint.

Request Default

Copy-ready examples with real endpoint paths and authentication placeholders.

javascript

const url = "https://api.neudociq.com/api/v1/documents/{document_id}/access";
const response = await fetch(url, {
  method: 'GET',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
  },
});

const data = await response.json();
console.log(data);

Best Practices

Validate required fields client-side before sending requests.
Log request identifiers and HTTP status codes for supportability.
Retry only when the operation is safe or your workflow is idempotent.

GET

Download document (redirect)

Redirect to a time-limited SAS URL for downloading the document. Opens directly in browser.

Documents

Endpoint URL

https://api.neudociq.com/api/v1/documents/{document_id}/download

Overview

Redirect to a time-limited SAS URL for downloading the document. Opens directly in browser.

Purpose

Download document (redirect)

Use Case

This endpoint is read-only and should be safe to call repeatedly for the same resource identifier.

Authentication

APIKeyHeader: API key in header (X-API-Key).

Header Example

http

X-API-Key: ndq_test_api_key

Headers

No parameters.

Query Parameters

Name	Type	Required	Description	Example
expiry_hours	integer	Optional	Number of hours the download URL should be valid (1-24 hours)	-

Path Parameters

Name	Type	Required	Description	Example
document_id	string	Required	Document ID from upload or parse endpoint	-

Request Fields

No request body fields are defined for this endpoint.

Request Default

Copy-ready examples with real endpoint paths and authentication placeholders.

javascript

const url = "https://api.neudociq.com/api/v1/documents/{document_id}/download";
const response = await fetch(url, {
  method: 'GET',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
  },
});

const data = await response.json();
console.log(data);

Best Practices

Validate required fields client-side before sending requests.
Log request identifiers and HTTP status codes for supportability.
Retry only when the operation is safe or your workflow is idempotent.