Overview of ClaimContacts in Cloud API

The ClaimContact resource in Cloud API

Even though ClaimCenter stores ClaimContact information in multiple entities, Cloud API captures this information in a single resource. This resource is named ClaimContact. This documentation uses the term "ClaimContact" to refer to a ClaimContact resource in Cloud API, and its corresponding information in the ClaimCenter ClaimContact, ClaimContactRole, and Contact entities.

Cloud API identifiers for ClaimContacts

There are multiple identifier values that can be used to identify a ClaimContact. The following table lists them and defines when they are used.


Identifier	Description	Use case	More information
`id`	The ClaimContact's Cloud API ID.	When querying for a specific ClaimContact When assigning a contact role to an existing ClaimContact When deleting a ClaimContact	Querying for ClaimContacts Assigning roles to existing ClaimContacts Deleting ClaimContacts
`refid`	A temporary reference ID	When POSTing or PATCHing a ClaimContact using request inclusion	Creating a new ClaimContact with a reserved role Creating a new ClaimContact with a non-reserved role
`policySystemId`	An identifier from the Policy Administration System that uniquely identifies the contact.	When adding a ClaimContact to a claim that is already listed on the policy	Working with contacts from the policy Assigning roles to existing ClaimContacts
`syncAddressBookUID`	An identifier from ContactManager that uniquely identifies the contact.	When adding a ClaimContact to a claim that is already listed in ContactManager	Copying vendor contacts from ContactManager

Contrasting ClaimContacts and "contacts"

The name of the resource that captures contact information is ClaimContact. This documentation refers to contacts related to claims as ClaimContacts.

Be aware that there are places where Cloud API uses the term "contacts" to refer to ClaimContacts:

For endpoints that have ClaimContact as the root resource, the endpoint path refers to the resources as a "contact". For example:
- GET /claim/v1/claims/{claimId}/contacts
- PATCH /claim/v1/claims/{claimId}/contacts/{contactId}
When using the include query parameter to include related ClaimContacts, the resources are referred to as "contacts". For example:
- GET /claim/v1/claims?include=contacts