Create Quote API Enhanced to Call Credit Vendors

Requests sent to the create_quote_extended API can include an optional request flag to call BriteCore integrated third-party credit vendors to pull credit reports for any named insured included in the payload. 

What’s changing?

  • An optional hook in the create_quote_extended API will call the requester’s integrated credit vendor when a retrieve_credit_report = true request flag is included in the payload for any named insured.
  • When the request flag is included on a named insured the requester can define, in seconds, the amount of time the API should wait for the credit vendor to respond before timing out by adding a retrieve_credit_report_timeout parameter
    • If the parameter is not defined within the request the API timeout will default to 30 seconds.
  • When the API calls the credit vendor and receives a successful response it will add the credit report to the named insured contact. Once the credit report is available on the named insured contact, the rating process will map the credit report(s) to the appropriate credit tier that is defined within the line setup which will be used towards determining the rate within the response.
  • When the API calls the credit vendor and the request fails no data will be added to the named insured contact and the default rating value defined within lines will be used towards determining the rate within the response.  
    • A message (“Credit vendor failed”) will be returned along with the rate to advise the requester that the call to the vendor failed. 
    • A second message will indicate the error returned from the credit vendor.
  • When the API calls the credit vendor and the request times out no data will be added to the named insured contact and the default rating value defined within lines will be used towards determining the rate within the response.  
    • A message (“Credit vendor timed out”) will be returned along with the rate to advise the requester that the call to the vendor timed out.
  • When a request is received to the API which includes the retrieve_credit_report parameter the request will be logged. This will be regardless of if the parameter is true or false.
  • When exceptions are received when calling the vendor, logs will be captured so that users can understand why the API used the default credit rating value. The error received from the credit vendor will be captured within the log. 
    • A note will be added to the quote/policy advising of the failure and/or timeout. 

How does this impact you?

  • Clients can opt-in via an API request to trigger the call to their integrated credit vendor by adding the request flag at the named insured level to the payload that is sent in the request. 
  • This functionality will only apply to existing BriteCore integrated third-party credit vendors.
  • The vendor must be enabled within the client’s BriteCore instance along with defined credit tiers within the line setup.

Where to direct questions?

  • Please contact your Customer Success Manager with any questions.