Documentation-V2 | Addresser

Phone Validation

API Documentation

Introduction

Validate whether a number is connected and is able to be contacted.

The API takes an phone number and validates it for validity, connected or not.

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

Example Usage

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

Request Headers

Field	Type	Description
x-api-key	String	Your API key. You can access API Key after registering for valid subscription, via the "My Credentials" section after logging into the "My Addresser" portal.

Request Body

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

Body (Content-type: json)

 
{
    "number": "61400000000"
}

Response

The success response from the API consists of two attributes as listed in the example extract below.

200 Success Response Structure


{
"id": "7e86020219001324d67d1007e083ba90cc21923570eb041c7af618cd8a51e75f",
"status": "OK"
}

API Errors

{
"errorCode": xxxx,
"errorMessage": "xxx"
}

Error Code	Description	Resolution
4076	API key is missing or invalid.	Check the API Key, you can get the correct API Key from the "Credentials" section of "My Addresser" portal.
4077	Invalid Method or API URL.	You have used an incorrect URL. Check the URL from the API documentation.
4080	You have exceeded the allowed API calls.	You have reached the maximum limit of API calls on your current plan. You can choose to add additional quota via Pricing page of the Addresser website.

Below example error code and message.

              {
                "errorCode": 4076,
                "errorMessage": "API key is missing or invalid."
              }

Response Specification

Field	Type	Description	Example
id	String	This attribute indicates whether the email address is from a disposable email provider. false means the email address is not disposable, suggesting it is likely to be a more permanent and legitimate address.	false
status	String	Status indicating success of the submitting the phone number for validating with the network.	false

Get Validation Status

API Documentation

Introduction

Retrieve information about the validated phone number status.

The API takes id of a previous number validation request to return corresponding phone number details.

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

Example Usage

https://api.addresser.com.au/getphonestatus?id=7xxxxxxxxx237cd8b9e481be527ac9vvvvvvvvvb5f4d70000d4c351dba86ff4d4

Request Headers

Field	Type	Description
x-api-key	String	Your API key. You can access API Key after registering for valid subscription, via the "My Credentials" section after logging into the "My Addresser" portal.

Parameter

Field	Type	Description
id	String	The id of the previous number validation request.

Request Body

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

Response

The success response from the API consists of the following attributes as listed in the example extract below.

200 Success Response Structure


{
    "validations": [
        {
            "id": "7e8602020a237cd8b9e481be527ac9c8ac95681b5f4d7483d4c351dba86ff4d4",
            "number": "61400000000",
            "content": "Connected 505-03 (Vodafone)",
            "hlrError": "NO_ERROR",
            "receipts": {
                "connected": "2024-07-02T02:10:59.923Z"
            },
            "created": "2024-07-02T02:10:58.162Z",
            "updated": "2024-07-02T02:10:59.923Z"
        }
    ],
    "status": "OK"
}

API Errors

{
"errorCode": xxxx,
"errorMessage": "xxx"
}

Error Code	Description	Resolution
4076	API key is missing or invalid.	Check the API Key, you can get the correct API Key from the "Credentials" section of "My Addresser" portal.
4077	Invalid Method or API URL.	You have used an incorrect URL. Check the URL from the API documentation.
4080	You have exceeded the allowed API calls.	You have reached the maximum limit of API calls on your current plan. You can choose to add additional quota via Pricing page of the Addresser website.

Below example error code and message.

              {
                "errorCode": 4076,
                "errorMessage": "API key is missing or invalid."
              }

Response Specification

Field	Type	Description	Example
status	String	Indicates whether the request succeeded or failed.	OK
id	String	The id of the previous number validation request.	7e5b0ddddddddc2e2cd3950fb54tttttttt2b6038bf1362eeeeece02033620a8
content	String	how connected or not message.	Connected 505-03 (Vodafone). This attribute is absent when the result is pending.
receipts/connected	String	Date and time when the validation was performed.	2021-12-07T12:09:24.214Z. This attribute is absent when the result is pending.
number	String	The phone number being validated.	61400000000. This attribute is absent when the result is pending.
created	String	Date and time when the validation record was generated.	2021-12-07T12:09:20.277Z