Creating contacts from a contact management system

There are several ways to create contacts in Cloud API. There are POST /contacts endpoints for account, producer, and policy period contacts. You can also create new contacts when executing policy transactions such as issuance and rewrite.

Whenever you create a contact through a Cloud API call, you have two options for how to provide the contact data:
  • Include the new contact data in the request
  • Copy over a contact from the contact management system

Include contact data in the request

When creating contacts by including contact data in the request, the required fields vary slightly based on the type of contact that is created. This is documented in Producer contacts, Account contacts, and Policy period contacts.

Copy contact information from a contact management system

You can create a contact in BillingCenter by copying over a contact from the contact management system. This is only possible if BillingCenter is integrated with a contact management system.

When you copy an existing vendor contact from the contact management system, BillingCenter links the new contact to its associated contact in the contact management system. This means that any changes made to the contact in one application (such as changes to its phone number) are shared with the other system.

When copying contacts over from a contact management system, you only provide the contact id in the contact management system. If integrated with Guidewire ContactManager, use the linkId property. Use the syncAddressBookUID field to provide this id. No other contact information is accepted if this field is provided.

For example, when creating an account, policy period, or producer contact by copying it from the contact management system, the request body would look like this:

{
  "data": {
    "attributes": {
      "syncAddressBookUID": "cm:123"
    }
  }
}
A contact can also be copied over from a contact management system when executing a policy transaction. To do this, use the syncAddressBookUID as the sole property of the primaryNamedInsuredContact field. For example, a minimal reinstatement with a copied contact looks like this:
{
    "data": {
        "attributes": {
            "modificationDate": "2024-10-06",
            "primaryNamedInsuredContact": {
                    "syncAddressBookUID": "cm:123"
            }
        }
    }
}
Note: Using this method to create contacts may result in decreased performance, as BillingCenter must query the contact management system to retrieve contact information.