compliance

Get an identity

Changed on

Returns one of this workspace's parties, with the business details it holds.

get/v1/compliance/identities/{identity_id}

Request

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

Headers

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.

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