Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Document Extraction Connections API
version: 1.0.0
description: 'Email sign-up at /app/api/auth/sign-up/email requires an x-turnstile-token
header in production. Failed or unavailable bot verification returns 403
with code BOT_CHECK_REQUIRED. Social sign-up is unaffected.
Documents in. Verified data out.
The public REST API (v1) turns documents (invoices, receipts, purchase
orders, bank statements, delivery notes, or custom schemas) into
structured, verified data. Every document reaches an explicit terminal
state. Every extracted table row is accounted for. Money fields are
cross-checked (crossfooting). Bank statements are balance-checked.
Every field links back to its source in the document.
Unsupported methods on registered API paths return an empty
405 Method Not Allowed response with an Allow header listing supported
methods. HEAD is supported wherever GET is registered; OPTIONS keeps its
existing preflight behavior. Unknown paths remain 404. Maintenance and
canonical-host redirects still take precedence.'
contact:
email: support@arkrel.com
servers:
- url: https://arkrel.com
description: Production, one Worker, one domain, same origin as the site itself (no separate api.<domain> host)
security:
- ApiKeyAuth: []
tags:
- name: Connections
paths:
/app/api/plaid/connections:
get:
summary: List bank connections, accounts, available statements and recent activity
tags:
- Connections
security:
- SessionCookie: []
description: Dashboard session cookie required. Owner or admin only. Mutations require same-origin Origin. Link and exchange require MFA, fresh step-up and Catch-Up or Autopilot entitlement. Disconnect requires step-up and remains available after downgrade.
responses:
'200':
description: Successful request.
content:
application/json:
example:
enabled: true
years:
- 2025
items:
- id: pitem_example
status: connected
institution_name: Example Bank
synced_at: null
last_error: null
transactions_enabled: true
accounts: []
statements: []
activity: []
schema:
type: object
required:
- enabled
- years
- items
- accounts
- statements
- activity
properties:
enabled:
type: boolean
years:
type: array
items:
type: integer
items:
type: array
items:
type: object
required:
- id
- status
- institution_name
- synced_at
- last_error
- transactions_enabled
properties:
id:
type: string
status:
type: string
enum:
- connected
- needs_reauth
- disconnecting
- disconnected
transactions_enabled:
type: boolean
description: Whether the connection requests transaction activity. False for statements-only connections and pending removals; disconnected items no longer sync.
institution_name:
type:
- string
- 'null'
synced_at:
type:
- string
- 'null'
last_error:
description: Sanitized import status. QUOTA_EXCEEDED means imports are paused for page allowance with automatic backoff; downloaded PDFs are reused on retry.
type:
- string
- 'null'
accounts:
type: array
items:
type: object
required:
- id
- item_id
- name
- mask
- type
properties:
id:
type: string
item_id:
type: string
name:
type: string
mask:
type:
- string
- 'null'
type:
type:
- string
- 'null'
statements:
type: array
items:
type: object
required:
- id
- item_id
- account_id
- year
- month
- date_posted
- document_id
- imported_at
- failure_reason
- removal_reason
properties:
id:
type: string
item_id:
type: string
account_id:
type: string
year:
type: integer
month:
type: integer
date_posted:
type:
- string
- 'null'
document_id:
type:
- string
- 'null'
removal_reason:
description: Reason the imported document was removed. Disconnect records disconnect. Import receipts survive bank disconnection and retirement until account deletion; removed statements are not downloaded or charged again on reconnect. Their PDFs can be uploaded directly.
type:
- string
- 'null'
enum:
- retention
- deleted
- disconnect
- null
failure_reason:
description: Plain reason a statement could not be imported; upload a PDF copy.
type:
- string
- 'null'
imported_at:
type:
- string
- 'null'
activity:
type: array
items:
type: object
required:
- id
- item_id
- account_id
- date
- name
- amount
- currency
- pending
properties:
id:
type: string
item_id:
type: string
account_id:
type: string
date:
type: string
name:
type: string
amount:
type: number
currency:
type:
- string
- 'null'
pending:
type: integer
enum:
- 0
- 1
default:
description: Structured API error. 400 invalid input, 401 session or step-up, 402 plan locked, 403 role or MFA, 404 unavailable, 409 exchange in progress, 429 rate limited.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: listBankConnections
/app/api/plaid/link-token:
post:
summary: Create a session-bound Plaid Link token or update-mode token
tags:
- Connections
security:
- SessionCookie: []
description: Dashboard session cookie required. Owner or admin only. Mutations require same-origin Origin. Link and exchange require MFA, fresh step-up and Catch-Up or Autopilot entitlement. Disconnect requires step-up and remains available after downgrade.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
item_id:
type: string
year:
type: integer
responses:
'200':
description: Successful request.
content:
application/json:
example:
link_token: link-example
link_session_id: session-example
expiration: '2026-10-02T21:00:00Z'
schema:
type: object
required:
- link_token
- link_session_id
- expiration
properties:
link_token:
type: string
link_session_id:
type: string
expiration:
type: string
format: date-time
default:
description: Structured API error. 400 invalid input, 401 session or step-up, 402 plan locked, 403 role or MFA, 404 unavailable, 409 exchange in progress, 429 rate limited.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: createBankLinkToken
/app/api/plaid/exchange:
post:
summary: Complete a session-bound Link attempt
tags:
- Connections
security:
- SessionCookie: []
description: Dashboard session cookie required. Owner or admin only. Mutations require same-origin Origin. Link and exchange require MFA, fresh step-up and Catch-Up or Autopilot entitlement. Disconnect requires step-up and remains available after downgrade.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
link_session_id:
type: string
public_token:
type:
- string
- 'null'
required:
- link_session_id
responses:
'200':
description: Successful request.
content:
application/json:
example:
item_id: pitem_example
schema:
type: object
required:
- item_id
properties:
item_id:
type:
- string
- 'null'
default:
description: Structured API error. 400 invalid input, 401 session or step-up, 402 plan locked, 403 role or MFA, 404 unavailable, 409 exchange in progress or BANK_CONNECTION_RETIRED when bank access ends during reconnect, 429 rate limited.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: exchangeBankPublicToken
/app/api/plaid/connections/{id}/refresh:
post:
summary: Schedule an Autopilot bank refresh
tags:
- Connections
security:
- SessionCookie: []
description: Dashboard session cookie required. Owner or admin only. Mutations require same-origin Origin. Link and exchange require MFA, fresh step-up and Catch-Up or Autopilot entitlement. Disconnect requires step-up and remains available after downgrade. Refresh requires an active Autopilot subscription; Catch-Up returns 403.
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'202':
description: Successful request.
content:
application/json:
example:
scheduled: true
schema:
type: object
required:
- scheduled
properties:
scheduled:
type: boolean
default:
description: Structured API error. 400 invalid input, 401 session or step-up, 402 plan locked, 403 role or MFA, 404 unavailable, 409 exchange in progress, 429 rate limited.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: refreshBankConnection
/app/api/plaid/connections/{id}:
delete:
summary: Remove a Plaid Item and its imported data
tags:
- Connections
security:
- SessionCookie: []
description: Dashboard session cookie required. Owner or admin only. Mutations require same-origin Origin. Link and exchange require MFA, fresh step-up and Catch-Up or Autopilot entitlement. Disconnect requires step-up and remains available after downgrade. DELETE for a retired connection returns 409 BANK_CONNECTION_RETIRED. Imported statements stay in Documents under the same retention setting as uploads after bank access ends.
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successful request.
content:
application/json:
example:
removed: true
schema:
type: object
required:
- removed
properties:
removed:
type: boolean
'202':
description: Removal is pending and will be retried by cron.
content:
application/json:
example:
removed: false
schema:
type: object
required:
- removed
properties:
removed:
type: boolean
default:
description: Structured API error. 400 invalid input, 401 session or step-up, 402 plan locked, 403 role or MFA, 404 unavailable, 409 exchange in progress, 429 rate limited.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: disconnectBankConnection
/app/api/plaid/webhook:
post:
summary: Receive a signed Plaid webhook
tags:
- Connections
security: []
description: Plaid-Verification ES256 JWT required. Exact body hash and five-minute freshness enforced.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
item_id:
type: string
webhook_type:
type: string
webhook_code:
type: string
required:
- item_id
responses:
'200':
description: Successful request.
content:
application/json:
example:
received: true
schema:
type: object
required:
- received
properties:
received:
type: boolean
default:
description: Structured API error. 400 invalid input, 401 session or step-up, 402 plan locked, 403 role or MFA, 404 unavailable, 409 exchange in progress, 429 rate limited.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: receivePlaidWebhook
parameters:
- in: header
name: Plaid-Verification
required: true
schema:
type: string
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
field:
type: string
securitySchemes:
BusinessSession:
type: apiKey
in: cookie
name: better-auth.session_token
description: Better Auth session cookie. Mutations also require a same-origin Origin header.
EngineToken:
type: apiKey
in: header
name: X-Engine-Token
description: Shared operator token for internal maintenance.
SessionCookie:
type: apiKey
in: cookie
name: __Host-arkrel_session
description: Signed-in app session. Mutations also require a same-origin request. Sensitive actions by accounts with a password without completed protection receive 403 TWO_FACTOR_SETUP_REQUIRED as described in x-app-account-protection. The free first look and account deletion remain available.
ApiKeyAuth:
type: http
scheme: bearer
description: 'API key shown once at creation, e.g. `sk_live_...` / `sk_test_...`.
Stored server-side as a salted hash; only the prefix is retrievable
afterward.
API keys and MCP credentials are checked against their creating user on every request. If that user has a password without enabled TOTP, requests return HTTP 403 TWO_FACTOR_SETUP_REQUIRED. Organization/service keys with no creating user keep their existing behavior.
'
x-webhook-delivery-payload:
$ref: '#/components/schemas/WebhookDeliveryPayload'
x-app-email-signup:
path: /app/api/auth/sign-up/email
method: POST
header: x-turnstile-token
status: 403
code: BOT_CHECK_REQUIRED
description: A fresh single-use Turnstile token with action signup and hostname matching APP_BASE_URL is required in production. Missing, invalid, expired, or unavailable verification fails closed. Reset the widget after each submission. Google sign-up is unaffected. Local development without a configured secret does not require a challenge. This route is served by the mounted Better Auth handler.
x-app-account-protection:
status: 403
code: TWO_FACTOR_SETUP_REQUIRED
response:
$ref: '#/components/responses/TwoFactorSetupRequired'
description: 'Password accounts require verified TOTP before checkout or billing changes, reports and exports (PDF, CSV, accountant CSV, QuickBooks, Xero, OFX, JSON downloads, statement exports and data ZIP), share creation and use, API keys and MCP, bank or ledger connections, team changes, email/password changes, inbound sender allowlist changes, callback secrets, and uploads with webhook_url. Uploads that would consume paid page credits or record billable overage also return TWO_FACTOR_SETUP_REQUIRED before storage. Included monthly and purchased Catch-Up allowances remain available. Admission reserves pending pages, and settlement rechecks live protection against actual processed pages. Chart-of-accounts sync and all chart writes require protection; stored chart and categorization-settings reads do not contact a ledger provider. Session uploads with a callback return TWO_FACTOR_SETUP_REQUIRED before storing or scheduling the document when the password account needs setup. The same refusal applies when the business has an active saved outbound webhook, even if webhook_url is omitted. Queued webhook dispatch checks live creator and document-uploader protection before sending, including retries. Existing role, entitlement and step-up requirements remain. Linked passkeys or providers do not exempt password accounts. Passwordless accounts keep existing rules. Email verification remains required. Sign-up and sign-in do not redirect to setup. The free first look stays open: one statement upload or email-in, processing, merchant review, rules, My year and locked report previews, billing/pricing views, profile and business name, sign-out, and account deletion with its existing step-up. Sensitive actions prompt inline and resume after setup. Direct /protect-account links remain supported. Other app routes default to protection. Exemptions use explicit methods and complete route patterns; business settings changes other than name-only renames, session revocation, provider linking and token access require protection. Implicit same-email provider linking is disabled: sign in with the password first, protect the account and pass step-up, then link explicitly. Explicit linking and passkey registration require fresh step-up and recheck at credential creation or verification. Already-linked provider sign-in and first-time provider signup remain available. Authentication, recovery and TOTP enrollment ceremonies remain available. Credential mutation routes require protection, including passkey registration options and verification. OAuth and passkey removal also require fresh step-up (401 STEP_UP_REQUIRED). Password credential unlinking is refused with 403 PASSWORD_REMOVAL_NOT_ALLOWED even after enrollment and step-up, preserving the password account protection requirement. The server reads live enrollment. API keys and MCP credentials retain their creator check; creatorless service keys retain existing behavior. Share links created by an unprotected password account remain unavailable.'
open_workflows:
- Free first look and locked report preview
- Billing and pricing views
- Profile name and sign-out
- Account deletion with existing step-up
- Authentication and protection enrollment
session_status:
path: /app/api/auth/me
rate_limits:
window_seconds: 60
per_session: 180
per_ip: 600
status: 429
retry_header: Retry-After
description: Independent read budgets. The IP budget precedes session resolution; the session budget uses the resolved session ID before membership and protection reads. These reads do not consume credential budgets.
field: two_factor_setup_required
schema:
type: boolean
description: Present on authenticated responses. True means sensitive actions require enrollment; it does not block the free first look or redirect sign-in. Absent when user is null.
x-app-account-deletion:
description: An account deletion intent (pending, processing, or failed) ends access immediately, including while financial obligations delay purge. All user sessions are revoked atomically with the intent, along with user-created API keys, share links, invitations, webhooks and inbound email addresses across every business. Better Auth lookups hide retained identities and their credentials. Validation, reset, verification and challenge errors follow the native unknown-user or unknown-token behavior, including validation order and password work. Anonymous sign-up uses the generic duplicate response without sending mail or creating credentials. OAuth cannot recreate a reserved identity. Credential inserts, updates and deletes are fenced against deletion at SQL execution time. Old session and two-factor challenge cookies are ignored on the request. Deletion never sends cookie expirations, so delayed responses cannot erase another login. Auth revocation expires sessions that anchor Plaid compensation operations and retains their rows until those operations are removed by their own lifecycle. Step-up and invite acceptance return the existing unauthenticated HTTP 401 response. Removed magic-link endpoints remain HTTP 404 for everyone. The email is reserved until purge completes. Business-only deletion retains the login and other businesses, but hides and blocks the deleting business immediately, including while billing leases drain. API keys for deleting businesses return unauthenticated HTTP 401.
x-app-step-up:
window_seconds: 600
description: 'Sensitive app actions require fresh identity verification. GET /app/api/auth/step-up returns password, code, email, passkey, google, microsoft and fresh booleans. POST /app/api/auth/step-up accepts exactly one of password, code (TOTP/backup), or emailCode. POST /app/api/auth/step-up/email sends a six-digit code to the verified email of a passwordless account, at most three times per ten minutes per user. Codes are hashed, single-use, expire after ten minutes, permit five attempts, and are bound to the initiating live session, user, email and step-up purpose. Resending invalidates the previous code. Verification is rate-limited. Passkey ceremonies require x-arkrel-step-up: 1 on both challenge issuance and verification, biometric/PIN user verification, and a server-side purpose, user and session binding that expires after five minutes. Consumption requires the exact initiating live session. Provider users call sign-in/social with a linked google provider and additionalData.stepUp=true. The server rejects idToken shortcuts and binds OAuth state to the original user/session for five minutes. Google cannot force reauthentication and is opportunistic only. It requires a back-channel auth_time between initiation and completion; token issuance time never counts. Missing, stale or future auth_time is rejected. Passwordless users can use an email code or a registered passkey when Google cannot verify freshness. Successful passkey/provider verification rotates and elevates only the returning bound session. Password, TOTP and email checks elevate the initiating session. These app-only auth surfaces are not exposed by integrations or MCP.'
x-consumer-statement-admission:
description: App uploads and inbound email share one Free statement allowance per account. Additional app uploads return 402 FREE_STATEMENT_USED. Inbound attachments wait for an upgrade. Retries recover the original admitted attachment. Developer API per-page pricing is unchanged.
x-maintenance-bridge:
description: 'During the production cutover, an isolated maintenance Worker returns HTTP 503 for every method and path, including reads and health checks, with Retry-After: 60 and Cache-Control: no-store. API, MCP, internal, and webhook paths return error.code MAINTENANCE and error.message "Arkrel is updating. Please try again in a few minutes." MCP receives this plain JSON error instead of JSON-RPC while the bridge is deployed. Other paths return HTML. HEAD returns headers without a body. Retry after the indicated delay.'
x-maintenance-mode:
description: 'MAINTENANCE_MODE=1 freezes mutations across app, REST, MCP and engine routes. Mutations and OAuth or verification callbacks return 503 with Retry-After: 60. REST errors use code MAINTENANCE_MODE. MCP tool mutations use JSON-RPC code -32004. Reads, health and status remain available. Read-time refresh, audit, counters and automatic categorization are suspended. Cron writes are skipped; inbound email invocations fail before ingestion so delivery can be retried.'
x-stripe-billing-webhook:
path: /app/api/billing/webhook
authentication: Stripe-Signature
refund_events:
- charge.refunded
- refund.updated
- refund.failed
dispute_events:
- charge.dispute.created
- charge.dispute.updated
- charge.dispute.closed
description: Refund IDs and provider statuses are persisted. Catch-Up access and unused page credits are revoked only after a succeeded refund. Pending or failed refunds retain access. The dashboard refund response has refunded=false while an automatic refund is pending or failed, with auto=true indicating that the automatic request was submitted. Disputes suspend the charged subscription, Catch-Up year, or unused page credits. A won dispute restores only the saved access and original credit expiration, unless the payment was refunded or another dispute still holds it. Lost disputes remain suspended. Subscription updates cannot bypass a hold. Independent AppSumo codes are unaffected. The owner receives an operational email alert.
x-app-catchup-payment-clock:
path: /app/api/usage
field: catchup_purchases
items:
type: object
required:
- tax_year
- purchased_at
- payment_settled_at
- expires_at
properties:
tax_year:
type: integer
purchased_at:
type: string
format: date-time
description: Purchase record time. Do not use as an unresolved payment clock fallback.
expires_at:
type: string
format: date-time
description: Access and unused pages end at this instant, 12 months after settlement. Older test rows use their purchase timestamp until settlement is reconciled.
payment_settled_at:
type: string
format: date-time
nullable: true
description: Confirmed payment charge time, or null while confirmation is unresolved. The 30-day guarantee starts at this time.