Quick Submit

Description

The Quick Submit API allows you to quickly retrieve basic company information and location details for any seed company name and address you provide.

Under the hood, the seed input is cleansed and enriched to ensure there are no missing data elements. After cleansing, the request is submitted to multiple data connectors which aggregate the data relevant to the input. The aggregated data is further processed to triangulate all data elements and generate a confidence score.

Authentication

Step 1: Obtain a Bearer Token

The Quick Submit API uses the Insurance Intelligence Authenticate API to obtain a bearer token using your client_id, client_secret, and API key. The bearer token obtained from the Authentication API can be used to authenticate requests using the Universal Submit API.

Your Bold Penguin project team will provide you with a unique client_id and client_secret for each environment as well as an API key and Data Package ID (dp_id).

Step 2: Access the Quick Submit API

Endpoint

Staging

https://api-smartdata.di-beta.boldpenguin.com/company/v1/quick_submit?dpid=[datapackageID]

Production

https://api.ii.boldpenguin.com/company/v1/quick_submit?dpid=[datapackageID]

Pass the below variables as part of the request

Request Parameters	Comments
Authentication Token	The token obtained via the Authentication API
API Key	(Provided by Bold Penguin)
Request Query Parameters	Pass the Shared Data Package Id as part of the dpid query parameter
POST Request Body	The body contains a JSON message which will have Company Name and Address attributes

Sample Quick Submit Request

POST /company/v1/quick_submit?dpid=kowalski-us-c0001 HTTP/1.1
Host: api-smartdata.di-beta.boldpenguin.com
x-api-key: M4jHKvQ6dD4Y1sDiv7gEe6LIuqArhDin8XldfxoK
Authorization: Bearer NMav128jTZbbEK48o64UM94K
Content-Type: application/json
Content-Length: 119

{
    "company_name":"Bold Penguin Inc.",
    "address":"100 East Broad Street, Columbus, OH 43215"
}

Sample Quick Submit Response

{
    "tx_id": "kowalski-8bd82aba-7d01-42d4-b851-b0bea1b41540",
    "tenant_id": "kowalski",
    "user_id": "jkasd789-45ty-xa34-12dc-a4a240bk1412",
    "tx_start_time": "2021-05-13T20:51:52.362Z",
    "tx_end_time": "2021-05-13T20:51:54.310Z",
    "response_time_secs": 6.778006,
    "seed_input": {
               "company_name": "Bold Penguin Inc.",
               "address": "100 East Broad Street, Columbus, OH 43215"
    },
    "data_package_id": "kowalski-us-c0001",
    "c_report_id": "CUSDD97T2FAE114E52240",
    "l_report_id": "LUS1387Y3Y8256746FC9",
    "cleansed_input": {
                "companyName": "BOLD PENGUIN INC.",
                "website": "https://www.boldpenguin.com.com/",
                "phoneNumber": "6143441029",
                "confidence_score": 0.6,
                "address": {
                  "streetAddr": "100 EAST BROAD ST",
                  "city": "COLUMBUS",
                  "state": "OH",
                  "zipOrPostalCode": "43215",
                  "country": "US",
                  "geoPosition": {
                    "latitude": 39.963070,
                    "longitude": -82.997600
                   }
             },
                "seedInput": {
                  "companyName": "Bold Penguin Inc.",
                  "address": {
                          "streetAddr": "100 East Broad St",
                          "city": "Columbus",
                          "state": "OH",
                          "zipOrPostalCode": "43215",
                          "country": ""
                  }
                }
    },
    "data": {
              "company_id": "CUSDD97T2FAE114E52240",
              "company_name": "BOLD PENGUIN INC.",
              "dba_aka": [],
              "contact_name": [],
              "phone_number": "1-6143441029",
              "website": "https://www.boldpenguin.com/",
              "email_id": "",
              "address": "100 East Broad St",
              "city": "Columbus",
              "state": "OH",
              "postal_code": "43215",
              "fein": "",
              "legal_entity_type": "",
             "year_founded": "2016",
              "year_in_business": 6,
              "annual_revenue": "500.0",
              "annual_payroll": "500.0",
              "total_full_time_employees": "250",
              "primary_naics_2012": [{
                    "code": "111111",
                    "desc": "Awesome Insurance Companies"
            }],
                           "secondary_naics_2012": [{
                     "code": "238170",
                     "desc": "Flashing contractors"
            },{
                     "code": "238170",
                     "desc": "Siding contractors"
            },{
                     "code": "238220",
                     "desc": "plumbing, heating, and air-conditioning contractors"
            },{
                     "code": "236220",
                     "desc": "commercial and institutional building construction"
            }],
              "country": "US",
              "company_description": [],
              "ppp_loan_size": ""
    },
    "scores": {
            "website": "86.21",
            "year_founded": "72.84",
            "year_in_business": "72.84",
            "annual_revenue": "69.90",
            "annual_payroll": "80.64",
            "total_full_time_employees": "80.64",
            "primary_naics_2012": "75.59"
    }
}

