Website

Starter Kit

API Reference

Support

Create an account

Account are the payroll and HR platform accesses that users link to Teal, providing a stream of income and employment data

ApiKeyAuth

Creates an account for the user e.g. a Xero account

Introduction

Data

Sandbox

Welcome to the comprehensive guide to use Teal API, a pivotal resource for accessing real-time payroll and employment verification data.

Quickstart

Stay updated with real-time notifications via our Webhooks service.

Webhooks

Create a User

Retrieve a user

List all Users

Delete a user

Generate User token

List all accounts

Get an account

Delete an account

Create a connection

Uploads payslips as a multipart form data http request. Every payslip must be a searchable and readable PDF file. Scanned images as pdf files are not supported. If a file part header `external_document_id` is provided it will be returned as `document_external_id` in the respective payroll submission. If the header is not provided, the form field name for the file part will be used instead.

Upload payslips

List all entries

Delete an entry

Get Payroll

Retrieve a specific document

Lists all documents

Delete a document

Create a Webhook

Retrieve a Webhook

List all webhooks

Delete a Webhook

API Documentation

Users

User Token

Accounts

Entries

Payroll

Documents

Webhooks

Create an account

Authorizations

Body

Response