Identity object representation

The identity object representation and fields are described below.

identity was introduced in API version V1

identity has not been marked for deprecation

Usages

Identity

Description

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.

Example create representation

{
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "name" : "Identity name handle",
  "companies" : [ {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  } ]
}

Example response representation

{
  "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
  "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "name" : "Identity name handle",
  "persons" : [ ],
  "emails" : [ ],
  "clientIdentifiers" : [ ],
  "companies" : [ {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  } ]
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The Unique Resource Name (URN)for the identity. These are assigned by the system on create.
url	URL represented as a string	URL for accessing this identity
owner	company	The owning company which has legal ownership of this identity information. Note that every company uses distinct encryption keys internally and identities owner can't be updated.	Required on create.
name	String literal	A short name for the identity which can be used for locating the record. This field is optional	Optional.
persons	person[]	The person associated with this identity, typically a single person	Ignored on update.
emails	email[]	Email addresses associated with this identity	Ignored on update.
clientIdentifiers	clientidentifier[]	Client identifiers associated with this identity	Ignored on update.
companies	company[]	Companies associated with this identity	Ignored on update.