API Queries - Add contact
The Add contact API function add a new contact. You cannot create multiple contacts with same contact details.
Additional Parameters
- name Contact name.
- company Contact company.
- email Contact email address.
- phone Contact phone number, area code included in xx.xxxxxxxx format.
- address Contact address.
- city Contact city.
- state Contact state.
- postcode Contact postcode.
- country Contact country code, in two leter format (AU, US, etc.).
- eu_tld Contact is for european cctlds (Y, N).
- citizen_country Contact citizenship country, this is needed for european cctlds and only needed if not same as Contact's country above.
- au_tld Contact is for australian cctlds (Y, N). Following eligibiliy details are needed for australian cctlds.
- registrant_name AU Contact registrant name.
- eligibility_type AU Contact eligibility type (company, trademark, sole trader, etc.).
- registrant_id_type AU Contact registrant id type (ABN, ACN, TM).
- registrant_id AU Contact registrant id.
- eligibility_id_type AU Contact eligibility id type (ABN, ACN, TM).
- eligibility_id AU Contact eligibility id.
Your API key is required and all values should be correctly URL encoded.
Example 1
In the below example, we will add a new contact. There are various errors that could be returned and need to be handled by your custom application such as Contact with same detail exist.
Query
https://www.above.com/registrar/api/query.html?query=add_contact&name=test contact&company=test company&email=test@trillion.com&phone=61.123456789&address=test&city=city&state=state&postcode=3000&country=AU
Use Registrar API key in place of {BEARER_TOKEN}
Response
<results code="100"> <contacts> <r contact="10208"> <id>10208</id> <contact_identifier>725877_496727</contact_identifier> <name>test contact</name> <company>test company</company> <email>test@trillion.com</email> <phone>61.123456789</phone> <fax/> <address>test</address> <address2/> <city>city</city> <state>state</state> <postcode>3000</postcode> <country>AU</country> <verified>f</verified> <created>2025-12-09 13:46:23.812132</created> <last_verifed_email_sent>2025-12-09 13:46:23.960156</last_verifed_email_sent> <updated_date>2025-12-09 13:46:23</updated_date> <contact_alias>725877_496727</contact_alias> </r> </contacts> </results>
Example 2
In the below example, we will add a new AU / EU contact. There are various errors that could be returned and need to be handled by your custom application such as Contact with same detail exist.
Query
https://www.above.com/registrar/api/query.html?query=add_contact&name=test au contact&company=test company&email=test@trillion.com&phone=61.123456789&address=test&city=city&state=state&postcode=3000&country=AU&au_tld=Y®istrant_name=test registrant&eligibility_type=company®istrant_id_type=ABN®istrant_id=123456&eu_tld=Y&citizen_country=US
Use Registrar API key in place of {BEARER_TOKEN}
Response
<results code="100"> <contacts> <r contact="10213"> <id>10213</id> <contact_identifier>725877_400583</contact_identifier> <name>test au contact</name> <company>test company</company> <email>test@trillion.com</email> <phone>61.123456789</phone> <fax/> <address>test</address> <address2/> <city>city</city> <state>state</state> <postcode>3000</postcode> <country>AU</country> <verified>f</verified> <created>2025-12-09 13:46:23.812132</created> <last_verifed_email_sent>2025-12-09 13:46:23.960156</last_verifed_email_sent> <updated_date>2025-12-09 13:46:23</updated_date> <contact_alias>725877_496727</contact_alias> <countryofcitizenship>US</countryofcitizenship> <citizenshipflag>t</citizenshipflag> <registrant_name>test registrant</registrant_name> <registrant_id_type>ABN</registrant_id_type> <registrant_id>123456</registrant_id> <eligibility_type>Company</eligibility_type> <eligibility_name/> <eligibility_id_type/> <eligibility_id/> <approved>Y</approved> <elig_status/> <elig_error_reason/> </r> </contacts> </results>
Error Codes
Possible error responses for this function are:
- 3006 - Contact with same detail exist
- 3007 - Add contact failed
- 3008 - Disallowed email address
- 3009 - Add contact failed at eligibility
- General errors, such as 401 - Invalid API key or 500 - System unavailable.
