Skip to main content
POST
Validate Document Api

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenant
string | null
required

The domain of the customer

Example:

"example.com"

Body

application/json
document_id
string
required

The document ID of the files

rules
(StoredRuleRef · object | RegexRule · object | BlacklistRule · object | LlmRule · object)[]
required

Validation rules to execute against the selected attachments.

Minimum array length: 1
llm_provider
enum<string> | null

The LLM provider to use. If not provided, the default provider will be used.

Available options:
OpenAI,
Google,
Altirnao,
MistralAI,
Anthropic
llm_model_prefix
string | null

The prefix of the LLM model name to use. If not provided, the default model will be used.

Example:

"gemini-2.5-pro"

attachment_filters
AttachmentFilter · object[] | null

Optional attachment filters. If omitted, all attachments are validated.

whitelist
string[] | null

Values that should be ignored even if one of the rules detects them.

Response

Successful Response

document_id
string
required

The validated document ID.

passed
boolean
required

Whether the document passed validation after whitelist suppression.

violations
ValidationViolation · object[]
required

Flat list of detected violations.