Home
Home
  1. Availability and Onboarding
  • Welcome
  • Getting started
    • Availability and Onboarding
      • Light Availability Check
      • Full Availability Check
      • Onboarding
    • Salary Deduction
      • Deduction Instruction
      • Re-running Payroll
      • Deduction Payments and Reconciliation
      • Changes to Employee Status
  • API Reference
    • Authentication
    • Idempotency
    • Webhooks
      • Webhooks
    • Salary Deduction
      • Salary Deduction Data Request
      • Salary Deduction Confirmation Submission
  • Payroll Provider Reference Implementation
    • Light Availability Check
      POST
    • Full Availability Check
      POST
    • Salary Deduction Enablement
      POST
    • Payroll Information
      GET
    • Salary Deduction Employee Data Push
      POST
  • Schemas
    • Availability Check
      • Full Availability Check Request
      • Full Availability Check Response
      • Light Availability Check Request
      • Light Availability Check Response
    • Core
      • ProblemDetails
      • MetaData
      • Paged Response
    • Deduction Instructions
      • Salary Deduction Request
      • Salary Deduction
      • Confirmation Deduction Response
      • Salary Deduction Enablement Response
      • Employee Deduction Push Response
      • Employee Deduction Push Request
      • Salary Deduction Push
      • InstructionFile
      • InstructionItem
    • Payment Account
      • Payment Account
      • Payment Information
    • Payroll
      • Employee
      • Availability Payroll
      • Availability Employment
      • Availability Employer
      • BeneficiaryAccountResponse
      • Salary Deduction Confirmation Data Submission
      • Salary Deduction Confirmation Data Submission Response
      • Salary Deduction Data Request
      • Salary Deduction Data Response
      • Payroll
      • Employee Payroll
      • Employment
      • Employer
      • Pay Date
      • Salary Deduction Enablement Request
      • PayrollScheduleResponse
    • Webhooks
      • Employee Update Payload
      • WebHook
  1. Availability and Onboarding

Full Availability Check

About the Full Availability Check#

Billers use the Full Availability Check when they need 100% confidence that the applicant can make payments through Ontime.
To achieve 100% confidence, Billers need to ask the applicant to enter their National Insurance Number (NINO). Ontime shares the NINO and the remaining applicant data items with the Payroll Provider. The Payroll Provider then confirms whether a match has been found.

Assumptions and prerequisites#

The Applicant is applying for a utility or credit product from a Biller (e.g. Thames Water, EON, Virgin Money, and others) which uses Ontime.

Flow#

Overview#

Steps#

1

Biller trigger event#

Requirements
The Applicant has selected a product provided by the Biller to pay using Ontime. The Biller now asks the Applicant to enter their National Registration Number (NI number in the UK) in order to confirm that they’re eligible to pay with Ontime.
The customer enters their National Registration Number. The Biller calls the Ontime Platform passing the consumer data.
Consideration
Data sharing is fully GDPR-compliant. The Employee is informed about the data sharing in the Biller Privacy Policy and in the Biller's customer journey
2

Availability Check API Call#

Requirements
Ontime calls each of its Payroll Provider partners to find where the Applicant is found on a managed Payroll.
Ontime shares the following data:-
Full Availability Check Request

API Documentation
To help accelerate Payroll Provider adoption and implementation a reference RESTful specification is available here:
Full Availability Check
3

Payroll Provider Availability Search#

Requirements
3a Payroll Provider searches for the National Registration Number:-
100% match on National Registration Number: Go to step 3b
No match on National Registration Number: Return “No match” to Ontime. End
3b Payroll Provider verifies National Registration Number and one other data point (e.g. last name, date of birth, postcode)
100% match on another data point: Go to step 3c
No 100% match on another data point: Return “Unavailable” to Ontime.
3c Payroll Provider verifies the Employee is still being paid via the Payroll:
No leave date and paid in the latest payrun: Return “Available” response to Ontime (see below)
If the Employee is no longer being paid then return “No Match” to Ontime.
Where a record has been matched, the Payroll Provider returns ‘Available’, together with the following data items:
Full Availability Check Response

Considerations
Exact matches across all of the other data points may not always be possible due to variations such as name variations that cannot be normalised (i.e. Kenneth Brooke - known as Ken Brooke), name changes (i.e. Sarah Hubble - born Sarah Smith), outdated or incomplete address data, and occasional typos (e.g. incorrect date of birth).
4

Ontime processes the response#

Requirements
Ontime processes the data received. For example:
Converts Employee Start Date into tenure (months)
Converts Employer Name / SIC Code into sector
Converts free text contract type into one of three contract types
5

Ontime confirms availability to the Biller#

Requirements
Ontime confirms availability and returns the following datapoints to the Biller:
Tenure (months)
Sector
Contract Type
Salary / Last 12 months’ income
Recommended due date to align with Salary Pay Date
Previous
Light Availability Check
Next
Onboarding