Skip to main content

​
How it works

Our modular API gives you access to one of the richest sources of data to improve your underwriting process - payroll data. This data is acquired with user consent either via payroll-linked access or with payslip upload. How it works

​
Connecting payroll account

By connecting to our API you will have access to consent based access to a user’s historical payroll data. Teal’s API enables lenders to receive income data safely from their users, fully embedded within lending flows. The user will be walked through a permission flow, where they will allow to connect to their payroll provider. Teal will extract their data, and then expose via API to your services. Payroll Connection Flow

​
Uploading payslips

Our API also supports the upload of payslip documents. Thus, enabling the automatic extraction of payslips information and instant data share. We use state of the art LLMs in combination with our own models for maximum accuracy of the extracted data. Borrowers will be able to upload their payslips in a webflow hosted by Teal. The payslips will be parsed and data such as identity, income and employment information will be extracted, encrypted and securely stored in the database. The documents are verified for authenticity, controlling for visual inconsistencies and changes in the meta data. Upload Payslip FLow

​
Accessing user data

The data is securely exposed via our API. By default, the data is extracted in JSON format after the request is done. The data will be exposed via our API, so lenders can receive it immediately and take a decision based on the shared data. Example of payroll submission retrieval: 
{
  "pagination": {
    "count": 14,
    "limit": 25,
    "offset": 75,
    "total_count": 89
  },
  "payroll_submissions": [
    {
      "id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
      "account_id": "e920bcba-85bb-4a8d-9ce2-0b29e5217e4d",
      "entry_id": "f630296a-3046-46ea-86e5-689f08085f1b",
      "created_at": "2019-05-17T00:00:00.000Z",
      "document_external_id": null,
      "document_filename": null,
      "employment_information": {
        "employer_name": "Acme Ltd",
        "leave_date": "2019-05-17T00:00:00.000Z",
        "role": "Software Engineer",
        "start_date": "2019-05-17T00:00:00.000Z",
        "status": "Active",
        "type": "Full-time"
      },
      "identity_information": {
        "NI_number": "AB123456C",
        "address": {
          "city": "London",
          "country": "United Kingdom",
          "county": "Greater London",
          "post_code": "SW1A 1AA",
          "street": "123 Main Street"
        },
        "date_of_birth": "2019-05-17T00:00:00.000Z",
        "email": "john.smith@company.com",
        "name": "John Smith",
        "phone": 447123456789
      },
      "income_information": {
        "deductions": {
          "employee_ni": 200,
          "employee_pension": 300,
          "income_tax": 500,
          "total_deductions": 1000
        },
        "earnings": {
          "base_salary": 3000,
          "bonus": 500,
          "gross_pay": 3500,
          "net_pay": 2500
        },
        "pay_date": "2019-05-17T00:00:00.000Z",
        "pay_frequency": "Monthly",
        "pay_interval_end": "2019-05-17T00:00:00.000Z",
        "pay_interval_start": "2019-05-17T00:00:00.000Z"
      }
    }
  ]
}