POST
/
blocked-companies
Block company
curl --request POST \
  --url https://api.godiligent.ai/blocked-companies \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "website": "example.com",
  "email": "fulan@domain.com",
  "legal_name": "PayLane ltd",
  "address": "123 Imaginary St, 45678 Fictional City",
  "external_id": "abc123 - my customer reference",
  "vat_number": "BE09999999XX",
  "register_number": "123546",
  "reason": "Fraudulent activity",
  "notes": "Company engaged in fraudulent activity"
}'
{
  "id": "bc-a91a8416-0a38",
  "website": "example.com",
  "email": "contact@example.com",
  "legal_name": "Example Company Ltd",
  "address": "123 Example Street, City",
  "country_code": "DE",
  "vat_number": "BE09999999XX",
  "register_number": "123456789",
  "reason": "Fraudulent activity",
  "notes": "Multiple reports of fraud from customers",
  "blocked_at": "2025-01-15T12:30:45Z",
  "external_id": "cust-12345"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
website
string
required

The website of the business

Example:

"example.com"

​
reason
string
required

The reason for blocking the company

Example:

"Fraudulent activity"

​
email
string

The email of the business

Example:

"fulan@domain.com"

​
legal_name
string

The legal name of the business

Example:

"PayLane ltd"

​
address
string

The address of the business, or partial address

Example:

"123 Imaginary St, 45678 Fictional City"

​
external_id
string

Reference to be used in the customer's system

Example:

"abc123 - my customer reference"

​
vat_number
string

The VAT number of the business

Example:

"BE09999999XX"

​
register_number
string

The register number of the business

Example:

"123546"

​
notes
string

Additional notes for blocking the company

Example:

"Company engaged in fraudulent activity"

Response

Successfully blocked company, returns the created record

​
id
string
required

Unique identifier for the blocked company record

Example:

"bc-a91a8416-0a38"

​
reason
string
required

The reason for blocking the company

Example:

"Fraudulent activity"

​
blocked_at
string<date-time>
required

When the company was blocked

Example:

"2025-01-15T12:30:45Z"

​
website
string | null

The website of the business (if provided)

Example:

"example.com"

​
email
string | null

The email of the business (if provided)

Example:

"contact@example.com"

​
legal_name
string | null

The legal name of the business (if provided)

Example:

"Example Company Ltd"

​
address
string | null

The address of the business (if provided)

Example:

"123 Example Street, City"

​
country_code
string | null

Country code in ISO 3166-1 alpha-2 format (if provided)

Example:

"DE"

​
vat_number
string | null

The VAT number of the business (if provided)

Example:

"BE09999999XX"

​
register_number
string | null

The registry number of the business (if provided)

Example:

"123456789"

​
notes
string | null

Additional notes about the block

Example:

"Multiple reports of fraud from customers"

​
external_id
string | null

Reference ID from the customer's system (if provided)

Example:

"cust-12345"