API Reference

Base URL

All API requests should be made to:

https://bifrost.api-armor.com

All endpoints require authentication using a Bearer token in the Authorization header.

Authorization: Bearer aa_abc123xyz789

See the Authentication guide for more details.

Verify if an email address uses a disposable domain

Get IP address intelligence with reputation scoring and geolocation data

All API responses are returned in JSON format with appropriate HTTP status codes.

200 OK

Successful requests return a 200 OK status code with the response data:

{
  "email": "user@example.com",
  "is_disposable": false,
  "domain": "example.com"
}

Error responses include an error field with a machine-readable error code and a message field with a human-readable description:

{
  "error": "invalid_email",
  "message": "The provided email address is not valid"
}

Header	Required	Description
`Authorization`	Yes	Bearer token for authentication
`Content-Type`	No	Set to `application/json` for POST requests

Header	Description
`Content-Type`	Always `application/json`
`X-RateLimit-Limit`	Maximum requests allowed per time window
`X-RateLimit-Remaining`	Remaining requests in current window
`X-RateLimit-Reset`	Unix timestamp when the rate limit resets

Status Code	Description
`200`	Request successful
`400`	Bad request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - API key doesn't have required permissions
`429`	Too many requests - Rate limit exceeded
`500`	Internal server error
`503`	Service unavailable