Light Availability Check

POST

/deductions/availability/light

OperationId:post_light_availability_check

Find out if a Consumer can be found within a Payroll managed by the Payroll Provider without needing the Consumer's National Registration Number.

Request

Body Params application/json

Example

{
    "availability_check": {
        "employer_name": "Emp. Co Limited",
        "date_of_birth": "1969-05-19",
        "given_name": "Alice",
        "family_name": "Smith",
        "email_address": "alice.smith@example.org",
        "phone_number": "+44 123456789",
        "postal_code": "GU12AA",
        "currency": "GBP"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/deductions/availability/light' \
--header 'Content-Type: application/json' \
--data-raw '{
    "availability_check": {
        "employer_name": "Emp. Co Limited",
        "date_of_birth": "1969-05-19",
        "given_name": "Alice",
        "family_name": "Smith",
        "email_address": "alice.smith@example.org",
        "phone_number": "+44 123456789",
        "postal_code": "GU12AA",
        "currency": "GBP"
    }
}'

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": {
        "status": "high_probability",
        "likelihood": 9
    }
}

🟠404Record Not Found

🟠400Bad Request

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

Salary Deduction Confirmation Submission

Full Availability Check