Person object representation

The person object representation and fields are described below.

person was introduced in API version V1

person has not been marked for deprecation

Usages

Person

Description

Representation of a person associated with an identity

Example create representation

{
  "birthDate" : "2025-07-14T09:00:00.000",
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  }
}

Example response representation

{
  "urn" : "249456c5-c884-4ef6-96b0-30e96a73897a",
  "url" : "/n/v1/person/249456c5-c884-4ef6-96b0-30e96a73897a",
  "birthDate" : "2025-07-14T09:00:00.000",
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "names" : [ {
    "urn" : "92c75454-424b-4c2a-b5c5-ca7d64fa9940",
    "url" : "/n/v1/personname/92c75454-424b-4c2a-b5c5-ca7d64fa9940"
  } ],
  "telephones" : [ ],
  "addresses" : [ ]
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN for the person associated with an identity
url	URL represented as a string	URL for accessing the person
birthDate	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The birthday date for the person in ISO 8601 format (UTC)
identity	identity	The identity this person is associated with	Required on create.
names	personname[]	Names associated with this person	Ignored on update.
telephones	telephone[]	Telephone numbers associated with the person	Ignored on update.
addresses	address[]	Address associated with the person	Ignored on update.