Brands management API

The Brand Management API provides the following functionality

Current Features:

• List all protected brands in your account

Upcoming Features:

• Add new brands to your protected list

• Remove brands from your protected list

Additional brand management capabilities are currently in development and will be available in future releases.

Authentication

Check the authentication page to see the available options.

Access and authentication

Manage Brands

Get domains for a company

get

Retrieve all domains protected by a specific company with optional pagination.

Authorization:

• User must have access to the specified company

Pagination:

• When ipp and pn are both 0 (default), returns simple array of domains

• When pagination parameters are set, returns object with domains, total count, and pagination info

• ipp is clamped between 1-100

• pn minimum is 1

Authorizations

ApiKeyAuthBearerAuth

X-AuthorizationstringRequired

Auth header token that doesn't expire

Query parameters

cintegerRequired

Company ID

Example: 1

ippinteger · max: 100Optional

Items per page (1-100). Setting to 0 disables pagination.

Default: 0Example: 20

pnintegerOptional

Page number (minimum 1). Setting to 0 disables pagination.

Default: 0Example: 1

hstring · nullableOptional

Hide parameter (filter criteria)

psstring[]Optional

Protection statuses to filter by

Example: ["active","pending"]

Responses

200

Successfully retrieved domains

application/json

Responseone of

or

403

Access denied - user not authorized for this company

application/json

500

Internal server error

application/json

get

/domain/company

HTTPcURLJavaScriptPython

GET /domain/company?c=1 HTTP/1.1
Host: api.bfore.ai
X-Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 500,
    "name": "acme.com"
  },
  {
    "id": 501,
    "name": "example.com"
  }
]

Protect a domain for a company

post

Create a protection relationship between a company and a domain.

Authorization:

• User must have access to the specified company

Domain Handling:

• If DomainId is provided, uses existing domain

• If DomainName is provided and domain doesn't exist, creates it first

• Must provide either DomainId or DomainName

Status:

• StatusName defaults to "active" if not provided

Authorizations

ApiKeyAuthBearerAuth

X-AuthorizationstringRequired

Auth header token that doesn't expire

Body

application/json

companyIdintegerRequired

Company ID (required)

Example: 1

domainIdinteger · int64 · nullableOptional

Existing domain ID (use this OR domainName)

Example: 500

domainNamestring · nullableOptional

Domain name (creates if doesn't exist, use this OR domainId)

Example: newdomain.com

statusNamestring · nullableOptional

Protection status name (defaults to "active")

Default: activeExample: active

Responses

200

Domain protection created successfully

application/json

Responseone of

or

400

Bad request - missing required fields

application/json

403

Access denied - user not authorized for this company

application/json

500

Internal server error

application/json

post

/company/protect

HTTPcURLJavaScriptPython

POST /company/protect HTTP/1.1
Host: api.bfore.ai
X-Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "companyId": 1,
  "domainId": 500,
  "statusName": "active"
}

Protect existing domain by IDProtect domain by name (creates if needed)

{
  "message": "Success",
  "protectionId": 12345
}

Add a protection status to a domain

post

Add a status record to a domain's protection history for a specific company.

Authorization:

• You must have access to the specified company

Requirements:

• The domain must already be protected by the company (exist in the protection relationship)

• The status must be a valid protection status value

Behavior:

• Creates a new status entry in the domain's protection history

• Does not remove previous statuses - maintains full history

• Uses the current timestamp for the status entry

Available Status Values:

• active - Domain protection is active

• deactivated - Domain protection has been deactivated

• deleted - Domain protection marked as deleted

• onboarded - Domain has been successfully onboarded

• error - An error occurred with the domain protection

• owned - Domain is owned/controlled

Authorizations

ApiKeyAuthBearerAuth

X-AuthorizationstringRequired

Auth header token that doesn't expire

Body

application/json

companyIdintegerRequired

Company ID (required)

Example: 1

domainstringRequired

Domain name (required). Must already be protected by the company.

Example: example.com

statusstring · enumRequired

Protection status (required)

Example: activePossible values:

Responses

200

Status added successfully

application/json

400

Bad request - missing required fields, domain not found, or invalid status

application/json

403

Access denied - you do not have access to the specified company

application/json

500

Internal server error

application/json

post

/domainprotection/addStatus

HTTPcURLJavaScriptPython

POST /domainprotection/addStatus HTTP/1.1
Host: api.bfore.ai
X-Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "companyId": 1,
  "domain": "example.com",
  "status": "active"
}

Activate a domain protectionMark domain as onboardedDeactivate a domain protection

{
  "success": true
}