Response Parameters

JSON Parameters

meta data

Data Elements	Type	Description
tx_id	String	Unique transaction Id for every request
tx_start_time	String	Transaction start time
tx_end_time	String	Transaction end time
response_time_secs	Float	Transaction response time in seconds
data_package_id	String	Reference Id to the subscribed data points
tenant_id	String	Tenant Id
user_id	String	User Id
c_report_id	String	Unique Id generated for the company report
l_report_id	String	Unique Id generated for the location report

seed_input

Data Elements	Type	Description
company_name	String	Company name as given in the request
address	String	Address as given in the request

cleansed_input

Data Elements	Type	Description
companyName	String	Cleansed Company Name
website	String	Company website
phoneNumber	String	Company Phone Number
confidence_score	Float	Confidence Score for the cleansed address. The value ranges between 0-100
address.streetAddr	String	Cleansed Street Address
address.city	String	Cleansed City
address.state	String	Cleansed State
address.zipOrPostalCode	String	Cleansed Postal Code
address.country	String	Cleansed Country
address.placeId	String	Places Id from Google Maps
address.geoPosition.latitude	Float	Latitude coordinate for the address
address.geoPosition.longitude	Float	Longitude coordinate for the address

connector_crawl_status

Data Elements	Type	Description
completed	Integer	Total Connectors that are crawled successfully
failed	Integer	Total Connectors that failed to crawled
in_progress	Integer	Total Connectors that are still in the process of crawling
not_triggered	Integer	Total Connectors that are not triggered

Data

All the subscribed data points are listed in the "data" : {} object.

For a detailed description of the data points, please refer to the Data Dictionary.

Scores

A score is generated against all the triangulated data points which is shown as part of the "scores":{} object.

Response Codes against Data Point

Response Code	Type	Description
NO_DATA	String	Data not found for the data point

Examples

Example Request

{
   "company_name": "Bold Penguin",
   "address": "100 E Broad St, Columbus, OH 43215"
}

Example Responses

Sample Successful Response

