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.
POST/verification
{
"id": "ver_9a8b7c6d",
"sources": [
"direct_connect",
"user_connect",
"doc_scan",
"gov_connect"
],
"lookback_months": 3,
"recurrence": "disabled",
"journey_outcome": "sync",
"webhook_url": "https://…/hook"
}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, document scan, or HMRC tax record. 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. Encrypted with TLS 1.2+ in transit and AES-256 at rest, with API key scoping as standard.
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.
Teal API
Routes requests and delivers consistent, verified data across multiple sources
Direct Connect
Try first, fastest path
User Connect
Fall through, user-authorised
Doc Scan
Final fallback, universal
Gov Connect (HMRC)
ENRICHMENTOPTIONALLayer HMRC tax records in parallel for self-employed and complex income. Configurable, not part of the default fallback.
Total control over every verification.
Define how Teal collects, delivers, and monitors income data. Turn on only the sources that fit your use case. Every parameter is configurable per client or per request.
Plug & Play Sources
Turn on only the sources that fit your use case: Direct Connect, User Connect, Doc Scan, and Gov Connect (HMRC). Enable one or all, Teal orchestrates whatever subset you choose.
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.
{
"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"
}Built for UK-first verification.
Deep payroll integrations across the UK, with fallback routes when a payroll connection isn't available.
Integrations with the UK's leading payroll and accounting platforms.
Direct Connections, User Connections, Doc Scan and Gov Connect, used in whatever order suits your journey.
One API for every source, with payroll data returned in a single format.
Enterprise-grade infrastructure with redundancy and real-time monitoring.
Frequently asked questions
What are the ways to integrate with Teal?
Three, and they can be combined. Use the API on its own and build your own screens. Use the API with Teal's hosted webapp, which handles the applicant's side of the journey. Or use the Teal Console with no code at all, adding applicants and sending them verification links from the dashboard.
How does the Teal API work?
You create the applicant with their details and record their authorisation, then run the sources you need. A Direct Connection returns payroll data in the API response. For journeys where the applicant takes part, you generate a secure link to Teal's webapp. Results are available through the API, with webhooks to tell you when data is ready. Documentation is at docs.goteal.co.
What is the Teal webapp?
A ready-made, hosted journey for applicants, so you don't need to build one. Applicants search for their employer, log in to their payroll account (including entering verification codes), upload payslips if needed, or connect their HMRC record. It shows your logo, and applicants reach it through a secure link sent from the API or the Console.
What is the Teal Console?
A web dashboard for risk, underwriting and operations teams. Underwriters can see each applicant's verified income and employment, including HMRC data, and review uploaded payslips with Doc Scan's trust findings. Managers can track verification volumes and conversion rates across the team.
Can teams use Teal without engineering work?
Yes. In the Console, teams can add applicants one at a time or by CSV upload, email them a verification link individually or in bulk, and view the results as they come in.
How do teams manage access to the Console?
Admins invite team members and assign them roles, and sign-in is protected with multi-factor authentication. Developers manage API keys and webhooks from the same Console.
Ready to integrate?
Get sandbox access, explore the docs, and ship your first verification in minutes.