Agency filing checks | border.bot API docs

GET https://api.border.bot/v1/comply

Requires an access token from an API client (Authorization: Bearer <access_token>).

Your agency filing checks, newest first (up to 200): what was checked, for which destination, and each agency’s answer (outcome, certificate, citations, exemptions, waiver, intended use). Free.

API client scope: compliance.

Parameters#

Name	Type	Required	Description
`limit`	integer	no

Responses#

200: Your checks. (ComplyChecksResponse)
400: Invalid input (invalid_input). (Error)
401: Missing, invalid or expired access token, or a revoked or expired API client (unauthorized). (Error)
403: The API client doesn’t have the compliance 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 request#

curl -X GET https://api.border.bot/v1/comply \
  -H "Authorization: Bearer $BORDERBOT_TOKEN"

const response = await fetch('https://api.border.bot/v1/comply', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BORDERBOT_TOKEN}`,
  },
});
const data = await response.json();

import os

import requests

response = requests.get(
    "https://api.border.bot/v1/comply",
    headers={"Authorization": f"Bearer {os.environ['BORDERBOT_TOKEN']}"},
)
data = response.json()

<?php
$ch = curl_init('https://api.border.bot/v1/comply');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('BORDERBOT_TOKEN'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Example response (200)#

JSON

{
  "data": [
    {
      "id": "0199c3a2-7b4e-7d21-9f3a-2c5e8b1d4f60",
      "actor": "string",
      "source": "string",
      "reference": "string",
      "destination": "string",
      "origin": "string",
      "itemCount": 0,
      "fileCount": 0,
      "reviewCount": 0,
      "engine": "string",
      "result": {
        "items": [
          {
            "index": 0,
            "sku": "string",
            "hsCode": "string",
            "filings": [
              {
                "country": "string",
                "agency": "string",
                "outcome": "string",
                "certificate": "string",
                "citations": [
                  "string"
                ],
                "exemptions": [
                  "string"
                ],
                "waiver": "string",
                "intendedUse": "string",
                "program": "string",
                "productCode": "string",
                "declarations": [
                  "string"
                ],
                "priorNotice": false,
                "probability": 0,
                "needsReview": false
              }
            ]
          }
        ]
      },
      "createdAt": "string"
    }
  ]
}