Sign inGet Started

Create an identity

POST
/v1/compliance/identities
await bird.complianceIdentities.create({ name: "Goldcrest" });
Resposta201
{
  "id": "cid_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Goldcrest Communications SAS"
}

Stores a party you register on behalf of, so its business details can prefill the countries you register in next.

An identity belongs to the workspace that creates it. Register the same party from another workspace and it is a party of its own there, reviewed on its own terms.

You can name a party now and fill its business details in later. Required details depend on the destination country and are validated when you submit a registration.

Corpo da requisição

name
string
obrigatório

What you call this party. Yours to choose; it is never sent to a carrier.

Payload de resposta

id
string
obrigatório
name
string
obrigatório

What you call this party. Yours to choose; it is never sent to a carrier.

answers
object
obrigatório

The business details this party has supplied, keyed by requirement. Filled in for you: a single-value detail lands here the moment you file it on one of your registrations, so the next one prefills it rather than asking again. Only requirements a country marks as being about the party appear; anything about a specific sender is asked fresh each time.

created_at
string
obrigatório
updated_at
string
obrigatório