Light Availability Check

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

POST

/availability/light

OperationId:light_availability_check

Find out if a consumer is eligible to make payments via Salary Deduction without requiring their National Registration Number. The more consumer data points provided, the higher chance Ontime has of achieving a high probability match.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

availability:light_check-Determine if the consumer is available to pay by Ontime.

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://mock.apidog.com/m1/828215-0-default/availability/light' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "availability_check": {
        "date_of_birth": "1989-09-05",
        "given_name": "Shaina",
        "family_name": "Brakus",
        "postal_code": "GU12AA"
    }
}'

Response Example

{
    "availability_check": {
        "availability_status": "HighProbability",
        "request_id": "d83868c4-e98b-4aa9-8d30-bc321fb94454",
        "likelihood": 90
    }
}

Availability Check

Full Availability Check