Police Checks API
Police checks are managed via the Consumer API.
This API uses HTTPS for transport and JSON for incoming/outgoing data encoding. Access to the api is via the comain api.nationalcrimecheck.com.au and you also need to specify the api and version which is in the first path of the url. See also the general endpoints information in the reference docs.
1. The integration starts a new check
This uses the create check endpoint which contains a minimum dataset of the check being started.
POST https://api.nationalcrimecheck.com.au/consumer_v1.5/checks/create
{
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"type": "EMPLOYMENT",
"healthcare": "NONE",
"reason": "Computer programmer"
}
The return value of this endpoint includes a field called the continue url. This link needs to be sent to your candidate via email or sms.
{
"id": 11111,
"continue_url": "http://example.com/continue/11111/AAAAAA"
}
A configuration option is available for NCC to send the welcome email on your behalf. Contact your account manager if you would like this enabled.
2. The candidate visits the continue url
When the visit the url, they will go through the various steps of the candidate workflow. The experience is branded with your logo. The steps of this process are essentially the same as the retail police check experience.
Some steps in the experience will vary depending on your configuration, for example the payment step may be skipped if your site is configured for monthly invoicing.
3. The candidate undertakes identity verification
This process may involve some back-and-forth between the candidate and our verification staff.
4. The candidate is lodged
The candidate will be lodged with ACIC for processing. This can take between one hour and several days, depending on a number of factors.
5. The result is returned
The result is returned from ACIC and is dispatched in accordance with the settings of the co-branded site, as well as the result webhooks
Dispatch includes:
- the co-branded dispatch emails
- the api key dispatch email
- the result webhook provided on the check
- any result webhooks configured in the integ-dash
6. The result can be fetched using the API
The result is now available, and can be fetched in a number of ways.
To directly access the PDF data via the api, use the download result endpoint.
If you'd like to present the result in a browser, then you should instead use the result url which is provided in both the webhook payload, and also the get check endpoint.