NordStellar Company Risk Scoring API

{"openapi":"3.1.0","info":{"title":"Company Risk Scoring API","version":"0.1.0","description":"**Company Risk Scoring API v0.1.0**\n\nThis API provides a comprehensive service for evaluating the cybersecurity risk associated with external companies, primarily identified by their domain name. It's designed for B2B use cases like vendor risk management, cyber insurance underwriting, or competitive analysis.\n\n**Key Features:**\n\n* **Company Onboarding:** Add companies to the system for monitoring, either automatically by domain or manually with additional details.\n* **Security Scanning:** Initiate asynchronous scans against a company's domain to gather security data. Track scan job progress.\n* **Detailed Risk Categories:** Retrieve granular security assessment results for specific areas:\n    * Software Patching & Vulnerabilities\n    * Web Application Security\n    * Email Security (SPF, DMARC)\n    * System Reputation (IP blacklisting, abuse reports)\n    * SSL/TLS Configuration Strength\n    * System Hosting Environment (Cloud/CDN usage, ISP diversity)\n    * Data Breach History (Exposed credentials, breach dates)\n* **Overall Security Score:** Get a consolidated security score derived from individual category assessments.\n* **Company Firmographics:** Access essential company details like name, website, revenue, employee count, location, industry, and more.\n* **Flexible Data Retrieval:** Fetch results for individual risk categories or retrieve a combined report with all data points for a specific domain and scan job.\n* **Search & Listing:** List onboarded companies with pagination and search capabilities.\n\n**Authentication:**\n\nAccess requires either an API Key provided in the `X-API-Key` header or standard HTTP Basic Authentication."},"paths":{"/api/b2b/crs/company-details/list":{"get":{"tags":["Company Details"],"summary":"List Company Details","operationId":"list_company_details_api_b2b_crs_company_details_list_get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDetailsListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/company-details/{domain}":{"get":{"tags":["Company Details"],"summary":"Domain Company Details","operationId":"domain_company_details_api_b2b_crs_company_details__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDetails"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/software-patching/{domain}":{"get":{"tags":["Results"],"summary":"Domain Software Patching","operationId":"domain_software_patching_api_b2b_crs_software_patching__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwarePatching"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/web-application-security/{domain}":{"get":{"tags":["Results"],"summary":"Domain Web Application Security","operationId":"domain_web_application_security_api_b2b_crs_web_application_security__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebApplicationSecurity"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/email-security/{domain}":{"get":{"tags":["Results"],"summary":"Domain Email Security","operationId":"domain_email_security_api_b2b_crs_email_security__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSecurity"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/system-reputation/{domain}":{"get":{"tags":["Results"],"summary":"Domain System Reputation","operationId":"domain_system_reputation_api_b2b_crs_system_reputation__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemReputation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/ssl-configuration/{domain}":{"get":{"tags":["Results"],"summary":"Domain Ssl Configuration","operationId":"domain_ssl_configuration_api_b2b_crs_ssl_configuration__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSLConfiguration"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/system-hosting/{domain}":{"get":{"tags":["Results"],"summary":"Domain System Hosting","operationId":"domain_system_hosting_api_b2b_crs_system_hosting__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemHosting"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/data-breach/{domain}":{"get":{"tags":["Results"],"summary":"Domain Data Breach","operationId":"domain_data_breach_api_b2b_crs_data_breach__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataBreach"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/scan/submit/{domain}":{"post":{"tags":["Scanning"],"summary":"Submit Scan","operationId":"submit_scan_api_b2b_crs_scan_submit__domain__post","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitScanResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/company-details/onboard/{domain}":{"post":{"tags":["Company Details"],"summary":"Onboard Company","operationId":"onboard_company_api_b2b_crs_company_details_onboard__domain__post","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyOnboardingResponse"}}}},"404":{"description":"Company details were not found and the company onboarding failed"},"409":{"description":"Company already onboarded, request can't be repeated"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/company-details/manual/onboard/":{"post":{"tags":["Company Details"],"summary":"Manual Onboard Company","operationId":"manual_onboard_company_api_b2b_crs_company_details_manual_onboard__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyOnboardingManualRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyOnboardingResponse"}}}},"404":{"description":"Company details were not found and the company onboarding failed"},"409":{"description":"Company already onboarded, request can't be repeated"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}]}},"/api/b2b/crs/scan/jobs/{domain}":{"get":{"tags":["Scanning"],"summary":"Get Scan Jobs For Domain","operationId":"get_scan_jobs_for_domain_api_b2b_crs_scan_jobs__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanJobsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/b2b/crs/combined/{domain}":{"get":{"tags":["Results"],"summary":"Domain Results Combined","operationId":"domain_results_combined_api_b2b_crs_combined__domain__get","security":[{"APIKeyHeader":[]},{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"scan_job_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CombinedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CEOData":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the CEO"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the CEO"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the CEO"}},"type":"object","title":"CEOData"},"CategoryScores":{"properties":{"software_patching":{"type":"number","title":"Software Patching","default":10},"web_application_security":{"type":"number","title":"Web Application Security","default":10},"email_security":{"type":"number","title":"Email Security","default":10},"system_reputation":{"type":"number","title":"System Reputation","default":10},"system_hosting":{"type":"number","title":"System Hosting","default":10},"data_breach":{"type":"number","title":"Data Breach","default":10},"ssl_configuration":{"type":"number","title":"Ssl Configuration","default":10}},"type":"object","title":"CategoryScores"},"CombinedResponse":{"properties":{"company_details":{"$ref":"#/components/schemas/CompanyDetails"},"security_score":{"$ref":"#/components/schemas/SecurityScore"},"software_patching":{"$ref":"#/components/schemas/SoftwarePatching"},"web_application_security":{"$ref":"#/components/schemas/WebApplicationSecurity"},"email_security":{"$ref":"#/components/schemas/EmailSecurity"},"system_reputation":{"$ref":"#/components/schemas/SystemReputation"},"ssl_configuration":{"$ref":"#/components/schemas/SSLConfiguration"},"system_hosting":{"$ref":"#/components/schemas/SystemHosting"},"data_breach":{"$ref":"#/components/schemas/DataBreach"}},"type":"object","required":["company_details","security_score","software_patching","web_application_security","email_security","system_reputation","ssl_configuration","system_hosting","data_breach"],"title":"CombinedResponse"},"CompanyDetails":{"properties":{"name":{"type":"string","title":"Name","description":"Full name of the company","default":""},"shorthand_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shorthand Name","description":"Short or common name of the company"},"website":{"type":"string","title":"Website","description":"Official website of the company","default":""},"domain":{"type":"string","title":"Domain","description":"Primary domain name of the company","default":""},"revenue":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Revenue","description":"Annual revenue of the company in USD","default":0},"revenue_range":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revenue Range","description":"Range of the company's annual revenue"},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type","description":"Type of company (e.g., Private, Public)"},"employee_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Employee Count","description":"Number of employees in the company","default":0},"employee_count_range":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Employee Count Range","description":"Range of the number of employees"},"year_founded":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Year Founded","description":"Year the company was established"},"location_data":{"anyOf":[{"$ref":"#/components/schemas/LocationData"},{"type":"null"}],"description":"Detailed location information of the company"},"contact_data":{"anyOf":[{"$ref":"#/components/schemas/ContactData"},{"type":"null"}],"description":"Social media contact information"},"ceo_data":{"anyOf":[{"$ref":"#/components/schemas/CEOData"},{"type":"null"}],"description":"Information about the company's CEO"},"competitor_list":{"items":{"type":"object"},"type":"array","title":"Competitor List","description":"List of company's competitors"},"funding_list":{"items":{"type":"object"},"type":"array","title":"Funding List","description":"List of funding rounds or investments"},"industry_list":{"items":{"type":"string"},"type":"array","title":"Industry List","description":"List of industries the company operates in"},"related_company_list":{"items":{"type":"string"},"type":"array","title":"Related Company List","description":"List of related companies"},"related_company_domain_list":{"items":{"type":"string"},"type":"array","title":"Related Company Domain List","description":"List of domains of related companies"},"total_funding":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Funding","description":"Total funding received by the company"},"linkedin_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkedin Description","description":"Company description from LinkedIn"},"owler_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owler Description","description":"Company description from Owler"},"g2_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"G2 Description","description":"Company description from G2"}},"type":"object","title":"CompanyDetails","examples":[{"ceo_data":{"first_name":"Jane","last_name":"Doe","title":"CEO"},"company_type":"Private","competitor_list":[{"name":"Example Competitor A","url":"https://www.example.com/competitorA"},{"name":"Example Competitor B","url":"https://www.example.com/competitorB"}],"contact_data":{"facebook":"https://www.facebook.com/ExampleCompany","linkedin":"https://www.linkedin.com/company/examplecompany/"},"domain":"examplecorp.com","employee_count":1500,"employee_count_range":"1,001-5,000 employees","funding_list":[],"industry_list":["Technology Solutions","Cloud Services","Data Analytics"],"linkedin_description":"About ExampleCorp\n\nExampleCorp is a leading provider of innovative technology solutions, helping businesses transform their operations. We deliver cutting-edge cloud services and data analytics to drive growth and efficiency. Our goal is to empower our clients with the tools they need to succeed in the digital age. \n\nWe are committed to excellence, collaboration, and sustainable practices. Join us in shaping the future of technology.","location_data":{"city":"Techville","country_code":"US","country_name":"United States","full_address":"123 Innovation Drive, Techville, CA 90210","state":"California","street":"123 Innovation Drive","zipcode":"90210"},"name":"ExampleCorp Inc.","owler_description":"ExampleCorp provides B2B technology solutions, focusing on cloud infrastructure and data management services for various industries.","g2_description":"ExampleCorp is highly rated on G2 for its customer support and ease of use in the cloud services category.","related_company_domain_list":[],"related_company_list":[],"revenue":500000000,"revenue_range":"$500M - $1B (USD)","shorthand_name":"examplecorp","website":"https://www.examplecorp.com","year_founded":"2010"}]},"CompanyDetailsListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CompanyDetails"},"type":"array","title":"Data"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["data","total","limit","offset"],"title":"CompanyDetailsListResponse"},"CompanyOnboardingManualRequest":{"properties":{"domain":{"type":"string","title":"Domain"},"employee_count":{"type":"integer","title":"Employee Count"}},"type":"object","required":["domain","employee_count"],"title":"CompanyOnboardingManualRequest"},"CompanyOnboardingResponse":{"properties":{"domain":{"type":"string","title":"Domain"},"company_details":{"anyOf":[{"$ref":"#/components/schemas/CompanyDetails"},{"type":"null"}]}},"type":"object","required":["domain"],"title":"CompanyOnboardingResponse"},"ContactData":{"properties":{"facebook":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Facebook","description":"Company's Facebook page URL"},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkedin","description":"Company's LinkedIn page URL"}},"type":"object","title":"ContactData"},"DataBreach":{"properties":{"security_score":{"type":"number","title":"Security Score","description":"Overall security score for data breach assessment (0-10)","default":10},"total_incidents":{"type":"integer","title":"Total Incidents","description":"Key issue count: Total number of data breach incidents detected","default":0},"exposed_data_points":{"items":{"type":"string"},"type":"array","title":"Exposed Data Points","description":"Types of data exposed in breaches"},"latest_breach_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Breach Date","description":"Date of the most recent breach (ISO format)"},"corporate_credential_count":{"type":"integer","title":"Corporate Credential Count","description":"Number of corporate credentials found in breaches"},"total_credential_count":{"type":"integer","title":"Total Credential Count","description":"Total number of credentials found in breaches"},"password_reuse_count":{"type":"integer","title":"Password Reuse Count","description":"Number of reused passwords detected"},"password_reuse_count_per_employee":{"type":"integer","title":"Password Reuse Count Per Employee","description":"Number of employees who reuse passwords"},"unique_email_count":{"type":"integer","title":"Unique Email Count","description":"Number of unique email addresses found in breaches"},"days_since_latest_breach":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Days Since Latest Breach","description":"Number of days since the most recent breach"},"total_exposed_records":{"type":"integer","title":"Total Exposed Records","description":"Total number of records exposed in all breaches"},"corporate_credential_percentage":{"type":"number","title":"Corporate Credential Percentage","description":"Percentage of corporate credentials among all exposed credentials"},"password_reuse_percentage":{"type":"number","title":"Password Reuse Percentage","description":"Percentage of passwords that are reused"}},"type":"object","required":["exposed_data_points","corporate_credential_count","total_credential_count","password_reuse_count","password_reuse_count_per_employee","unique_email_count","total_exposed_records","corporate_credential_percentage","password_reuse_percentage"],"title":"DataBreach","examples":[{"corporate_credential_count":445,"corporate_credential_percentage":3.47,"days_since_latest_breach":0,"exposed_data_points":["email","password","name","address","phone","date_of_birth"],"latest_breach_date":"2024-08-14T07:24:49.079000","password_reuse_count":63,"password_reuse_percentage":12.52,"security_score":0,"total_credential_count":12838,"total_exposed_records":12838,"total_incidents":1114,"unique_email_count":503}]},"EmailSecurity":{"properties":{"security_score":{"type":"number","title":"Security Score","description":"Overall security score for email security (0-10)","default":10},"total_issues":{"type":"integer","title":"Total Issues","description":"Key issue count: Total number of email security issues detected","default":0},"total_potentially_spoofable":{"type":"integer","title":"Total Potentially Spoofable","description":"Number of domains potentially vulnerable to email spoofing","default":0},"total_spoofable":{"type":"integer","title":"Total Spoofable","description":"Number of domains definitely vulnerable to email spoofing","default":0},"total_non_spoofable":{"type":"integer","title":"Total Non Spoofable","description":"Number of domains not vulnerable to email spoofing","default":0},"scan_results":{"items":{"$ref":"#/components/schemas/EmailSecurityScanResults"},"type":"array","title":"Scan Results","description":"Detailed results of email security scans"}},"type":"object","title":"EmailSecurity","examples":[{"scan_results":[{"dmarc_policy":"none","dmarc_record":"v=DMARC1; p=none; rua=mailto:dmarc@examplecorp.com; ruf=mailto:dmarc@examplecorp.com; fo=1","domain":"examplecorp.com","spf_record":"v=spf1 include:spf.protection.outlook.com include:_spf.mlsend.com include:spf.serveriai.lt include:_spf.google.com include:_spf-dc55.sapsf.eu include:mail.zendesk.com ip4:192.0.2.1 ip4:192.0.2.2 ip4:192.0.2.3  -all","spoofable":4,"spoofable_comment":"Spoofing might be possible (mailbox dependent) for this domain."}],"security_score":9.74,"total_potentially_spoofable":2,"total_spoofable":0}]},"EmailSecurityScanResults":{"properties":{"domain":{"type":"string","title":"Domain"},"spf_record":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spf Record"},"dmarc_record":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dmarc Record"},"dmarc_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dmarc Policy"},"spoofable":{"type":"integer","title":"Spoofable"},"spoofable_comment":{"type":"string","title":"Spoofable Comment","default":""}},"type":"object","required":["domain","spoofable"],"title":"EmailSecurityScanResults"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LocationData":{"properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City where the company is located"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or region where the company is located"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"Street address of the company"},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code of the company's location"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Two-letter country code"},"country_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Name","description":"Full name of the country"},"full_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Address","description":"Complete address of the company"}},"type":"object","title":"LocationData"},"RiskCategory":{"type":"string","enum":["INFO","LOW","MEDIUM","HIGH","CRITICAL"],"title":"RiskCategory"},"SSLConfiguration":{"properties":{"security_score":{"type":"number","title":"Security Score","description":"Overall security score for SSL/TLS configuration (0-10)","default":10},"total_issues":{"type":"integer","title":"Total Issues","description":"Key issue count: Total number of SSL/TLS configuration issues detected","default":0},"issue_totals_by_criteria":{"allOf":[{"$ref":"#/components/schemas/SSLConfigurationIssueBrakedown"}],"description":"Breakdown of issues by different SSL/TLS criteria"},"issues":{"items":{"$ref":"#/components/schemas/SSLConfigurationIssue"},"type":"array","title":"Issues","description":"Detailed list of SSL/TLS configuration issues"}},"type":"object","title":"SSLConfiguration","examples":[{"issue_totals_by_criteria":{"certificate_path_validation":6,"certificate_signatures":26,"certificate_types":26,"ciphers":26,"ciphersuites":0,"maximum_certificate_lifespan":9,"tls_versions":26,"tls_vulnerability_renegotiation":0},"issues":[{"criteria":"certificate_types","description":"Deployed certificate types are {'rsa'}, should have at least one of {'ecdsa'}.","instances":["auth-admin.partners.examplecorp.com","external-api.partners.examplecorp.com"]}],"security_score":2.14,"total_issues":119}]},"SSLConfigurationIssue":{"properties":{"criteria":{"type":"string","title":"Criteria"},"description":{"type":"string","title":"Description"},"instances":{"items":{"type":"string"},"type":"array","title":"Instances"}},"type":"object","required":["criteria","description"],"title":"SSLConfigurationIssue"},"SSLConfigurationIssueBrakedown":{"properties":{"certificate_path_validation":{"type":"integer","title":"Certificate Path Validation","default":0},"maximum_certificate_lifespan":{"type":"integer","title":"Maximum Certificate Lifespan","default":0},"certificate_types":{"type":"integer","title":"Certificate Types","default":0},"certificate_signatures":{"type":"integer","title":"Certificate Signatures","default":0},"tls_versions":{"type":"integer","title":"Tls Versions","default":0},"ciphers":{"type":"integer","title":"Ciphers","default":0},"ciphersuites":{"type":"integer","title":"Ciphersuites","default":0},"tls_vulnerability_renegotiation":{"type":"integer","title":"Tls Vulnerability Renegotiation","default":0},"tls_vulnerability_robot":{"type":"integer","title":"Tls Vulnerability Robot","default":0}},"type":"object","title":"SSLConfigurationIssueBrakedown"},"ScanJobResult":{"properties":{"id":{"type":"string","title":"Id"},"date_created":{"type":"string","format":"date-time","title":"Date Created"},"date_updated":{"type":"string","format":"date-time","title":"Date Updated"},"finished":{"type":"boolean","title":"Finished"},"cancelled":{"type":"boolean","title":"Cancelled","default":false}},"type":"object","required":["id","date_created","date_updated","finished"],"title":"ScanJobResult"},"ScanJobsResponse":{"properties":{"domain":{"type":"string","title":"Domain"},"scan_jobs":{"items":{"$ref":"#/components/schemas/ScanJobResult"},"type":"array","title":"Scan Jobs"}},"type":"object","required":["domain","scan_jobs"],"title":"ScanJobsResponse"},"SecurityScore":{"properties":{"date_created":{"type":"string","format":"date-time","title":"Date Created"},"overall_score":{"type":"number","title":"Overall Score","description":"Overall security score across all categories"},"category_scores":{"allOf":[{"$ref":"#/components/schemas/CategoryScores"}],"description":"Individual security scores for each category"},"highlights":{"items":{"$ref":"#/components/schemas/SecurityScoreHighlight"},"type":"array","title":"Highlights","description":"List of key security highlights"}},"type":"object","required":["overall_score","category_scores"],"title":"SecurityScore","examples":[{"category_scores":{"data_breach":0,"email_security":9.741935483870968,"software_patching":6.107966243429646,"ssl_configuration":2.141767839011238,"system_hosting":8.4375,"system_reputation":10,"web_application_security":9.77832064907286},"highlights":[{"category":"data_breach","description":"445 corporate credentials stolen","index":0},{"category":"data_breach","description":"Recent data breach: 0 days ago","index":1},{"category":"data_breach","description":"13% employees reuse breached passwords","index":2},{"category":"ssl_configuration","description":"119 SSL configuration issues found","index":6},{"category":"software_patching","description":"2 critical vulnerabilities found","index":3},{"category":"software_patching","description":"3 high-risk vulnerabilities detected","index":4},{"category":"system_hosting","description":"Only 0% of systems CDN-protected","index":7},{"category":"email_security","description":"2 domains potentially spoofable","index":5}],"overall_score":5.789391684921029}]},"SecurityScoreHighlight":{"properties":{"category":{"type":"string","title":"Category","description":"Category of the security highlight"},"description":{"type":"string","title":"Description","description":"Description of the security highlight"},"index":{"type":"integer","title":"Index","description":"Index of the highlight for ordering"}},"type":"object","required":["category","description","index"],"title":"SecurityScoreHighlight"},"Service":{"properties":{"port":{"type":"integer","title":"Port"},"count":{"type":"integer","title":"Count"},"service":{"type":"string","title":"Service"},"instances":{"items":{"type":"string"},"type":"array","title":"Instances"}},"type":"object","required":["port","count","service","instances"],"title":"Service"},"SoftwarePatching":{"properties":{"security_score":{"type":"number","title":"Security Score","description":"Overall security score for software patching (0-10)","default":10},"total_vulnerabilities":{"type":"integer","title":"Total Vulnerabilities","description":"Key issue count: Total number of vulnerabilities found across all systems","default":0},"critical_vulnerabilities":{"type":"integer","title":"Critical Vulnerabilities","description":"Number of critical vulnerabilities (CVSS score >= 9)","default":0},"high_vulnerabilities":{"type":"integer","title":"High Vulnerabilities","description":"Number of high vulnerabilities (7 <= CVSS score < 9)","default":0},"medium_vulnerabilities":{"type":"integer","title":"Medium Vulnerabilities","description":"Number of medium vulnerabilities (4 <= CVSS score < 7)","default":0},"low_vulnerabilities":{"type":"integer","title":"Low Vulnerabilities","description":"Number of low vulnerabilities (0 < CVSS score < 4)","default":0},"total_services":{"type":"integer","title":"Total S

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nord-security/refs/heads/main/openapi/nord-security-nordstellar-company-risk-scoring-api-openapi.json