API Documentation

Public RESTful API for checkify.com.au

The Checkify APIs are organized around REST. Our APIs have predictable resource-oriented URLs, accept form-encoded requests, return JSON-encoded responses and uses standard HTTP response codes. Checkify API endpoints will remain constant and no existing implementations will be broken if a new version is released.

Phone Numbers

Given an internationally formated phone number, the endpoint semantically validates the input and verifies the accuracy of the data, returning an array of data, including but not limited to phone line type, carrier details and country specific phone format.

cURLPOSTcurl 'https://checkify.com.au/api/v1/phone' \
-H 'X-Auth-ES: RoMiEGESW4doADManJjVTcPtUV5BC9tGscCTQhAHglgWw2AEwOniu74bMPnG' \
--data 'phoneQuery=%2B61444444444'

Success json response

{
    "status": "success",
    "response": {
        "lookup": "success",
        "phone": "+614444444444",
        "carrier": "Vodafone Australia Pty Ltd",
        "type": "mobile",
        "country": "AU",
        "formatted": "4444 444 444"
    }
}

Postal Addresses

Given a partial or complete Australian address, the endpoint semantically validates the input and verifies the accuracy of the data, returning an array of the 10 closest matching postal addresses, including but not limited to unit, street type, suffixes and prefixes if any, longitude and latitude.

cURLPOSTcurl 'https://checkify.com.au/api/v1/address' \
-H 'X-Auth-ES: RoMiEGESW4doADManJjVTcPtUV5BC9tGscCTQhAHglgWw2AEwOniu74bMPnG' \
--data 'addressQuery=20+Welch+Street'

Success json response

{
    "status": "success",
    "response": [
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": null,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "FAWKNER",
            "state": "VIC",
            "postCode": "3060",
            "location": {
                "lat": -37.6992221,
                "lon": 144.96220219
            },
            "streetAddress": "20 WELCH STREET, FAWKNER VIC 3060"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": null,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "CLONTARF",
            "state": "QLD",
            "postCode": "4019",
            "location": {
                "lat": -27.24522914,
                "lon": 153.09318226
            },
            "streetAddress": "20 WELCH STREET, CLONTARF QLD 4019"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": null,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "20 WELCH STREET, SOUTHPORT QLD 4215"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": null,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "ELLIOTT HEADS",
            "state": "QLD",
            "postCode": "4670",
            "location": {
                "lat": -24.91688268,
                "lon": 152.49086664
            },
            "streetAddress": "20 WELCH STREET, ELLIOTT HEADS QLD 4670"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": 1,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "UNIT 1, 20 WELCH STREET, SOUTHPORT QLD 4215"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": 6,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "UNIT 6, 20 WELCH STREET, SOUTHPORT QLD 4215"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": 2,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "UNIT 2, 20 WELCH STREET, SOUTHPORT QLD 4215"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": 3,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "UNIT 3, 20 WELCH STREET, SOUTHPORT QLD 4215"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": 5,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "UNIT 5, 20 WELCH STREET, SOUTHPORT QLD 4215"
        },
        {
            "buildingName": null,
            "flatNumberPrefix": null,
            "flatNumber": 4,
            "flatNumberSuffix": null,
            "levelNumber": null,
            "numberFirst": 20,
            "numberFirstPrefix": null,
            "numberFirstSuffix": null,
            "numberLast": null,
            "numberLastPrefix": null,
            "numberLastSuffix": null,
            "streetName": "WELCH",
            "streetType": "STREET",
            "streetSuffixCode": null,
            "suburb": "SOUTHPORT",
            "state": "QLD",
            "postCode": "4215",
            "location": {
                "lat": -27.96463689,
                "lon": 153.41325265
            },
            "streetAddress": "UNIT 4, 20 WELCH STREET, SOUTHPORT QLD 4215"
        }
    ]
}

Email Addresses

Given an email address, the endpoint semantically validates the input and verifies the accuracy of the data, returning an array with the existing MX servers and the deliverability status of the account.

cURLPOSTcurl 'https://checkify.com.au/api/v1/email' \
-H 'X-Auth-ES: RoMiEGESW4doADManJjVTcPtUV5BC9tGscCTQhAHglgWw2AEwOniu74bMPnG' \
--data 'emailQuery=accounts%40domain.com.au'

Success json response

{
    "status": "success",
    "response": {
        "address": "account@domain.com.au",
        "syntaxCheck": true,
        "mxCheck": true,
        "smtpCheck": false,
        "account": "account",
        "domain": "domain.com.au",
        "disposable": false,
        "free": false
    }
}

Australian Business Numbers

