Overview

ProbityPeople API is a REST/JSON based API.

Prerequisite

• Must have a registered business account
• The account must have been approved for a business monthly account.

What you can do with ProbityPeople API?

• Get the list of all the available checks on the ProbityPeople system
• Create a new check order
• Get the list of the orders
• Get order details and check the order status
• Download the check certificate if available

Setup

📘

Quick highlights

If you already have a deep understanding of APIs or need a brief review of Asana's API, you may wish to skip ahead to the quick highlights of this guide below:

• The ProbityPeople API is a RESTful interface with predictable resource-oriented URLs, accepts JSON requests, returns JSON, and uses standard HTTP features (verbs, response codes, etc.)
• To quickly authorize your API requests, create an API token via the API setting page in your ProbityPeople business portal.
• API endpoints are relative to the following base URL: https://portal.probitypeople.com.au/api/{version_number}/

Rate limit

To protect the stability of the API and keep it available to all users, ProbityPeople enforces an hourly rate limit. Requests that hit any of our rate limits will receive a 429 Too Many Requests response.

Limits are allocated on a user basis regardless of how many authorization tokens the user has. If a user has multiple tokens, the combined request count of all the available tokens contributes towards the limit.

Example response

HTTP/1.1 429 Too Many Requests
Content-Type: application/json
{
  "error": "Too Many Requests"
}