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

Retrieve a specific document analysis

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

Retrieves a detailed representation of a specific document analysis by its unique identifier.

This endpoint allows you to:

  • Fetch complete details of an individual analysis
  • Include related resources such as user, and attached document

The document analysis must belong to the authenticated customer or an error will be returned.

Required permissions:

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

Unique identifier of the document analysis to retrieve. Must be a valid UUID format.

Query Params
string
enum

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

Allowed:
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 6 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 6 months ago