border.bot
Docs menu

API reference

API reference

Block a code

POST https://api.border.bot/v1/classify/blocklist

Requires an API key (Authorization: Bearer bb_live_…).

Never suggest this code (or any line under it) again, for one destination or all. Adding a code that is already blocked updates its reason. Free; up to 5,000 codes.

API key scope: settings.

Request body (JSON)#

Name Type Required Description
code string yes
destination "*" | string no
reason string no

Responses#

  • 200: The blocked code. (BlockedCodeResponse)
  • 400: Invalid input (invalid_input). (Error)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the settings scope (forbidden, details.reason: "missing_scope"). (Error)
  • 429: Rate limited (rate_limited). Retry after Retry-After seconds; RateLimit says which limit was hit (r=0, t seconds until its window ends) and RateLimit-Policy its quota. (Error)
  • 500: Unexpected error (internal). (Error)

Example#

bash
curl -X POST 'https://api.border.bot/v1/classify/blocklist' \
  -H 'Authorization: Bearer bb_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"code":"6109.10","destination":"US","reason":"Our broker files these under 6109.90"}'