Skip to content
Baack

Identity

Identity encapsulates all information associated with a person's identity like their contact details, associated addresses etc. The identity representation is used in multiple contexts and use cases like the identity of people in CRM as well as in the context of other use cases like role based access control or group membership.

Browse the docs

Endpoints

  • GET/n/v1/identity/{urn}

    Endpoint with support for managing personal / identifiable information typically in the context of the CRM use case where the data about customers is managed

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns IdentityREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/identity/{urn}

Fields

Identity fields
FieldTypeDescription
urnstring (uuid)
ownerCompany

Required on create.

emailsarray of Email

Ignored on update.

personsarray of Person

Ignored on update.

addressesarray of Address

Ignored on update.

companiesarray of Company

Ignored on update.

clientIdentifiersarray of Client Identifier

Ignored on update.

namestring

Optional.

telephonesarray of Telephone

Ignored on update.

urlstring (uri)

Used by: Address, Client Context, Client Identifier, Email, Group Membership, Message Thread Notification, Person, Recipient, Remitter, Role, Search Item, Task, Task Log, Telephone, Thread post