Guide · Developer API

Connect to the ProofRows API

Use the API to upload statements, monitor extraction, read reviewed transactions, and download exports. Workspace owners and admins can create credentials in Settings.

Protect workspace data. API keys grant access to every client and statement in their workspace. Store keys like passwords, never place them in browser code, and revoke a key immediately if it is exposed.

Authentication

The base URL for this deployment is:

https://proofrows.com/api/v1

Send the token in the Authorization header on every request:

Authorization: Bearer lc_live_<prefix>_<secret>

A new token is shown once. Copy it before leaving Settings.

Endpoints

Method	Path	Description
`GET`	`/clients`	List clients in the key's workspace
`POST`	`/statements`	Upload a PDF, PNG, JPEG, or WebP statement
`GET`	`/statements/:id`	Read statement status and processing progress
`GET`	`/statements/:id/transactions`	List extracted transactions
`POST`	`/statements/:id/export`	Build and download an export file

Transaction lists accept limit and offset. Uploads use multipart form data with clientId and file; files can be up to 25 MB.

Export formats

Send a JSON body such as { "format": "csv" }. Supported values are csv, qbo-csv, xero, xlsx, ofx, qbo, and json.

Request example

curl -H "Authorization: Bearer $PROOFROWS_TOKEN" \
+  "https://proofrows.com/api/v1/clients"

Webhooks

Add an HTTPS endpoint in Settings and choose one or more events: statement.ready, statement.failed, or export.completed.

Verify the X-ProofRows-Signature header by computing an HMAC-SHA256 hex digest of the raw request body with the signing secret. Read the event name from X-ProofRows-Event. Reject the request if the signature does not match.

Limits and errors

Requests are rate-limited. A 429 response includes a Retry-After header.
Uploads and exports use the API key creator’s plan and page allowance.
Error responses are JSON with a stable error code and, when useful, a message.
Need help? Contact support.