Website

Starter Kit

API Reference

Support

Create a connection

The status of the employment. Status `active` will be used when the user is employed in the company,  alternatively `inactive` will be used when the user is not employed in the company anymore.


The national insurance number of the user

A string coming from the parameters of the uploaded payslip1.pdf either the form field name or `external_document_id` header for the file part. It might not be unique and depends on what's passed when uploading. If the payroll submission doesn't originate from a payslip this will be null.

If the payroll submission originates from a payslip this will be the file name of the uploaded payslip. It will be duplicate if same file names are uploaded If the payroll submission doesn't originate from a payslip this will be null.

For an account, a call to the `/entries/connections` endpoint will query the connection for data. This endpoint is for adhoc data retrieval for an account; Teal will also collect the payroll data for users via the WebUI as soon as a valid connection is established. This endpoint can be applied to any account, it does not matter if it was established via your own call to `POST /accounts` or via the Teal WebUI. Note that any new data retrieved via `/entries/connections` is persisted on Teal's storage and can be retrieved using the `/payroll/{user_id}` endpoint.

BearerAuth

Connects a user account to a payroll provider

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

Create an account

List all accounts

Get an account

Delete an account

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.

API Documentation

Users

User Token

Accounts

Entries

Payroll

Documents

Webhooks

Create a connection

Authorizations

Body

Response