Get Coverage Types (inbound)

Description

Coverage type ID is a required property for prospect and disposition records. A prospect can have only one disposition record per coverage_type_id.

The coverage_type_id must be one of Bold Penguin's coverage_type_ids.

You can retrieve the valid coverage type mappings from this API endpoint.

Endpoint

Staging

https://api-staging.boldpenguin.com/coverage_types

Production

https://api.boldpenguin.com/coverage_types

Authentication

The inbound Receive Side API use bearer authentication via an HTTP header.

Your Account Manager will provide you with a unique bearer token used for all Receive Side API.

Methods

GET

Request Parameters

None

Response Syntax

[
  {
    "id": <integer>,
    "name": "<string>"
  },
  {
    "id": <integer>,
    "name": "<string>"
  },
  ...
]

Response Elements

  • id

    • Unique ID for this coverage type
    • Type: Integer
    • Required: Yes
  • name

    • Descriptive name for this coverage type
    • Type: String
    • Required: Yes

Status Codes

  • 200 Success
  • 401 Unauthorized (Verify Authorization header)
  • 500 Internal server error

Examples

Example Request

$ curl -v -X GET \
       --header "Authorization: Bearer <access_token>" \
       --header "Content-Type: application/json" \
       https://<disposition_api_url>/coverage_types

Example Response

[
  {
    "id": 1,
    "name": "Commercial Package Policy"
  },
  {
    "id": 2,
    "name": "Commercial Umbrella"
  },
  {
    "id": 3,
    "name": "Commercial Crime"
  },
  {
    "id": 4,
    "name": "Bond"
  },
  {
    "id": 5,
    "name": "Liability"
  },
  ...
]

Note: The coverage_type_id mapping is a static list.

results matching ""

    No results matching ""