Receive Prospect (Exchange)

Description

Receive prospects from the Bold Penguin Exchange by providing an HTTP endpoint where Bold Penguin can POST prospect data. When you match a prospect in the Exchange, Bold Penguin will send the prospect event data to this pre-configured endpoint.

Endpoint

The HTTP(S) endpoint you supply for Bold Penguin to POST prospect data.

Authentication

You can provide a static HTTP header value (X-API-KEY, Authorization: Bearer, etc.) for us to include in the POST request. Bold Penguin does not support dynamic authentication.

Methods

POST

Request Syntax

{
  "actual_years_in_business": <int>,
  "address": "<string>",
  "alt_phone_number": "<string>",
  "business_name": "<string>",
  "city": "<string>",
  "completed_at": "<string>",
  "coverage_type_ids": array<int>,
  "currently_insured": <boolean>,
  "duns": null,  **DEPRECATED FIELD**
  "ein": null, **DEPRECATED FIELD**
  "email": "<string>",
  "estimated_annual_payroll": <int>,
  "estimated_annual_revenue": <int>,
  "external_id": null, **DEPRECATED FIELD**
  "first_name": "<string>",
  "full_time_employees": <int>,
  "key": "", **DEPRECATED FIELD**
  "last_name": "<string>",
  "lead_id": "<string>",
  "legal_entity_id": <enum integer>,
  "naic_id": "<int>",
  "naics_code": "<enum string>",
  "naics_description": "<string>",
  "name": "<string>",
  "part_time_employees": "<int>",
  "phone_number": "<string>",
  "source": "", **DEPRECATED FIELD**
  "state": "<string>",
  "website": null, **DEPRECATED FIELD**
  "years_of_experience": <int>,
  "zip": "<string>"
}

**DEPRECATED FIELD** properties are no longer populated with data, but included in requests for legacy integrations.

Request Parameters

• coverage_type_ids
  • An array of integer IDs of the coverage type for the policy
  • Type: Integer Enum
    • One or more of Bold Penguin's coverage_type_ids
  • Required: Yes
• lead_id
  • Record locator used to retrieve disposition records for this prospect.
  • Type: String
  • Required: Yes
• legal_entity_id
  • Current status of the prospect
  • Enum (see table below)
  • Required: Yes

ID	Name
1	Sole Proprietorship
2	Partnership
3	LLC
4	S Corporation
5	C Corporation
6	Other
7	Joint Venture
8	Trust
9	Association
10	Municipality

Response Syntax

{
  "response": {
    "status": "Success"
  }
}

Response Elements

• status
  • Indicates that you have successfully received the prospect.
  • Value must be Success
  • Required: Yes

NOTE: The response must match exactly (including case) and be sent within our default timeout of 15 seconds or the prospect will be matched to the next partner in the Exchange.

Status Codes

• 200 Prospect received
• 500 Internal server error

Any HTTP response other than 200 is considered an error.

Examples

Example Request

POST /prospects/ HTTP/1.1
Connection: close
Content-Length: 771
Content-Type: application/json
Host: <your_partner_url>

{
    "actual_years_in_business": 14,
    "address": "10 Main St.",
    "alt_phone_number": "6145550987",
    "business_name": "Skipper, Rico, Kowalski and Private, LLC",
    "city": "Columbus",
    "completed_at": "2019-04-09T15:22:31Z",
    "coverage_type_ids": [
        5,
        9
    ],
    "currently_insured": true,
    "duns": null,
    "ein": null,
    "email": "",
    "estimated_annual_payroll": 12000,
    "estimated_annual_revenue": 32000,
    "external_id": null,
    "first_name": "Skipper",
    "full_time_employees": 3,
    "key": "",
    "last_name": "Skip-king",
    "lead_id": "1EpKpmra1XEKStMFkbywQFBj",
    "legal_entity_id": 3,
    "naic_id": 2,
    "naics_code": "238350",
    "naics_description": "Finish carpentry",
    "name": "Skipper Skip-king",
    "part_time_employees": 0,
    "phone_number": "6145550987",
    "source": "",
    "state": "OH",
    "website": null,
    "years_of_experience": 20,
    "zip": "43214"
}

Example Response

{
  "response": {
    "status": "Success"
  }
}