API authentication

All keys are prefixed with ip_ followed by 64 random hex characters (256 bits of entropy). Only the first 10 characters are stored and shown in the dashboard for identification.

ip_a1b2c3d4e5f6...  ← full key (shown once at creation)
ip_a1b2c3d4e5  ← prefix shown in dashboard

Pass the full key in the Authorization header:

curl https://invoicesparser.com/api/v1/workspaces/{workspaceId}/invoices \
  -H "Authorization: Bearer ip_your_api_key_here"

In JavaScript / TypeScript:

const res = await fetch(
  `https://invoicesparser.com/api/v1/workspaces/${workspaceId}/invoices`,
  {
    headers: {
      Authorization: `Bearer ${process.env.INVOICESPARSER_API_KEY}`,
    },
  }
);
const { data } = await res.json();

API keys carry one or more scopes that limit what they can do. Assign the minimum scopes required.

All resource endpoints are scoped to a workspace. Your workspace ID is visible in the URL when you are logged into the dashboard (/dashboard), or returned by GET /api/v1/workspaces.

# Base pattern
https://invoicesparser.com/api/v1/workspaces/{workspaceId}/{resource}

# List invoices
GET /api/v1/workspaces/{workspaceId}/invoices

# Upload an invoice
POST /api/v1/workspaces/{workspaceId}/invoices/upload

# Get a single invoice
GET /api/v1/workspaces/{workspaceId}/invoices/{invoiceId}

All errors follow the same JSON envelope:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required."
  }
}