Australia Citizens

4 min

Data Zoo’s proprietary opt-in permission based marketing database.

For Authorization Get Session Token from Authentication page.

Australia Citizens

* Verification Outcome – Returns KYC verification * Consumer Consent – N/A * Mandatory Input – Name and (DOB or Address) * Verifies – Name, DOB, Address, Phone number and Email * Returned Data - metrix used for address matching logic, identity of the data source

POST

https://idu-test.datazoo.com/api/v2/verify

Header Parameters

Authorizationstringrequired
Description
sessionToken obtained via the Authentication call

Body Parameters

dataobjectrequired
Description
request body sent to the API
- countryCodestringrequired
  Description
  AU
- servicearrayrequired
  Description
  Australia Citizens
- clientReferencestring
  Description
  a client reference field
- firstNamestringrequired
  Description
  the first name of the identity owner
- middleNamestring
  Description
  the middle name(s) of the identity owner
- lastNamestringrequired
  Description
  the last name of the identity owner
- genderstring
  Description
  Male or Female
- dateOfBirthstringrequired
  Description
  in YYYY-MM-DD (preferred) or DD-MM-YYYY format * [conditional optional - See note below]
- addressElement1stringrequired
  Description
  the street level address of the identity owner * [conditional optional - See note below]
- addressElement3string
  Description
  the suburb address of the identity owner
- addressElement4string
  Description
  the state address of the identity owner
- addressElement5stringrequired
  Description
  the postcode of the address of the identity owner * [conditional optional - See note below]
- identityVariablesobject
  Description
  other elements for verification
  - phoneNostring
    Description
    mobile phone number of the identity owner
  - landlineNostring
    Description
    landline phone number of the identity owner
  - emailstring
    Description
    email address of the identity owner

Response

countryCodestring
Description
Australia
clientReferencestring
Description
the client reference (if given as input)
reportingReferencestring
Description
a reference number generated which is unique to each transaction.
validationErrorsstring
Description
Returned with HTTP status code 400 when the request contains invalid or improperly formatted input data.
matchStatusstring
Description
"Full Match 1+1 Verification" "No Match"
searchErrorMessagestring
Description
"" error message returned querying the data source
safeHarbourboolean
Description
true or false
searchStatusstring
Description
"Successful" "Not Successful"
serviceResponsesobject
Description
Verification Details with "Australia Citizens" returned as the Service Identifier.
- statusinteger
  Description
  0 - identityVerified TRUE - element verifications all TRUE 1 - identityVerified TRUE - element verifications not all TRUE 2 - identityVerified FALSE - sourceStatus SUCCESSFUL 3 - identityVerified FALSE - sourceStatus NOT SUCCESSFUL
- sourceStatusstring
  Description
  "Successful" "Unsuccessful"
- errorMessagestring
  Description
  "" error message(s) from the data source. Example, "Error querying data source".
- identityVerifiedboolean
  Description
  true or false
- safeHarbourScorestring
  Description
  M1, M2 or N1 * For more information, refer to Safe Harbour Scores page
- nameMatchScorestring
  Description
  A string that acts as a value between 0.000 and 1.000.
- addressMatchScorestring
  Description
  A string that acts as a value between 0.000 and 1.000.
- verificationsobject
  Description
  element level verification returned as true or false [Only applicable elements will be included, and not all elements may be present]
  - addressElement1boolean
  - addressElement3boolean
  - addressElement4boolean
  - addressElement5boolean
  - dateOfBirthboolean
  - emailboolean
  - firstNameboolean
  - genderboolean
  - landlineNoboolean
  - lastNameboolean
  - middleNameboolean
  - phoneNoboolean
- returnedDataobject
  Description
  returns additional data from the data source.
  - altAddressMatchScorestring
    Description
    metrix used for address matching logic
  - altNameMatchScorestring
    Description
    metrix used for name matching logic
  - dpIdstring
    Description
    Delivery Point Identifier of the address
  - sourcestring
    Description
    identifies the data source used
remarksarray
Description
will return remarks regarding any encountered issues or pre-validation errors.

curl

curl --location 'https://idu-test.datazoo.com/api/v2/verify' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data-raw '{
    "countryCode": "AU",
    "service": [
        "Australia Citizens"
    ],
    "clientReference": "Test_0001",
    "firstName": "Aloysius",
    "middleName": "Jefferson",
    "lastName": "Pasco",
    "dateOfBirth": "1946-11-01",
    "addressElement1": "30 Plane Tree Green",
    "addressElement3": "Forrestfield",
    "addressElement4": "WA",
    "addressElement5": "6058",
    "identityVariables": {
        "phoneNo": "0487787402",
        "landlineNo": "0734086754",
        "email": "[email protected]"
    }
}
'

200

{
    "countryCode": "Australia",
    "clientReference": "Test_0001",
    "reportingReference": "DZ-88560fc7-686a-45f5-a29c-d1f667580850",
    "matchStatus": "Full Match 1+1 Verification",
    "searchErrorMessage": "",
    "safeHarbour": false,
    "searchStatus": "Successful",
    "serviceResponses": {
        "Australia Citizens": {
            "status": 1,
            "sourceStatus": "Successful",
            "errorMessage": "",
            "identityVerified": true,
            "safeHarbourScore": "N1",
            "nameMatchScore": "1.000",
            "addressMatchScore": "1.000",
            "verifications": {
                "addressElement1": true,
                "addressElement3": true,
                "addressElement4": true,
                "addressElement5": true,
                "email": true,
                "firstName": true,
                "landlineNo": false,
                "lastName": true,
                "phoneNo": true
            },
            "returnedData": {
                "altAddressMatchScore": "0",
                "altNameMatchScore": "A1",
                "dpId": "63233056",
                "source": "DZ1"
            }
        }
    },
    "remarks": []
}

404

{
  "message": "Ain't no cake like that."
}

Mandatory input for Date of Birth and Address

Date of Birth and Address input are Required based on criteria:

Either dateOfBirth or street address with postcode must be provided (addressElement1 and addressElement5) as input.

Links

About Safe Harbour Scores

Change History

Added

Last updated - 10 March, 2025