Given an Australian Business Number, the endpoint semantically validates the input and verifies the accuracy of the data, returning an array of publicly available records including but not limited to name, ACN if any, organisation status, entity type, state and postcode.

cURLPOSTcurl 'https://checkify.com.au/api/v1/abn' \
-H 'X-Auth-ES: RoMiEGESW4doADManJjVTcPtUV5BC9tGscCTQhAHglgWw2AEwOniu74bMPnG' \
--data 'abnQuery=12345678912'

Success json response

{
    "status": "success",
    "response": {
        "name": "SOME COMPANY NAME PTY. LTD.",
        "abn": "12345678912",
        "acn": "123456789",
        "statusCode": "Active",
        "statusFrom": "2000-01-01",
        "typeCode": "PRV",
        "typeDescription": "Australian Private Company",
        "address": {
            "state": "QLD",
            "postcode": "4215"
        }
    }
}

Australian Company Numbers

Given an Australian Company Number, the endpoint semantically validates the input and verifies the accuracy of the data, returning an array of publicly available records including but not limited to name, class, subclass, addresses, organisation status and lodged documents.

cURLPOSTcurl 'https://checkify.com.au/api/v1/acn' \
-H 'X-Auth-ES: RoMiEGESW4doADManJjVTcPtUV5BC9tGscCTQhAHglgWw2AEwOniu74bMPnG' \
--data 'acnQuery=123456789'

Success json response

{
    "status": "success",
    "response": {
        "name": "SOME COMPANY NAME PTY. LTD.",
        "acn": 123456789,
        "type": "APTY",
        "typeDescription": "Australian Proprietary Company",
        "class": "LMSH",
        "classDescription": "Limited By Shares",
        "subclass": "PROP",
        "subclassDescription": "Proprietary Company",
        "incorporationState": "QLD",
        "status": "REGD",
        "statusDescription": "Registered",
        "dateRegistered": "2000-01-01",
        "addresses": [
            {
                "type": "Registered Office",
                "suburb": "SOUTHPORT",
                "postcode": "4215",
                "state": "QLD"
            },
            {
                "type": "Principal Place of business",
                "suburb": "SOUTHPORT",
                "postcode": "4215",
                "state": "QLD"
            }
        ],
        "documents": [
            {
                "documentNumber": "7EAN99999",
                "dateReceived": "2000-01-01",
                "formCode": "484",
                "numberOfPages": 2,
                "description": "CHANGE TO COMPANY DETAILS",
                "additionalDescription": {
                    "subformCode": "484A2",
                    "subformDescription": "CHANGE MEMBER NAME OR ADDRESS"
                }
            },
            {
                "documentNumber": "7EAL88888",
                "dateReceived": "2000-01-01",
                "formCode": "484",
                "numberOfPages": 2,
                "description": "CHANGE TO COMPANY DETAILS",
                "additionalDescription": [
                    {
                        "subformCode": "484E",
                        "subformDescription": "APPOINTMENT OR CESSATION OF A COMPANY OFFICEHOLDER"
                    },
                    {
                        "subformCode": "484A1",
                        "subformDescription": "CHANGE OFFICEHOLDER NAME OR ADDRESS"
                    }
                ]
            },
        ]
    }
}

Reverse Geocode

Given longitude and latitude coordinates, the endpoint semantically validates the input and verifies the accuracy of the data, returning the nearest valid postal address, including but not limited to street type, suffixes and prefixes if any.

cURLPOSTcurl 'https://checkify.com.au/api/v1/geocode' \
-H 'X-Auth-ES: RoMiEGESW4doADManJjVTcPtUV5BC9tGscCTQhAHglgWw2AEwOniu74bMPnG' \
--data 'geocodeQuery[lat]=-27.96463689&geocodeQuery[lon]=153.41325265'

Success json response

{
    "status": "success",
    "distanceInMetres": 15.169104887040767,
    "response": {
        "buildingName": null,
        "numberFirst": 20,
        "numberFirstPrefix": null,
        "numberFirstSuffix": null,
        "numberLast": null,
        "numberLastPrefix": null,
        "numberLastSuffix": null,
        "streetName": "WELCH",
        "streetType": "STREET",
        "streetSuffixCode": null,
        "suburb": "SOUTHPORT",
        "state": "QLD",
        "postCode": "4215",
        "location": {
            "lat": -27.96463689,
            "lon": 153.41325265
        },
        "streetAddress": "20 WELCH STREET, SOUTHPORT QLD 4215"
    }
}

API Documentation

Public RESTful API for checkify.com.au

Phone Numbers

Postal Addresses

Email Addresses

Australian Business Numbers

Australian Company Numbers

Reverse Geocode

Data Quality API Solutions