Bulk Address Validation

GetToken

The Bulk Address Validation API is additionally secured requiring the use of Token which can be generated using GetToken API. The token received from the GetToken API must be used to invoke FileUpload, FileStatus and FileDownload APIs.

The token expires in 3600 seconds, therefore a new token must be generated each time the token expires.

The GetToken should not be used in client-side scripting such as Javascript on webpages. It is meant to be used by a system where in no end-user has access to the identity credentials provided by ADDRESSER.

https://api.addresser.com.au/gettoken

Request Body: JSON

{
    "username": "your_username",
    "password": "your_password"
}
                  

Success Response

{
    "statusCode": 200,
    "statusMessage": "Token generated successfully",
    "token": "your_generated_token"
}
                  

Response Specification

File Upload

The File Upload API to be used for submitting CSV file for bulk address validation processing. The CSV file must be provided in a specific format which is explained in the "Request Body: Form-data" sub-section of this document.

NOTE: ADDRESSER prefixes every file with date and time stamp to ensure uniqueness which is returned back in the File Upload API response. Subsequent API operations on the file must use the file name returned by the File Uplaod API.

https://api.addresser.com.au/bulkverifyupload

Request Headers

Success Response

{
    "statusCode": 200,
    "statusMessage": "File uploaded successfully",
    "filename": "2024-03-01 02:00:04-yourfilename.csv"
}
                  

Token Error Responses

{
    "message": "Unauthorized"
}

{
    "message": "The incoming token has expired"
}

Response Specification

File Status

The File Status API to be used for retrieving the status of the files uploaded to ADDRESSER for bulk address validation. The API provides two ways of retrieving the file status. The first way is to retrieve the status of all files submitted so far, and the second way is to query the status of a specific file.

NOTE: ADDRESSER prefixes every file with date and time stamp to ensure uniqueness which is returned back in the File Upload API response. Subsequent API operations on the file must use the file name returned by the File Uplaod API.

https://api.addresser.com.au/bulkverifystatus

Request Headers

Request Body: JSON

(List all files)

{
    "unique-subscriber-id": "your_unique_subscriber_id"
}
                  

(Specific file)

{
    "unique-subscriber-id": "your_unique_subscriber_id",
    "filename": "yourfilename.csv"
}
                  

Success Response

{
    "body": [
        {
            "items": [
                {
                    "batch_started_at": "2024-03-01 02:00:12",
                    "filename": "2024-03-01 02:00:04-yourfilename.csv",
                    "file_downloaded_timestamp": "",
                    "records_failed": 2,
                    "report_filename": "2024-03-01 02:00:04-yourfilename.pdf",
                    "batch_status": "completed",
                    "number_of_records": 17,
                    "quota_used": 0,
                    "records_succeeded": 15,
                    "failed_reason": "None",
                    "uploaded_timestamp": "2024-03-01 02:00:04"
                }
            ],
            "unique-subscriber-id": "****-****-****-019d1****"
        }
    ],
    "statusCode": 200,
    "response": "success"
}
                  

Token Error Responses

{
    "message": "Unauthorized"
}

{
    "message": "The incoming token has expired"
}

Response Specification

File Download

The File Download API to be used for downloading processed file submitted to ADDRESSER for bulk address validation. Please note only files with the status "Completed" are available for download.

NOTE: ADDRESSER prefixes every file with date and time stamp to ensure uniqueness which is returned back in the File Upload API response. Subsequent API operations on the file must use the file name returned by the File Uplaod API.

https://api.addresser.com.au/bulkverifyfiledownload?unique_sub=****-8157-538ce****&file=2024-03-07 07:56:14-somefile.csv

Request Headers

Request Parameters

Success Response

The file will be downloaded in its original CSV format.

Token Error Responses

{
    "message": "Unauthorized"
}

{
    "message": "The incoming token has expired"
}

Response Specification