Validate Document

Submit a document for asynchronous validation

POST /api/validate_stream

Validate Document

cURL

curl --request POST \
  --url https://api.example.com/api/validate_stream/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_bytes": "<string>",
  "document_category": "<string>",
  "document_metadata": {
    "audience_hint": "<string>",
    "jurisdiction": "<string>",
    "product_class": "<string>",
    "document_type": "<string>",
    "product_types": [
      {}
    ]
  }
}
'

202 Accepted

{
  "job_id": "abc123def456",
  "status": "accepted",
  "message": "Validation request queued for processing",
  "timestamp": "2026-01-08T10:30:00Z"
}

Submit a base64-encoded document for asynchronous compliance validation.

Request Body

document_bytes · string · required

Base64-encoded document content (PDF, DOCX, etc.)

document_category · string

Pre-defined category for the document. Required if document_metadata is not provided.

Options: retail_investor_letter, retail_fact_sheet_registered_fund, retail_fact_sheet_non_registered, pitch_book_registered_fund, pitch_book_non_registered, scenario_retail_investor_letter, scenario_retail_fact_sheet_registered_fund, scenario_retail_fact_sheet_non_registered, scenario_pitch_book_registered_fund, scenario_pitch_book_non_registered

document_metadata · object

Detailed metadata for precise rule matching. Required if document_category is not provided.

Show metadata properties

audience_hint · string · required

Target audience. Options: retail_US, retail_nonUS, institutional, accredited_investor, qualified_client_SEC, qualified_purchaser, professional_client_UK, eligible_counterparty, plan_participant_ERISA, plan_sponsor, intermediary_distributor, prospect, existing_client, former_client, HNW, UHNW, media_press, regulator_examiner, internal_only

jurisdiction · string · required

Regulatory jurisdiction: US

product_class · string · required

Product classification: registered_fund or non_registered

document_type · string · required

Document type: investor_letter, fact_sheet, pitch_book, presentation, email, website_copy, rfp_response, research_report, prospectus_extract, social_post, advisor_newsletter

product_types · array · required

Array of product types (e.g., ["Fund__mutual_fund"]). Common values include Fund__mutual_fund, Fund__etf, Fund__hedge_fund, Fund__private_equity_fund, Advisory_Account__sma, and many more.

At least one of document_category or document_metadata must be provided.

Response

job_id · string

Unique identifier for the validation job

status · string

Job status: accepted

message · string

Status message

timestamp · string

ISO 8601 timestamp

202 Accepted

{
  "job_id": "abc123def456",
  "status": "accepted",
  "message": "Validation request queued for processing",
  "timestamp": "2026-01-08T10:30:00Z"
}

Example

cURL

# Encode document to base64
DOC_BASE64=$(base64 -i document.pdf)

curl -X POST "https://{api-url}/api/validate_stream/" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"document_bytes\": \"$DOC_BASE64\",
    \"document_category\": \"retail_investor_letter\"
  }"