Purpose – Confirms if payroll deduction is available for the specified Consumer.
Light Availability Check#
Light allows you to find the probability of payroll deduction availability without requiring the consumer's National Registration Number. The more data points supplied into this match, the more confident we can be of the result.Full Availability Check#
Full allows you to get a confirmed availability result by also supplying the consumer's National Registration Number. If provided by the Payroll Provider, we will also return employment data for the consumer to help with your decisioning processes.Data Flow#
1. Biller calls the Ontime Availability Check Endpoint#
The employee should be informed about the data sharing in the Biller's Privacy Policy and in the customer journey.When you check if payroll deduction is available to the customer you will be passing consumer data to Ontime. It is the caller's responsbility to ensure they have an appropriate and legitimate legal basis to pass consumer data to Ontime.
2. Payroll Verification#
Ontime calls each of its Payroll Partners partners to see whether the Consumer is paid through their software. Ontime shares the following data:| Consumer Data Item | Purpose | Light | Full |
|---|
| Given Name | Key data point | required | required |
| Family Name | Key data point | required | required |
| Date of Birth | Key data point | required | required |
| Postal Code | Supporting data point | optional | required |
| National Registration Number | Guarantees availability status | optional | required |
| Email Address | Supporting data point | optional | optional |
| Phone Number | Supporting data point | optional | optional |
3. Ontime confirms consumer's availability status#
Ontime returns a positive availability status. You can now offer the customer a product that is paid through Ontime.LightAvailabilityCheckResponse
FullAvailabilityCheckResponse
The AvailabilityCheck does not require an Idempotency-Key header value to be passed. The AvailabilityCheck can be called frequently and will always return the current status.
