Global Data
Browse endpoints
View as Markdown OpenAPI spec

Payroll Check

POST /api/v2/payroll_check operationId: payroll_check

Live: https://gdapi.globaldata.net.au/api/v2/payroll_check · Sandbox: https://sandbox-gdapi.globaldata.net.au/api/v2/payroll_check

Validates a person's details against payroll records.

Minimum search requirements

In order to perform a valid lookup, a minimum of the following fields are required:

  • first_name
  • last_name
  • birth_date
  • consent

The response will indicate if the provided fields are either MATCHED or UNMATCHED against the payroll records.

Sandbox environment

When simulating queries in the sandbox environment, the following records will return a match:

First Name Middle Name Last Name Birth Date Address Email Telephone Employer ABN
John James Doe 1990-01-01 4/123 Fake St, Fakeville Vic 3987 john@example.com 0400123456 12345678901
Jane Karen Smith 1995-02-18 456 Wrong Ave, Sampleville NSW 2785 jane@example.com 0412345678 98765432109

Note: If the first name is service and the last name is unavailable, the match will return a 503 error - Third Party Unavailable.

Request body

Content type application/json. The details of the person to validate

FieldDescription
first_name string

The first name of the individual

Example: John
middle_name string

The middle name of the individual

Example: James
last_name string

The last name of the individual

Example: Doe
birth_date string (date)

The date of birth of the individual

Example: 1990-01-01
address object

The address of the individual
address.street_address string

The street line of the address

Example: 4/123 Fake Street
address.suburb string

The suburb of the address

Example: Fakeville
address.state string

The state of the address

Enum: NSW, VIC, QLD, SA, WA, TAS, NT, ACT

Example: VIC
address.postcode string

The postcode of the address

Example: 3987
email string

The email address of the individual

Example: john@example.com
phone string

The phone number of the individual in 0NSN format

Example: 0400123456
employer_abn string

The ABN of the employer

Example: 12345678901
consent boolean

The individual's consent to search payroll records

Example: true

Responses

200

Result of the validation check

application/json
FieldDescription
message string

A message indicating the result of the request. This will be Ok if the request was successful.

Example: Ok
api_reference string (uuid)

A unique identifier for this request. This can be used to track the request in the logs.

Example: fe4291ca-d831-4760-96df-c9cb03b3cd95
match_results object

The result of the payroll check
match_results.person string

The result of matching the first name, last name and birth date.

Enum: MATCHED, UNMATCHED

Example: MATCHED
match_results.middle_name string

The result of matching the middle name

Enum: MATCHED, UNMATCHED

Example: MATCHED
match_results.address string

The result of matching the address

Enum: MATCHED, UNMATCHED

Example: MATCHED
match_results.email string

The result of matching the email

Enum: MATCHED, UNMATCHED

Example: MATCHED
match_results.phone string

The result of matching the phone number

Enum: MATCHED, UNMATCHED

Example: MATCHED
match_results.employer_abn string

The result of matching the employer ABN

Enum: MATCHED, UNMATCHED

Example: MATCHED
Standard error responses: 400 401 402 403 429 5XX See common error responses
Previous NZ Driver Licence Check Next Super Check