GET: Compare Client to the Underwriting Guidelines Ingrid https://api.bitsighttech.com/ratings/v1/companies/client_guid/underwriting-guidelines Compare a client’s risk vectors and their grades to your underwriting guidelines. Parameters * Required. guid * Required. [Path] Identify the client to query. Value: [String] Client’s unique identifier [entity_guid]. See GET: Portfolio Details. Example Request curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/underwriting-guidelines -u api_token: Example Response { "risk_vector_count": 3, "passed": [ { "name": "Web Application Headers", "slug": "application_security", "grade": "A" }, ], "failed": [ […] { "name": "Desktop Software", "slug": "desktop_software", "grade": "F" } ], "ungraded": [], "threat_groups_count": 4, "threat_groups_detected_count": 1, "threats_count": 40, "threats_detected_count": 10, "threat_groups_detected": [ { "guid": "a940bb61-33c4-42c9-9231-c8194c305db3" }, […] ], "threats_detected": [ { "guid": "a940bb61-33c4-42c9-9231-c8194c305db3" }, "infections_count": 20, "infections_detected": [ { "id: 134 }, ] } Response Attributes Field Description risk_vector_count Integer The number of compared risk vectors. passed Array Risk vectors that have a grade bigger or equal to the minimum grade in the underwriting guideline. Object A risk vector. name String This risk vector’s name. slug String This risk vector’s slug name. grade String This risk vector’s letter grade. failed Array Risk vectors that have a lower grade than the minimum set in the guideline. Object A risk vector. name String This risk vector’s name. slug String This risk vector’s slug name. grade String This risk vector’s letter grade. ungraded Array Risk vectors that don’t have a defined grade. Object A risk vector. name String This risk vector’s name. slug String This risk vector’s slug name. grade String This risk vector’s letter grade. threat_groups_count Integer The number of threat groups on this underwriting guideline. threat_groups_detected_count Integer The number of threat groups detected on the client. threats_count Integer The number of threats on this underwriting guideline. threats_detected_count Integer The number of threats that were detected on the client. threat_groups_detected Array Threat groups that were detected on the company. Object The threat group details. guid String [threat_group_guid] The unique identifier of the threat group. threats_detected Array Threats that were detected on the company. Object The threat details. guid String [threat_guid] The unique identifier of the threat. infections_detected Array A list of selected infections that are detected on the company.. Object The infection details. id String The unique identifier of the infection. Status Codes 200 – Okay Everything worked as expected. 401 – No Authentication No valid API token was provided. 403 – Unauthorized You do not have permission to access this resource. 404 – Not Found The specified resource could not be found. May 16, 2024: threat_groups_detected & threats_detected. April 9, 2024: threats & threat_groups. May 1, 2023: Published. Related articles Cyber Insurance API Guide GET: Underwriting Guidelines PATCH: Highlight Primary or Assign Custom ID GET: Portfolio Details Endpoints Feedback 0 comments Please sign in to leave a comment.