Get Disposition Records (inbound)

Description

Retrieve the list of existing disposition records created for each new prospect. These records are auto-generated at match time.

Endpoint

Staging

https://api-staging.boldpenguin.com/leads/<lead_id>/lead_attributes

Production

https://api.boldpenguin.com/leads/<lead_id>/lead_attributes

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

  • lead_id (URL parameter)
    • Record locator used to retrieve disposition records for this prospect.
    • Type: String
    • Required: Yes
    • NOTE: Retrieved from the initial POST of the prospect data into your system.

Response Syntax

[
  {
    "carrier": <string>,
    "coverage_type_id": <integer enum>,
    "coverage_types": [],
    "external_id": <integer>,
    "history": <string>,
    "id": <integer>,
    "lead_id": <integer>,
    "premium": <decimal>,
    "quoted_at": "<date string>",
    "rate": <decimal>,
    "sold_at": "<date string>",
    "status": "<string enum>"
  },
  ...
]

Response Elements

An array of disposition records with the following attributes:

  • carrier
    • The name of the carrier through which the policy was sold
    • Type: String (maximum length: 255)
    • Required: if status=Sold
  • coverage_type_id
    • The integer ID of the coverage type for the policy
    • Type: Integer Enum
    • Required: Yes
  • coverage_types
    • Unused
    • Empty array
    • Required: No
  • external_id
    • Unused
    • Empty array
    • Required: No
  • history
    • A field for text notes, history of prospect
    • Type: String (minimum length: 25)
    • Required: if status=Sold
  • id
    • Unique ID for this disposition record
    • Type: Integer
    • Required: Yes
  • lead_id
    • Unique ID for the lead associated with this disposition record
    • Type: Integer
    • Required: Yes
  • premium
    • The yearly premium for the policy
    • Type: Decimal (greater than 0)
    • Required: if status=Sold
  • quoted_at
    • Date quoted
    • Type: Date (YYYY-MM-DD)
    • Required: No *rate
    • The commission rate on the policy
    • Type: Decimal (0 - 25)
    • Required: if status=Sold
  • sold_at
    • Date sold
    • Type: Date (YYYY-MM-DD)
    • Required: No
  • status
    • Current status of the prospect
    • Enum (see table below)
    • Required: Yes
Status Description
Active Default
Contact Made Record received
Sent App to Client Waiting on carrier
Quote Presented Customer received quote
Sold Policy sold
Not Sold Customer quoted, but policy not sold
Ineligible Unable to present quote

Note: There can only be one disposition record per coverage_type_id.

Status Codes

  • 200 Success
  • 401 Unauthorized (verify Authorization header)
  • 404 Could not find prospect (verify lead_id)

Examples

Example Request

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

Example Response

[
  {
    "id": 263035,
    "status": "Active",
    "premium": null,
    "rate": null,
    "history": null,
    "carrier": null,
    "lead_id": 6075388,
    "external_id": null,
    "quoted_at": null,
    "sold_at": null,
    "coverage_type_id": 5,
    "coverage_types": []
  },
  {
    "id": 263036,
    "status": "Active",
    "premium": null,
    "rate": null,
    "history": null,
    "carrier": null,
    "lead_id": 6075388,
    "external_id": null,
    "quoted_at": null,
    "sold_at": null,
    "coverage_type_id": 8,
    "coverage_types": []
  }
]

results matching ""

    No results matching ""