The Identity endpoint and fields are described below including details of the supported RESTful CRUD verbs. For details of the conventions of the API see the general conventions.
Endpoint path prefix:
/n/v1/identity/
identity was introduced in API version V1
Identity has not been marked for deprecation
Endpoint with support for managing personal / identifiable information typically in the context of the CRM use case where the data about customers is managed
This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.
Identity reference
{
"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"
} ]
}Identity reference
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.
{
"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"
} ]
}API code CREATE_SUCCESS HTTP status code 201 : When the representation provided was successfully created return HTTP created (201). Note that when other context like authorisation and permissions are satisfied but the representation is invalid or missing required information typically a error representation with details of the missing information may be returned instead with REPRESENTATION_MISSING_REQUIRED_FIELD api error for example
API code REPRESENTATION_MISSING_REQUIRED_FIELD HTTP status code 400 : When creating or updating a representation the provided representation was missing a required filed. Typically has a error response representation with details of the missing required field.
API code INVALID_REPRESENTATION HTTP status code 400 : When creating or updating a representation and the provided representation is invalid. May include an error representation with details of the issue
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.
{
"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"
} ]
}API code READ_SUCCESS HTTP status code 200 : On read when the request is successful. The returned representation is given with the relevant 2XX HTTP code without further detail.
API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.
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.
{
"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"
} ]
}API code UPDATE_SUCCESS HTTP status code 202 : When creation was successful and the representation was created. Returns HTTP accepted (202) response and typically includes the representation of the created representation for reference. Note that CREATE / UPDATE can trigger async operations after the representation is accepted which can update state.
API code REPRESENTATION_MISSING_REQUIRED_FIELD HTTP status code 400 : When creating or updating a representation the provided representation was missing a required filed. Typically has a error response representation with details of the missing required field.
API code INVALID_REPRESENTATION HTTP status code 400 : When creating or updating a representation and the provided representation is invalid. May include an error representation with details of the issue
API code DELETE_SUCCESS HTTP status code 202 : When deletion of a representation was successful. Note that returns HTTP accepted (202) to represent the success of the deletion state transfer rather than HTTP gone (410) as 4XX represent client errors for semantic consistency
API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.