Brandsight API (1.0.0)

API Key and Secret

Your API Key and Secret are used to authenticate every request to the Brandsight Domain API. You can create them yourself in Brandsight:

1. Go to Settings > API and click Enable API access if you have the appropriate access.
2. Choose a role: Read-Only to view data only, or Write for full access to manage your domains.
3. Copy your API Key and Secret and save them somewhere secure. Your Secret is shown only once.

If you lose your credentials, you can regenerate them from the same page using Regenerate key & secret. Your account can have one active key at a time, so a new key replaces the old one. These credentials are for Production. For OT&E (test) access, please contact your Client Success Manager.

Domain Availability

To check the availability and price for specific domain names:

• Check if a domain name is available using the single domain availability endpoint.
  Note: SPEED checks do not connect to registry and are local checks to determine the outcome of the availability calls whereas ACCURACY checks connects to the registry, are more reliable and are recommended.

• Check if a list of domain names is available using the bulk domains availability endpoint.

Domain Registration

To register an available domain name:

1. Different TLDs require different payloads to be able to register a schema. Retrieve the Registration Schema for a specific TLD using the register schema endpoint and passing the tld. For example, send com to get the schema required for a .com registration.

2. Validate the registration payload using the validation endpoint.

3. Once the payload is validated, request to register the domain name using the register endpoint.

4. Check status of the registration request using the actions endpoint and passing the type value as REGISTER.

Domain Renewal

To renew a managed domain name for a specified period:

1. Retrieve the price for your specified registration term using the single domain availability endpoint and passing the type to RENEWAL and specifying the period in years.

2. Include the exact amounts retrieved previously to renew an active domain name using renew endpoint.

3. Check status of the renewal request using the actions endpoint and passing the type value as RENEW.

Domain Transfer In

To raise a transfer in request for a specific domain name:

1. Determine transfer in availability of a domain name with AuthCode using the transferAvailable endpoint.

2. Purchase and start or restart transfer in request for a domain name using the transfer endpoint.

3. Cancel a transfer in request for a domain name using the TransferInCancel endpoint.

Domain Info

To retrieve the list of managed domain names in your account with/without the given filters:

• Retrieve a list all the domain names in the account using the get domain endpoint. There are multiple filters that can be applied to filter the list. This endpoint will return a maximum of 500 domain names at a time.

• Retrieve additional details about a domain name using the get domain details endpoint such as DNSSEC, contacts and authcode.

Domain AuthCode Regeneration

To regenerate an AuthCode for a specific managed domain name:

1. Regenerate an AuthCode for a domain name using the regenerate endpoint.

2. Check status of the AuthCode update request using the actions endpoint and passing the type value as AUTH_CODE_REGENERATE.

Domain Trademark Claims

To check for trademark claim on a specific domain name:

• Check for any trademark claim on a domain name using the trademark endpoint.

Legal Agreements

To retrieve a list of legal agreements for a specific TLD:

• Retrieve the list of legal agreements for a specific TLD using the agreements endpoint.

General Domain Update

To update the registrar lock or auto-renew status of a specific managed domain name:

1. Update the locked status or auto-renew status of a domain name using the update domain endpoint.

2. Check status of the update request using the actions endpoint and passing the type value as DOMAIN_UPDATE.

3. Cancel a specific action for a domain using the actions cancel endpoint.

Nameservers Update

To update the nameservers of a specific managed domain name:

1. Request to update the nameservers using the update nameserver endpoint. note: To delete nameservers, pass the list of name servers as an empty list.
2. Check status of the nameserver update request using the actions endpoint and passing the type value as DOMAIN_UPDATE_NAME_SERVERS.

Privacy Service Update

It is only possible to toggle between "Brandsight Privacy"(Enable Privacy) and "GDPR"(Disable Privacy). For setting it to "Full Whois" option, please use the UI. To enable Brandsight Privacy Service for a specific managed domain name

1. Enable privacy service for a domain name using the privacy on endpoint and passing the agreement keys that can be discovered using the agreements endpoint.

2. Check status of the privacy service update request using the actions endpoint and passing the type value as PRIVACY_PURCHASE.

To disable Brandsight Privacy Service for a specific managed domain name:

1. Remove privacy service for a domain name using the privacy off endpoint.

2. Check status of the privacy service update request using the actions endpoint and passing the type value as PRIVACY_DELETE.

Contact Update

To update the contact details of a specific managed domain name:

1. Retrieve the TLD specific schema to be submitted when creating a contact using the contact schema endpoint.

2. Update the contact info of a managed domain name using the update contact endpoint.

3. Check status of the contact update request using the actions endpoint and passing the type value as CONTACT_UPDATE.

DNSSEC Update

To create or update a DNSSEC record of a specific managed domain name:

1. Create or update the DNSSEC records of a domain name using the update dnssec endpoint.

2. Check status of the DNSSEC create or update request using the actions endpoint and passing the type value as DNSSEC_CREATE.

To delete a DNSSEC record of a specific managed domain name:

1. Delete the DNSSEC records of a domain name using the delete dnssec endpoint.

2. Check status of the DNSSEC delete request using the actions endpoint and passing the type value as DNSSEC_DELETE.