Skip to main content

​
1. Sign up

Create your tenant account at dashboard.trueparser.com.
  • Authentication: TrueParser Dashboard uses Google Authentication to manage your account.
  • Initial State: New accounts start in a Pending Activation state. You will receive an automated email once your organization is active.

​
2. Create an App

To access the parsing engines, you need a security token. Tokens are issued to Applications through an OAuth 2 machine-to-machine flow. Create an app in the dashboard to generate your credentials.
1

Open the Apps section

Navigate to Apps in the dashboard sidebar and click Add Application.
2

Name your app

Identify the service connecting to TrueParser, for example my-document-parser.
3

Set the License Region

Choose the geographic region closest to your primary data region (e.g., aws-us-east-1).
4

Save your credentials

Immediately copy your Client ID and Client Secret. The secret is shown in plaintext only at this step.
To parse technical documents, your application requires the usage quota provided by a plan. While you can obtain a token without a plan, it will be rejected by the parsing engine as it lacks the required permissions. Select a plan from the Plans tab of your application.
Quota Activation. To enable parsing operations, you must select an available plan in the dashboard. This ensures your issued tokens contain the required usage quotas for your License Region.

​
4. Understand Document Units

TrueParser measures parsing consumption in Document Units. Depending on the parser family, one Document Unit may correspond to:
  • one page for PDF, Microsoft Office, and OpenDocument files
  • one email or message item for MailKit sources
  • one SQL statement for SQL sources
  • one logical dataset for GIS sources
  • one processed document for CAD sources
Your plan’s limits claim controls the Document Units your app can consume across the per-document, hourly, daily, weekly, and monthly quota windows.

​
5. Get an Access Token

Exchange your application credentials for a security token at the Identity Authority: 
curl -X POST https://admin-api.trueparser.com/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=TrueParser.API"

​
6. Ingest a Document

Submit a document for parsing. Some formats require additional routing parameters:
  • PDF requires pdfMode
  • SQL requires sqlDialect
  • CSV requires csvRoute
  • ZIP-based uploads should include an explicit documentType
curl -X POST https://api.trueparser.com/api/v1/documents/parse \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "file=@/path/to/document.pdf" \
  -F "documentType=Pdf" \
  -F "pdfMode=SingleColumn"
The API returns a 202 Accepted with a documentId for tracking.

​
7. Poll for Completion

TrueParser is an asynchronous platform. Before fetching results, poll the status endpoint until the job reaches completed. 
curl -X GET https://api.trueparser.com/api/v1/documents/YOUR_DOC_ID/status \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response: Wait for "status": "completed". Typical status values include queued, processing, completed, and failed. If the status is failed, inspect the returned payload for error details.

​
8. Retrieve Results

Once the status is confirmed as completed, download your structured JSON results from the Parsing API: 
curl -X GET https://api.trueparser.com/api/v1/documents/YOUR_DOC_ID/result \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Result Streaming. TrueParser streams the parsed JSON artifact directly through the /result endpoint. Clients do not fetch results from S3 or external storage directly.
If you call /result before processing is finished, the API can still return 202 Accepted with a processing status payload. Poll /status until the job is complete, then fetch /result.

Learn about Result Delivery

Understand how results are materialized and fetched from the API.
Last modified on April 1, 2026