Full Availability Check

Returns a definitive availability status (Confirmed/Unavailable), along with any available employment data we can provide for the consumer. Requires National Registration Number for the consumer.

Ensure you have captured the requsite consent from the consumer before calling this API.

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:check-Determine if the consumer is available to pay by Ontime.

Body Params application/json

Examples

curl --location --request POST 'https://mock.apidog.com/m1/828215-0-default/availability/' \ --header 'x-api-key: <api-key>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "availability_check": { "national_registration_number": "QQ999999A", "date_of_birth": "1962-07-04", "given_name": "Ida", "family_name": "Jerde", "email_address": "Marianna_Tillman67@example.org", "phone_number": "+13343564975", "postal_code": "GU12AA", "currency": "GTQ" } }'

{ "availability_check": { "national_registration_number": "37", "availability_status": "Available", "tenure": 288, "industry": "labore laborum et amet commodo", "contract_type": "PartTime", "annualised_pay": 432100, "recommended_due_date": 23, "request_id": "5a5e5205-9ea2-4d5d-9c99-c842a0811453", "currency": "XPF" } }

Full Availability Check

Request

Responses