API Category

Document Retrieval

Document Retrieval APIs provide filtered search, pagination, extraction edits, and statistics across processed documents.

Business Use Case

Use retrieval APIs to power internal dashboards, review queues, and data operations portals with real-time extraction visibility.

When To Use

You need filtered document querying by client/type/status/date.
You need programmatic edits and human review workflows.
You need aggregate reporting for operational monitoring.

Endpoint Directory

GETQuery extracted documents

/api/v1/extracted-data

GETGet document by ID

/api/v1/extracted-data/{document_id}

PATCHEdit extraction fields

/api/v1/extracted-data/{document_id}

GETGet documents by batch ID

/api/v1/extracted-data/batch/{batch_id}

GETGet document statistics

/api/v1/extracted-data/stats

Endpoint Details

GET

Query extracted documents

Retrieve extracted documents with flexible filtering, pagination, and sorting. Requires API key authentication.

Document Retrieval

Endpoint URL

https://api.neudociq.com/api/v1/extracted-data

Overview

Retrieve extracted documents with flexible filtering, pagination, and sorting. Requires API key authentication.

Purpose

Query extracted documents

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
client_id	string	Required	Client ID to filter documents	-
document_type	string	Optional	Document type filter (e.g., 'dent_form_d')	-
schema_id	string	Optional	Filter by schema ID (returns only matching extraction)	-
upload_batch_id	string	Optional	Filter by upload batch ID	-
status	string	Optional	Filter by processing status (queued, processing, completed, failed)	-
from_date	string	Optional	Filter documents created after this date (ISO format)	-
to_date	string	Optional	Filter documents created before this date (ISO format)	-
limit	integer	Optional	Number of results to return (max 500)	-
skip	integer	Optional	Number of results to skip for pagination	-
sort_by	string	Optional	Field to sort by	-
sort_order	string	Optional	Sort direction: 'asc' or 'desc'	-
include_fields	string	Optional	Comma-separated fields to include in response	-
exclude_fields	string	Optional	Comma-separated fields to exclude from response	-

Path Parameters

No parameters.

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/extracted-data";
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

Get document by ID

Retrieve a single document by its unique ID. Optionally filter by schema_id to get specific extraction. Requires API key authentication.

Document Retrieval

Endpoint URL

https://api.neudociq.com/api/v1/extracted-data/{document_id}

Overview

Retrieve a single document by its unique ID. Optionally filter by schema_id to get specific extraction. Requires API key authentication.

Purpose

Get document by ID

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
schema_id	string	Optional	Filter by schema ID (returns only matching extraction)	-

Path Parameters

Name	Type	Required	Description	Example
document_id	string	Required	-	-

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/extracted-data/{document_id}";
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.

PATCH

Edit extraction fields

Merge-patch one extraction's result and/or _normalized fields. Only the keys you supply are updated; everything else is preserved. Stamps the extraction as human_reviewed=true with a reviewed_at timestamp. Requires API key authentication.

Document Retrieval

Endpoint URL

https://api.neudociq.com/api/v1/extracted-data/{document_id}

Overview

Purpose

Edit extraction fields

Use Case

Use this endpoint as part of your document processing workflow where the operation path is required.

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
schema_id	string	Required	Schema ID identifying which extraction to edit	-

Path Parameters

Name	Type	Required	Description	Example
document_id	string	Required	-	-

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/extracted-data/{document_id}";
const response = await fetch(url, {
  method: 'PATCH',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "result": {},
  "_normalized": {},
  "edited_by": "string_value"
}),
});

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

Get documents by batch ID

Retrieve all documents from a specific upload batch. Requires API key authentication.

Document Retrieval

Endpoint URL

https://api.neudociq.com/api/v1/extracted-data/batch/{batch_id}

Overview

Retrieve all documents from a specific upload batch. Requires API key authentication.

Purpose

Get documents by batch ID

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
client_id	string	Required	Client ID for authorization	-

Path Parameters

Name	Type	Required	Description	Example
batch_id	string	Required	-	-

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/extracted-data/batch/{batch_id}";
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.
Poll status endpoints with backoff and stop polling once the batch reaches a terminal state.

GET

Get document statistics

Get statistical overview of documents for a client. Requires API key authentication.

Document Retrieval

Endpoint URL

https://api.neudociq.com/api/v1/extracted-data/stats

Overview

Get statistical overview of documents for a client. Requires API key authentication.

Purpose

Get document statistics

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
client_id	string	Required	Client ID to get statistics for	-

Path Parameters

No parameters.

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/extracted-data/stats";
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.