Web Presence Review Blocklist

Create Blocked Domain

This API endpoint allows you to add a domain to a block list. This API requires a valid API key (X-API-KEY) to be provided in the headers and is rate limited to 5 requests per second.

post/api/v1/company/block

Request body

domainstring required

The domain to be blocked.

phonestring nullable

The phone number to be blocked.

emailstring nullable

The email to be blocked.

address_line_1string nullable

The address to be blocked.

address_line_2string nullable

The address to be blocked.

citystring nullable

The city to be blocked.

statestring nullable

The state which the address belongs too

zipcodestring nullable

The zip code to which the address belongs too.

countrystring nullable

The country which the address belongs too.

reason'Credit and Financial Risk' | 'Compliance and Regulatory' | 'Business Profile Risk' | 'Internal Policy' | 'Fraudulent Application' | 'Fraudulent Business' | 'Other' required
other_explanationstring nullable

The reason for blocking this domain when other is selected.

notesstring nullable
expires_atstring date-time nullable

The date and time this block should expire at. If you do not set this value, it will default to five years from the creation date.

Example request

{
  "domain": "example.net",
  "phone": "3136739082",
  "email": "test@truebiz.io",
  "address_line_1": "104 Truebiz Lane",
  "address_line_2": "104 Truebiz Lane",
  "city": "Detroit",
  "state": "MI",
  "zipcode": "48178",
  "country": "US",
  "expires_at": "2028-12-31T23:59:59.999999"
}

Response

OK

messagestring required

Example response

{
  "message": "Block created for example.net."
}

Changes

Changed in 2 of the 12 revisions of this API.13118

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

  • fd8c32a19c7f2118See the full diff
    • ▲

      request property was restricted to a list of enum values

      request-property-became-enum

    • ▲

      the request property type changed from no type to string

      request-property-type-changed

    • ●

      removed from the request property allOf list

      request-property-all-of-removed

    • ○

      added the new Business Profile Risk enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Compliance and Regulatory enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Credit and Financial Risk enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Fraudulent Application enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Fraudulent Business enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Internal Policy enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Other enum value to the request property

      request-property-enum-value-added

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened