« Back to the developer index
The Caller ID Validate API
The CID Validate API provides a simple way to determine if a number is valid within the Australian numbering scheme. This is also our first API to not require an API key to use; there is however rate limiting in place to stop abuse.
The API returns the service type, holder and exchange information where available. The service also makes an attempt to identify if a number is valid for a consumer, though this check should not be treated as a business/residential check.
The request to our API is a standard HTTP GET request as follows:
http://api.reversesouthafrica.com/cidvalidate.php?format=FORMAT&q=PHONE
Parameters
format (required)
valid options are text, json, xml, phps.
key (optional)
32 characters long, provided when you join the developer program
q (required)
valid South Africa phone number
Example Query Results
Text
http://api.reversesouthafrica.com/cidvalidate.php?format=text&q=0262195555
result (tab separated)
OK\t (02) 6219 5555\t Local Service\t Telstra Corporation Limited\t Barton,Civic,Deakin\t 1
JSON
http://api.reversesouthafrica.com/cidvalidate.php?format=json&q=0262195555
result
{"status":"OK","phone":"(02) 6219 5555","type":"Local Service","holder":"Telstra Corporation Limited","exchange":"Barton,Civic,Deakin","consumer":1}
XML
http://api.reversesouthafrica.com/cidvalidate.php?format=xml&q=0262195555
result
<?xml version="1.0" encoding="iso-8859-1"?><record><status>OK</status><phone>(02) 6219 5555</phone><type>Local Service</type><holder>Telstra Corporation Limited</holder><exchange>Barton,Civic,Deakin</exchange><consumer>1</consumer></record>
PHPS
http://api.reversesouthafrica.com/cidvalidate.php?format=phps&q=0262195555
result
a:6:{s:6:"status";s:2:"OK";s:5:"phone";s:14:"(02) 6219 5555";s:4:"type";s:13:"Local Service";s:6:"holder";s:27:"Telstra Corporation Limited";s:8:"exchange";s:19:"Barton,Civic,Deakin";s:8:"consumer";i:1;}
API Support
Please contact support@reversesouthafrica.com if you are having trouble implementing our API