API Reference
✉️ Developer newsletter🛝 Sandbox environment🎬 Production environment

Create document analysis

post
https://app-sandbox.trustpair.com/api/v1/company_account_checks//document_analyses/

Trigger document analysis.

Required permissions:

  • document_analysis_write
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the company account check for which to retrieve overrides. Must be a valid UUID format.

Query Params
string
enum

Comma-separated list of related resources to include in the response.

Including related resources reduces the need for additional API calls, but increases response time and payload size.

Allowed:
Body Params
string
required

Unique identifier of the document.

string
required

Unique identifier of the user.

Headers
string
enum

Specifies the preferred language for the response. Supported languages:

  • en - English
  • fr - French

If not provided, the default language will be used.

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago