Sign inGet Started

Get an identity

GET
/v1/compliance/identities/{identity_id}
const identity = await bird.complianceIdentities.get(
  "cid_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(identity.name, Object.keys(identity.answers));
Respons200
{
  "id": "cid_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Goldcrest Communications SAS"
}

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

Parameter

identity_idstring

Identity ID.

Payload Respons

id
string
wajib
name
string
wajib

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

answers
object
wajib

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
wajib
updated_at
string
wajib