PLATFORM / API

The unified API for income verification.

Stop integrating multiple providers. One API call, one schema and Teal automatically routes through direct payroll connections, user-authorised logins, and document scanning to maximise hit rates on every verification.

api.goteal.co200 OK

POST/verification

{
  "id": "ver_9a8b7c6d",
  "sources": [
    "direct_connect",
    "user_connect",
    "doc_scan"
  ],
  "lookback_months": 3,
  "recurrence": "disabled",
  "journey_outcome": "sync",
  "webhook_url": "https://…/hook"
}
CORE CAPABILITIES

One API. Multiple sources.

Everything you need to build, test, and scale income verification. From intelligent routing to enterprise-grade compliance.

Smart Source Routing

Define primary and fallback sources. Teal automatically routes requests through the optimal path to maximise hit rates.

Consistent Data Format

No matter the source: direct payroll, user login, or document scan. The output is always the same standardised format.

Webhooks & Events

Real-time notifications for status changes, verification completions, and required actions. No polling needed.

SDKs & Libraries

Official SDKs for Node.js, Python, and direct REST. Production-ready with full type safety and comprehensive docs.

Sandbox Environment

Test against realistic mock data before going live. Full API parity with production, so you can ship with confidence.

Security & Compliance

ISO 27001 certified, ICO registered, GDPR compliant. End-to-end encryption and API key scoping as standard.

VERIFICATION ARCHITECTURE

How smart source routing works.

A single API call triggers an intelligent routing sequence. Teal tries the fastest, most reliable source first and falls through to alternatives only when needed, maximising both speed and coverage.

Your ApplicationPOST /verification
RULES ENGINEORCHESTRATION

Teal API

Routes requests and delivers consistent, verified data across multiple sources

SMART FALLBACK
STEP 1

Direct Connect

Try first, fastest path

< 1slatency
STEP 2

User Connect

Fall through, user-authorised

~ 10slatency
STEP 3

Doc Scan

Final fallback, universal

< 20slatency
Standardised Verified OutputDelivered via API response or webhook. Same schema, every time.
CLIENT CONFIGURATION

Total control over every verification.

Define how Teal collects, delivers, and monitors income data. Every parameter is configurable per client or per request.

Data Sources

Choose which verification methods to enable: Direct Connect, User Connect, Doc Scan. Enable or disable any source to tailor the user experience and data flow.

Lookback Period

Set how many months of payroll data to retrieve. From the latest payslip to a full 12-month history, depending on your underwriting needs.

Data Recurrence

Run verifications once at onboarding, or schedule recurring checks at any cadence. Stay informed as borrower circumstances change.

Journey Outcome

Choose between synchronous, where the applicant completes the journey in your flow, or asynchronous, where Teal delivers results via webhook for your team to action.

client_config.json
{
  "data_sources": {
    "direct_connect": true,
    "user_connect":   true,
    "doc_scan":       true
  },

  "lookback_months": 6,

  "recurrence": {
    "enabled":   true,
    "frequency": "monthly"
  },

  "journey_outcome": "async",
  "webhook_url":    "https://api.yourapp.com/teal/callback"
}
COVERAGE & RELIABILITY

Built for UK-first verification.

Deep payroll integrations across the UK, with fallback coverage to ensure no applicant is left behind.

20+Payroll Providers

Direct integrations with the UK's leading payroll and accounting platforms.

80%UK PAYE Coverage

Direct connection coverage across PAYE employees via payroll providers.

100%Universal Coverage

Teal can verify income for 100% of your application funnel via direct connections, user logins, and document scanning.

99.9%Target Uptime

Enterprise-grade infrastructure with redundancy and real-time monitoring.

Ready to integrate?

Get sandbox access, explore the docs, and ship your first verification in minutes.