Receive Prospect (outbound)

Description

The easiest way to receive prospects from Bold Penguin is to integrate with us at the API level. You would provide us with an HTTP endpoint where we can POST data. When you are matched, the Bold Penguin Exchange will automatically send the prospect event data to your pre-configured endpoint.

Endpoint

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

Authentication

We can inject credentials into the HTTP POST request via basic authentication or a static header (X-API-KEY, Authorization: Bearer, etc.) that you provide.

Methods

POST

Request Syntax (sent by Bold Penguin)

{
  "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

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 be received within our default timeout of 15 seconds.

Status Codes

• 200 Prospect received
• 500 Internal server error

Any HTTP response other than 200 is considered an error.

Examples

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"
}