LOB-specific additional insured contacts

All policies have a primary named insured. A policy can also have any number of additional named insureds. In addition, a policy can have additional insureds that are LOB-specific. Endpoints for LOB-specific additional insureds are available only if you have at least one additional insured defined for the LOB.

To manage these LOB-specific additional insureds, use the following endpoints:

  • GET /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds

  • POST /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds

  • GET /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds/{additionalInsuredId}

  • PATCH /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds/{additionalInsuredId}

  • DELETE /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds/{additionalInsuredId}

  • GET /policy/v1/policies/{policyId}/lines/{lineId}/additional-insureds

  • GET /policy/v1/policies/{policyId}/lines/{lineId}/additional-insureds/{additionalInsuredId}

Querying for additional insureds on the policy

Use the following endpoints to query for additional insureds on a policy line:

  • GET /policy/v1/policies/{policyId}/lines/{lineId}/additional-insureds

  • GET /policy/v1/policies/{policyId}/lines/{lineId}/additional-insureds/{additionalInsuredId}

You cannot add, update, or delete additional insureds through the policy, you can only query. Additional insureds can be added, modified, and removed only in the context of a job. The following sections describe how to manage additional insureds through the associated job.

Querying for LOB additional insureds

Use the following endpoints to retrieve information about additional insureds for a specific job:

  • GET /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds

  • GET /job/v1/jobs/{jobId}/lines/{lineId}/additional-insureds/{additionalInsuredId}

These endpoints return policy contacts that have an additional insured role on the job's underlying policy for the specified line.

For example, the following is a portion of the response when querying for additional insureds on the BusinessAutoLine line for job pc:4477.

Command

GET /job/v1/jobs/pc:4477/lines/BusinessAutoLine/additional-insureds

Response

{
    "data": [
        {
            "attributes": {
                "additionalInsuredType": {
                    "code": "LESSOR",
                    "name": "Lessor"
                },
                "contact": {
                    "displayName": "EverReady Rentals",
                    "id": "pc:1234",
                    "type": "PolicyContact",
			…
                },
                "id": "1"
            }
        },
…

Adding LOB additional insureds

To add an existing account contact to a job as an additional insured, use the following endpoint:

  • POST /job/v1/jobs/{jobId}/lines/{lineId}/additional-insured

Note:

Before modifying the job, it must be in a Draft state. If the job has been quoted, you can revert its state to Draft by running the following command:

POST /job/v1/jobs/{jobId}/make-draft

The request must include the following properties:

  • additionalInsuredType: A typecode specifying the relationship of the contact.
  • contact: The ID of an existing contact on the policy.
  • additionalInformation: A string with additional information. This property is required only for insured types that have been configured to accept additional information. If the insured type has not been configured for additional information, this property is unavailable. See the note at the end of this section for more information.

For example, the following request adds the existing account contact pc:4533 as an additional insured of type Lessor to job pc:4477 on the BusinessAutoLine line.

Command

POST /job/v1/jobs/pc:4477/lines/BusinessAutoLine/additional-insureds

Request

{
    "data": {
        "attributes": {
            "additionalInsuredType": {
                "code": "LESSOR"
            },
            "contact": {
                "id": "pc:4533"
            }
        }
    }
}
Note:

The additionalInformation property is never optional, it’s either required or it’s not available. Each additional insured type is defined in the AddtionalInsuredType.XX.ttx typelist configuration file (with XX being the code for the LOB, such as BA for the BusinessAutoLine). If additional information is required, there will be a matching entry in the AdditionalInformationType.XX.ttx file.

Modifying LOB additional insureds

Use the following endpoint to modify an additional insured:

  • PATCH /job/v1/jobs/{jobId}/lines/{lineId}/additional-insured/{additionalInsuredId}

For example, the following request changes the insured type of the contact with the additional insured relationship 309 on job pc:4477 on the BusinessAutoLine line.

Command

PATCH /job/v1/jobs/pc:4477/lines/BusinessAutoLine/additional-insured/309

Request

{
    "data": {
        "attributes": {
            "additionalInsuredType": {
                "code": "VENDOR"
            }
        }
    }
}

Use the following endpoint to DELETE an additional insured:

DELETE /job/v1/jobs/{jobId}/lines/{lineId}/additional-insured/{additionalInsuredId}

No request body is required.

This endpoint removes the additional insured role from the contact, but it does not delete the contact from the policy.