Light Availability Check

POST

/deductions/availability/light

OperationId:post_light_availability_check

Ontime will call this endpoint to find out how likely it is that a consumer is on a payroll you manage, without needing their national registration number. Ontime does not call it yet, but payroll providers must host it, as it will be required for a future integration.

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": null,
        "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": "Emp Co Limited"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/deductions/availability/light' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "availability_check": {
        "national_registration_number": null,
        "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": "Emp Co Limited"
    }
}'

Responses

🟢200Success

application/json

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

Bodyapplication/json

Example

{
    "availability_check": {
        "availability_status": "high_probability",
        "likelihood": 90
    }
}

🟠404Record Not Found

🟠400Bad Request

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

WebHook

Full Availability Check