Skip to main content
POST
Create entity

Authorizations

x-api-key
string
header
required

API key for authentication.

Body

application/json

Request body for creating a single entity. The name field is required. You must also provide at least one of: a top-level description or a domain inside additional_attributes.company_attributes. The more fields you provide, the better the matching quality.

name
string
required

The company or person name. Required and must be non-empty.

Minimum string length: 1
Example:

"NewsCatcher"

entity_type
enum<string>
default:company

The type of entity.

  • company: A company or organization (default).
  • person: An individual person.
Available options:
company,
person
description
string

Free-text description of the entity used for disambiguation when similar names exist. See Writing effective descriptions for guidance on improving matching quality.

Example:

"NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries)."

external_entity_id
string

Optional external identifier for this entity. Free-form string, not enforced as unique. Use it to store your own CRM, data warehouse, or internal database ID so you can join CatchAll results back to your systems.

Maximum string length: 255
Example:

"crm-12345"

additional_attributes
object

Additional attributes for the entity, keyed by entity type.

Response

Entity created successfully.

id
string<uuid>
required

Unique identifier of the created entity.

Example:

"854198fa-f702-49db-a381-0427fa87f173"

status
string
required

Initial status of the entity. Always pending immediately after creation — enrichment happens asynchronously.

Example:

"pending"