API Reference

Integrate True Record's duplicate detection into your workflows via REST API.

Base URL

https://truerecord.app/api/v1

All API requests require a Bearer token. Create an API key from your dashboard settings.

Authorization Header Format

Authorization: Bearer tr_xxxxxxxxxxxxxxxx

API keys are scoped to specific permissions. Select only the scopes you need.

Scope	Description
`scans:read`	View scan status and history
`scans:write`	Trigger new duplicate scans
`matches:read`	View duplicate matches
`matches:merge`	Execute merge operations
`matches:dismiss`	Dismiss duplicate matches
`import:read`	View import jobs and rows
`import:write`	Upload files and execute imports
`org:read`	View organization info and usage statistics
`*`	Full API access (all permissions)

GET/org/status

Returns organization info, connection status, and usage statistics.

Scope: org:read

POST/scan/start

Triggers a new duplicate scan for the specified object.

Scope: scans:write

GET/scan/status/:scanId

Returns the status and results of a scan.

Scope: scans:read

GET/matches

Returns duplicate matches with optional filters.

Scope: matches:read

POST/matches/:matchId/merge

Executes a merge operation for the specified match.

Scope: matches:merge

POST/matches/:matchId/dismiss

Dismisses a match as not a duplicate.

Scope: matches:dismiss

Rate limits vary by plan:

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

All errors follow a consistent format:

400Bad Request - Invalid parameters

401Unauthorized - Invalid or missing API key

403Forbidden - Insufficient scopes

404Not Found - Resource doesn't exist

429Too Many Requests - Rate limit exceeded

500Internal Server Error

Additional Resources