{
    "tx_id": "test-5417ccc8-8f7f-4010-b2e1-9634a671d096",
    "tx_start_time": "2021-02-19T16:41:50.466869+00:00",
    "tx_end_time": "2021-02-19T16:41:57.131975+00:00",
    "response_time_secs": 6.665106,
    "data_package_id": "20410120",
    "tenant_id": "kowalski",
    "user_id": "kowalski",
    "c_report_id": "CUS1187A2AAE214E4540",
    "seed_input": {
        "company_name": "Bold Penguin",
        "address": "100 E Broad St, Columbus, OH 43215"
    },
    "cleansed_input": {
        "companyName": "Bold Penguin",
        "website": "http://boldpenguin.com/",
        "phoneNumber": "(614) 344-1029",
        "confidence_score": 0.95,
        "address": {
            "streetAddr": "100 E Broad St 15th floor",
            "city": "Columbus",
            "state": "OH",
            "zipOrPostalCode": "43215",
            "country": "US",
            "placeId": "ChIJq6q2PjKPOIgRbnZUv4AsHX8",
            "geoPosition": {
                "latitude": 39.96307950000001,
                "longitude": -82.99746379999999
            }
        }
    },
    "connector_crawl_status": {
        "completed": 5,
        "failed": 0,
        "inprogress": 0,
        "not_triggered": 3
    },
    "data": {
        "company_id": "1185927A8FA5C8101",
        "company_name": "Bold Penguin",
        "phone_number": "6146992114",
        "website": "www.boldpenguin.com",
        "address": "100 E BROAD ST",
        "city": "COLUMBUS",
        "state": "OH",
        "postal_code": "43215",
             "primary_naics_2017": [
            {
                "code": "524210",
                "desc": "Life insurance agencies"
            }
        ],
        "secondary_naics_2017": [
            {
                "code": "524298",
                "desc": "All Other Insurance Related Activities"
            },
            {
                "code": "531210",
                "desc": "Offices of Real Estate Agents and Brokers"
            },
            {
                "code": "524291",
                "desc": "Claims Adjusting"
            }
        ],
        "year_founded": "2016",
        "annual_revenue": "34458426",
        "total_full_time_employees": "59",
        "primary_naics_2012": [
            {
                "code": "524210",
                "desc": "Insurance Agencies and Brokerages"
            }
        ],
        "secondary_naics_2012": [
            {
                "code": "524298",
                "desc": "Insurance exchanges"
            },
            {
                "code": "524210",
                "desc": "Agencies, insurance"
            },
            {
                "code": "524210",
                "desc": "Brokerages, insurance"
            },
            {
                "code": "524210",
                "desc": "Brokers' offices, insurance"
            },
            {
                "code": "524210",
                "desc": "Insurance agencies"
            },
            {
                "code": "524210",
                "desc": "Insurance brokerages"
            },
            {
                "code": "524210",
                "desc": "Life insurance agencies"
            },
            {
                "code": "531210",
                "desc": "Offices of Real Estate Agents and Brokers"
            },
            {
                "code": "524291",
                "desc": "Claims Adjusting"
            }
        ]
    },
    "scores": {
        "primary_naics_2017": "82.42",
        "year_founded": "75.59",
        "annual_revenue": "75.59",
        "total_full_time_employees": "75.59",
        "primary_naics_2012": "82.42"
    }
}

Sample Error Response

{
    "error_code": "ERR_100",
    "error_description": "address is not valid",
    "seed_input": {
        "company_name": "Bold Penguin Inc.",
        "address": "100 East Broad St, Columbus, OH 43215"
    },
    "tx_id": "test-ef35d41f-9914-4608-a363-6b14728fa63c",
    "tx_start_time": "2021-01-19T17:16:31.598573+00:00",
    "tenant_id": "test",
    "user_id": "test"
}

Error Codes

Error Code	Type	Error Category	Description
ERR_100	String	INVALID_INPUT	The input from the request which is invalid or unable to read
ERR_200	String	API_ERROR	Any exception which is not handled as part of the business logic while processing the request
ERR_300	String	INTEGRATION_ERROR	Errors while communicating with the downstream services
ERR_400	String	DB_ERROR	Communication failures with the databases
ERR_700	String	TIMEOUT_ERROR	The request wait timeouts
ERR_800	String	SERVICE_UNAVAILABLE	Error when the dependent services are unavailable
ERR_900	String	UNKNOWN	Any error which does not fall in to the above categories

Data Dictionary

Description​

Authentication​

Endpoint​

Staging​

Production​

Sample Quick Submit Request​

Sample Quick Submit Response​

Response Parameters​

JSON Parameters​

Response Codes against Data Point​

Examples​

Example Request​

Example Responses​

Sample Successful Response​

Sample Error Response​

Error Codes​