Skip links
Request a demo
MonitorPay

MonitorPay API

REST API to run bank account verifications and track your usage. Built for finance, compliance and fintech teams that need structured, real-time checks at scale.

Base URL

BASEhttps://api.monitorpay.ai/v1
Request API Key View authentication

support@monitorpay.ai · Terms & Conditions

Quick start 
# Make your first call
curl https://api.monitorpay.ai/v1/metrics \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json"

Authentication

The MonitorPay API uses API keys to authenticate requests. Pass your key in the Authorization header of every request as a bearer token.

Get your key from the MonitorPay Dashboard or ask your account manager. Keep keys secret — never commit them to source control or expose them in client-side code.

Header format

Authorization: Token YOUR_API_KEY
Tip: Use separate keys for sandbox and production. Sandbox keys start with mp_test_, live keys start with mp_live_.
Authenticated request
curl https://api.monitorpay.ai/v1/metrics \
  -H "Authorization: Token mp_live_00000000-0000-0000-0000-000000000000"
401Invalid token
{
  "detail": "Invalid token"
}

Errors

MonitorPay uses conventional HTTP response codes. Codes in the 2xx range mean success, 4xx means the request failed (missing field, invalid token, limit reached), and 5xx means something went wrong on our side.

CodeTypeWhen
401TokenVerificationErrorAPI key missing, invalid, or revoked.
400InvalidRequestA required field is missing or malformed.
402LimitErrorYour plan's daily limit has been reached.
500InternalErrorGeneric server error. Safe to retry with backoff.
400Validation error
{
  "field_name": [
    "This field is required."
  ]
}
402Limit error
{
  "access": {
    "permission": "code_permission",
    "module": "code_module",
    "app": "api"
  },
  "error_guard": "limits.daily",
  "message_guard": "You have reached your daily online browsing limit"
}
500Internal error
{
  "detail": "A server error occurred."
}

Verify bank account

Runs a bank account verification and returns a structured result with status, bank metadata, and any risk indicators.

POST/bank-verification

Request body

Schema pending. Request and response fields to be confirmed against the live /bank-verification spec before publication.
POST /bank-verification 
curl -X POST https://api.monitorpay.ai/v1/bank-verification \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
200 OKExample response
{
  // Schema to be confirmed
  "id": "ver_...",
  "status": "verified"
}

Get verification config

Returns the configuration for the bank verification service — supported countries, required fields, and available checks. Use this to build dynamic onboarding forms that adapt to each jurisdiction.

GET/bank-verification/config
Schema pending. Response fields to be confirmed.
GET /bank-verification/config 
curl https://api.monitorpay.ai/v1/bank-verification/config \
  -H "Authorization: Token YOUR_API_KEY"

Verification history

Lists every verification your account has run. Use this to build internal audit dashboards or reconcile billing.

GET/bank-verification/history
Schema pending. Pagination and filter parameters to be confirmed.
GET /bank-verification/history 
curl https://api.monitorpay.ai/v1/bank-verification/history \
  -H "Authorization: Token YOUR_API_KEY"

Get verification by ID

Fetches the full record for a single historical verification, including the original request payload and the raw response returned at the time of the check.

GET/bank-verification/history/{id}

Path parameters

FieldTypeRequiredDescription
idstringRequiredThe verification ID returned from /bank-verification.
GET /bank-verification/history/{id} 
curl https://api.monitorpay.ai/v1/bank-verification/history/52 \
  -H "Authorization: Token YOUR_API_KEY"

Usage metrics

Review how much information you have consumed from MonitorPay, along with your total limits and remaining credits. Useful for internal billing dashboards and quota alerts.

GET/metrics

Response fields

FieldTypeDescription
namestringHuman-readable permission name.
codenamestringMachine-readable key.
metricsarrayArray of metrics with used and total counts.
GET /metrics 
curl https://api.monitorpay.ai/v1/metrics \
  -H "Authorization: Token YOUR_API_KEY"
200 OKUsage
[
  {
    "name": "Bank Verification",
    "codename": "bank_verification",
    "metrics": [
      {
        "name": "Bank Verification",
        "codename": "bank_verification",
        "used": 10,
        "total": 100
      }
    ]
  }
]

Metrics contacts

Returns the count of contacts (email and phone) consumed over a specific date range. Useful for reconciling billing and tracking enrichment usage.

GET/metrics/contacts

Query parameters

FieldTypeRequiredDescription
date_fromdatetimeRequiredStart of the date range, ISO format.
date_todatetimeRequiredEnd of the date range, ISO format.
GET /metrics/contacts 
curl "https://api.monitorpay.ai/v1/metrics/contacts?date_from=2026-03-10%2000:00:00&date_to=2026-04-10%2000:00:00" \
  -H "Authorization: Token YOUR_API_KEY"
200 OKContacts usage
{
  "email_count": 317,
  "phone_count": 792
}

Start verifying payments in minutes

First 100 checks are free. No monthly minimums — pay only for what you use. Get your API key and ship a real integration today.

Request API Key Talk to sales