Skip to main content

Getting Started

Welcome to the Bank Statement Matcher API. This guide will help you get up and running in 5 minutes.

What You'll Need

Before you begin, ensure you have the following:

  1. An active account — Sign up here if you don't have one yet
  2. API credentials — Create an API client in your dashboard to get your Client ID and Client Secret
  3. API Base URL — Use the appropriate endpoint for your environment:
    • Production: https://api.yourdomain.com
    • Sandbox: https://sandbox-api.yourdomain.com
    • Local Development: http://localhost:8000

The API in 30 Seconds

The Bank Statement Matcher API lets you:

  • Upload a bank statement (PDF, CSV, or Excel)
  • Provide a list of expected payment references
  • Get back matched, partially matched, and unmatched items

That's it!

Your First Request

Here's the minimum code to get started:

# 1. Get an access token
TOKEN=$(curl -X POST "http://localhost:8000/api/v1/token" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "env": "sandbox"
  }' | jq -r '.access_token')

# 2. Create a matching job
curl -X POST "http://localhost:8000/api/v1/jobs" \
  -H "Authorization: Bearer $TOKEN" \
  -F "bank=@statement.pdf" \
  -F "expected=@references.csv"

# 3. Check the results
curl -X GET "http://localhost:8000/api/v1/jobs/{job_id}/results" \
  -H "Authorization: Bearer $TOKEN"

What's Next?

Need Help?