UserCheck
  • Quick Start
  • Reference
    • Authentication
    • Rate limit
  • API reference
    • Domain
    • Email
    • Blocklist
Powered by GitBook
On this page

Was this helpful?

  1. API reference

Blocklist

PreviousEmail

Was this helpful?

Check if domain is blocklisted

get

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

Authorizations
Path parameters
domainstringRequired

Domain to check

Example: example.com
Responses
200
Domain found in blocklist
application/json
401
Unauthorized
403
This feature requires a Pro account
404
Domain not found in blocklist
get
GET /blocklist/{domain} HTTP/1.1
Host: api.usercheck.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Remove domain from blocklist

delete

Remove a domain from your account's blocklist

Authorizations
Path parameters
domainstringRequired

Domain to remove

Example: example.com
Responses
200
Domain removed from blocklist
401
Unauthorized
403
This feature requires a Pro account
404
Domain not found in blocklist
delete
DELETE /blocklist/{domain} HTTP/1.1
Host: api.usercheck.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
  • GETList blocklisted domains
  • POSTAdd domain to blocklist
  • GETCheck if domain is blocklisted
  • DELETERemove domain from blocklist

List blocklisted domains

get

Get a list of domains in your account's blocklist

Authorizations
Query parameters
per_pageinteger · min: 1 · max: 100Optional

Number of results per page

Default: 25
Responses
200
List of blocklisted domains
application/json
401
Unauthorized
403
This feature requires a Pro account
get
GET /blocklist HTTP/1.1
Host: api.usercheck.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Add domain to blocklist

post

Add a new domain to your account's blocklist

Authorizations
Body
domainstringRequiredExample: example.com
Responses
200
Domain added to blocklist
application/json
401
Unauthorized
403
This feature requires a Pro account
422
Validation failed
post
POST /blocklist HTTP/1.1
Host: api.usercheck.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

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