compliance

Create an identity

Changed on

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.

post/v1/compliance/identities

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/compliance/identities
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

namestring required

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

Example request

{
  "name": "Goldcrest Communications SAS"
}

Response

The identity.

idstring required
namestring required

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

answersobject required

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_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "cid_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Goldcrest Communications SAS"
}

Changes