Full Availability Check

Ontime calls this endpoint to find a consumer on the payrolls you manage, and their employments. Respond 200 with availability_status unavailable when the consumer is not found.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Example

{
    "availability_check": {
        "national_registration_number": "QQ123456C",
        "date_of_birth": "1969-05-19",
        "given_name": "Alice",
        "family_name": "Smith",
        "email_address": "alice.smith@example.org",
        "phone_number": "+44 7700 900123",
        "postal_code": "GU1 2AA",
        "currency": "GBP",
        "employer_name": null
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Indicates the request was successfully processed by the server and a valid response is included in the body.

Bodyapplication/json

Examples

ConfirmedUnavailable

{
    "availability_check": {
        "national_registration_number": "QQ123456C",
        "availability_status": "confirmed",
        "currency": "GBP",
        "employments": [
            {
                "employment": {
                    "employee_id": "EMP-001",
                    "start_date": "2021-04-06",
                    "currency": "GBP",
                    "employer": {
                        "id": "EMPLOYER-001",
                        "name": "Emp Co Limited",
                        "registration_number": "01234567",
                        "sic_code": "64191",
                        "industry_name": "Financial Services",
                        "employer_opt_in_status": "accepted"
                    },
                    "payrolls": [
                        {
                            "payroll": {
                                "id": "PAYROLL-001",
                                "employment_status": "active",
                                "contract_type": "full_time",
                                "payment_run_frequency": "monthly",
                                "annualised_salary": 3000000,
                                "pay_dates": [
                                    {
                                        "pay_date": "2026-10-28",
                                        "payroll_cutoff": "2026-10-20",
                                        "pay_period": "October-26"
                                    },
                                    {
                                        "pay_date": "2026-11-27",
                                        "payroll_cutoff": "2026-11-19",
                                        "pay_period": "November-26"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}

🟠404Record Not Found

🟠400Bad Request

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity