Blocklist

PreviousEmail

Was this helpful?

List blocklisted domains

Get a list of domains in your account's blocklist

GEThttps://api.usercheck.com/blocklist

Authorization

Query parameters

Response

List of blocklisted domains

Body

domainstring

The blocklisted domain

Example: "example.com"

created_atstring (date-time)

When the domain was added to the blocklist

Example: "2024-01-28T12:00:00Z"

Request

const response = await fetch('https://api.usercheck.com/blocklist', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "domain": "example.com",
    "created_at": "2024-01-28T12:00:00Z"
  }
]

Add domain to blocklist

Add a new domain to your account's blocklist

POSThttps://api.usercheck.com/blocklist

Authorization

Body

domain*string

Example: "example.com"

Response

Domain added to blocklist

Body

domainstring

The blocklisted domain

Example: "example.com"

created_atstring (date-time)

When the domain was added to the blocklist

Example: "2024-01-28T12:00:00Z"

Request

const response = await fetch('https://api.usercheck.com/blocklist', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "domain": "example.com"
    }),
});
const data = await response.json();

Response

{
  "domain": "example.com",
  "created_at": "2024-01-28T12:00:00Z"
}

Check if domain is blocklisted

Check if a specific domain is in your account's blocklist

GEThttps://api.usercheck.com/blocklist/{domain}

Authorization

Path parameters

domain*string

Domain to check

Example: "example.com"

Response

Domain found in blocklist

Body

domainstring

The blocklisted domain

Example: "example.com"

created_atstring (date-time)

When the domain was added to the blocklist

Example: "2024-01-28T12:00:00Z"

Request

const response = await fetch('https://api.usercheck.com/blocklist/{domain}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "domain": "example.com",
  "created_at": "2024-01-28T12:00:00Z"
}

Remove domain from blocklist

Remove a domain from your account's blocklist

DELETEhttps://api.usercheck.com/blocklist/{domain}

Authorization

Path parameters

domain*string

Domain to remove

Example: "example.com"

Response

Domain removed from blocklist

Request

const response = await fetch('https://api.usercheck.com/blocklist/{domain}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();