{ "openapi": "3.0.3", "info": { "title": "Rankiteo API", "description": "The Rankiteo API", "termsOfService": "https://policies.gitbook.com", "contact": { "name": "API Support", "url": "https://gitbook.com/support", "email": "support@rankiteo.com" }, "version": "0.0.1-beta" }, "servers": [ { "url": "https://api.rankiteo.com", "description": "production" } ], "components": { "securitySchemes": { "KeyAuth": { "type": "apiKey", "name": "apikey", "in": "header" } } }, "security": [ { "KeyAuth": [] } ], "paths": { "/general-getdomain-by-linkedinid": { "get": { "summary": "Get specific domain by linkedin id", "tags": [ "General" ], "description": "Domain by linkedin id", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } } ], "responses": { "200": { "description": "Successful response containing domain information", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "company_name": { "type": "string", "example": "Google" }, "website": { "type": "string", "example": "https://goo.gle/3DLEokh" }, "domain": { "type": "string", "example": "goo.gle" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/general-getlinkedinid-by-companyname": { "get": { "summary": "Get linkedin id based on company name", "tags": [ "General" ], "description": "Linkedin Id by company name", "parameters": [ { "name": "company_name", "in": "query", "required": true, "description": "Company name identifier for the target company", "schema": { "type": "string", "example": "Google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing LinkedIn ID and company name", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "company_name": { "type": "string", "example": "ICEI - Istituto Cooperazione Economica Internazionale" }, "linkedin_id": { "type": "string", "example": "icei" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 2112 }, "total_items": { "type": "integer", "example": 21116 } } } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "required_params": { "summary": "Required parameter", "value": { "error": "company_name is a required parameter" } }, "not_found": { "summary": "Company not found", "value": { "error": "Company not found" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/general-getlinkedinid-by-domain": { "get": { "summary": "Get specific linkedin id by domain", "tags": [ "General" ], "description": "Linkedin Id by domain", "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "Domain name", "schema": { "type": "string", "example": "rankiteo.com" } } ], "responses": { "200": { "description": "Successful response containing LinkedIn ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "rankiteo" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "domain_not_found": { "summary": "Domain not found", "value": { "error": "Domain not found" } }, "required_params": { "summary": "Domain is a required parameter", "value": { "error": "domain is a required parameter" } }, "invalid_domain": { "summary": "Invalid domain", "value": { "error": "Invalid domain. Please check and provide a valid domain" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "not_found": { "summary": "Linkedin id not found", "value": { "error": "Linkedin id not found" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-add-subsidiary": { "post": { "summary": "Add manual subsidiary", "tags": [ "Monitor" ], "description": "Add manual subsidiary under parent subsidiary", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "scoring", "description": "Name of the subsidiary to be added" }, "website": { "type": "string", "example": "https://appler.co", "description": "Website of the subsidiary" }, "employees": { "type": "string", "example": 100, "description": "Employee number company have" }, "followers": { "type": "string", "example": 100, "description": "Follower number company have" }, "industry": { "type": "string", "example": "Cyber security", "description": "Industry type of the parent company. Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2" }, "sub_industry": { "type": "string", "example": "Cyber", "description": "Industry type of the subsidiary company. Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2" }, "linkedin_id": { "type": "string", "example": "Cyber", "description": "linkedin Id of the company" }, "parent_company_name": { "type": "string", "example": "Rankiteo", "description": "Name of the parent company" }, "parent_linkedin_id": { "type": "string", "example": "rankiteo", "description": "Linkedin Id of the parent company" } }, "required": [ "name", "website", "employees", "followers", "industry", "sub_industry" ] } } } }, "responses": { "201": { "description": "Successful response for add request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Subsidiary added successfully" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "invalid_json": { "summary": "Invalid JSON format", "value": { "error": "Invalid JSON format" } }, "unsupported_body_type": { "summary": "Unsupported body type", "value": { "error": "Unsupported body type" } }, "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "empty_subsidiary_name": { "summary": "Empty subsidiary name", "value": { "error": "subsidiary_name is required field and cannot be empty" } }, "invalid_website": { "summary": "Invalid website", "value": { "error": "website is required field and must be a valid URL" } }, "invalid_employees_numbers": { "summary": "Invalid employees numbers", "value": { "error": "employees_numbers is required field and must be an integer" } }, "invalid_followers_numbers": { "summary": "Invalid follower numbers", "value": { "error": "followers_numbers is required field and must be an integer" } }, "invalid_industry_type": { "summary": "Invalid industry type", "value": { "error": "industry_type is required field. Note - Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2" } }, "select_valid_industry_type": { "summary": "Select valid industry type", "value": { "error": "Please select a valid industry type from the following list- [Accommodation Services, Administrative and Support Services, Construction, Consumer Services, Education, Entertainment Providers, Farming, Ranching, Forestry, Financial Services, Government Administration, Holding Companies, Hospitals and Health Care, Manufacturing, Oil, Gas, and Mining, Professional Services, Real Estate and Equipment Rental Services, Retail, Technology, Information and Media, Transportation, Logistics, Supply Chain and Storage, Utilities, Wholesale]" } }, "invalid_sub_industry_type": { "summary": "Invalid sub industry type", "value": { "error": "sub_industry_type is required field. Note - Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2" } }, "sub_industry_type_not_found": { "summary": "Sub industry type not found", "value": { "error": "Sub-Industry Type Fundraising not found under Manufacturing. Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2" } }, "website_already_used": { "summary": "Website already used", "value": { "error": "Website already used by another subsidiary" } }, "parent_company_not_found": { "summary": "Parent company not found", "value": { "error": "parent_company_name not found for link" } }, "linkedin_id_already_used": { "summary": "Linkedin Id already used", "value": { "error": "Linkedin Id already used. It should be unique" } }, "name_already_used": { "summary": "name already used", "value": { "error": "Subsidiary name already used. It should be unique" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "Only POST method is allowed" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-delete-subsidiary": { "delete": { "summary": "Delete manual subsidiary", "tags": [ "Monitor" ], "description": "Delete manual subsidiary", "parameters": [ { "name": "subsidiary_id", "in": "query", "required": true, "description": "subsidiary id of company", "schema": { "type": "string", "example": "YOU_2660260" } } ], "responses": { "200": { "description": "Successful response for delete request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Subsidiary deleted successfully" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_subsidiary_id": { "summary": "Invalid subsidiary id", "value": { "error": "Invalid subsidiary id" } }, "subsidiary_associate_issue": { "summary": "Subsidiary Id association", "value": { "error": "Required subsidiary_id does not belong to linkedin id" } }, "required_param_subsidiary_id": { "summary": "subsidiary_id is a required parameter", "value": { "error": "subsidiary_id is a required parameter" } }, "subsidiary_not_found": { "summary": "Subsidiary id not found", "value": { "error": "Not able to find any subsidiary_id associated with your account" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "Only DELETE method is allowed" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-get-data-loss-prediction": { "get": { "summary": "Get data loss prediction", "tags": [ "Monitor" ], "description": "Get data loss prediction for 6 months or 12 months for a specific company", "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Period value is a timeframe. It can be 6 or 12. By default its value is 6", "schema": { "type": "number", "example": 6 } } ], "responses": { "200": { "description": "Data loss prediction response for three incident types - Cyber Attack, Human/System Error and Physical Attack", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "LinkedIn identifier for the company", "example": "google" }, "period": { "type": "integer", "description": "Timeframe of prediction", "example": 6 }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Incident type", "example": "Cyber Attack" }, "predicted_loss_upper_bound": { "type": "number", "format": "float", "description": "Upper bound of the prediction", "example": 6544536.4 }, "predicted_loss_lower_bound": { "type": "number", "format": "float", "description": "Lower bound of the prediction", "example": 4521529.57 }, "predicted_score": { "type": "number", "format": "float", "description": "Average predicted score", "example": 5464047.68 } } } }, "message": { "type": "string", "example": "No predictions available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "period": 6, "data": [ { "type": "Cyber Attack", "predicted_loss_upper_bound": 6544536.4, "predicted_loss_lower_bound": 4521529.57, "predicted_score": 5464047.68 }, { "type": "Human/System Error", "predicted_loss_upper_bound": 2470663.79, "predicted_loss_lower_bound": 1706947.4, "predicted_score": 2062762.57 }, { "type": "Physical Attack", "predicted_loss_upper_bound": 1721438.21, "predicted_loss_lower_bound": 1189317.82, "predicted_score": 1437232.51 } ] } }, "no_data": { "summary": "Response with message only", "value": { "message": "No predictions available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_period": { "summary": "Invalid Period", "value": { "error": "Period value should be 6 or 12" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-get-incident-prediction": { "get": { "summary": "Get incident prediction", "tags": [ "Monitor" ], "description": "Get incident prediction for 6 months or 12 months for a specific company", "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Period value is a timeframe. It can be 6 or 12. By default its value is 6", "schema": { "type": "number", "example": 6 } } ], "responses": { "200": { "description": "Incident prediction response for three incident types - Cyber Attack, Human/System Error and Physical Attack", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "period": { "type": "integer", "example": 6 }, "data": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number", "format": "float", "example": 22.24 }, "name": { "type": "string", "example": "Cyber Attack" } } } }, "message": { "type": "string", "example": "No predictions available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "period": 6, "data": [ { "value": 22.24, "name": "Cyber Attack" }, { "value": 2.88, "name": "Human/System Error" }, { "value": 0.44, "name": "Physical Attack" } ] } }, "no_data": { "summary": "Response with message only", "value": { "message": "No predictions available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_period": { "summary": "Invalid Period", "value": { "error": "Period value should be 6 or 12" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-get-subdomain-findings": { "get": { "summary": "Get subdomain findings", "tags": [ "Monitor" ], "description": "Subdomain findings list", "parameters": [ { "name": "subdomain", "in": "query", "required": true, "description": "subdomain of company", "schema": { "type": "string", "example": "google.com" } }, { "name": "risk_vector_type", "in": "query", "required": true, "description": "risk vector type", "schema": { "type": "string", "example": "DKIM" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomain findings and pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "rankiteo.com" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "rankiteo.com" }, "data": { "type": "array", "items": { "type": "object", "properties": { "finding_id": { "type": "string", "description": "Finding Id of the subdomain", "example": "664243450d23b168a7886afa" }, "vector_type": { "type": "string", "description": "Vector type of the subdomain", "example": "DKIM" }, "grade": { "type": "string", "description": "Grade of the vulnerability", "example": "Good" }, "info": { "type": "string", "description": "Info related to vector type", "example": "x-xss-protection" }, "port": { "type": "string", "description": "Open port of the subdomain website", "example": "NA" }, "internet_protocol": { "type": "string", "description": "Internet protocol subdomain website is using", "example": "DNS" }, "vulnerability": { "type": "string", "description": "Vulnerabily that subdomain have", "example": "NA" }, "information": { "type": "string", "description": "Information summary of the subdomain", "example": "NA" }, "remediation": { "type": "string", "description": "Remediation summary of the subdomain", "example": "Use OpenSSL or SSL implementation of your choice..." }, "sub_type": { "type": "string", "description": "Sub-type of the sobdomain", "example": "NA" }, "ip_address": { "type": "string", "description": "Ip address of the subsomain", "example": "NA" }, "domain": { "type": "string", "description": "Domain name of the linkedin id", "example": "rankiteo.com" }, "details": { "type": "object", "properties": { "dkim_records_state": { "type": "string", "description": "Record states", "example": "One record found" }, "dkim_records_details": { "type": "string", "description": "Record details", "example": "The DKIM key length is highly secure." } } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 5 }, "total_items": { "type": "integer", "example": 47 } } }, "message": { "type": "object", "example": { "data": { "subdomain_name": "rankiteo.com", "message": "No DKIM findings for this domain" } } } } }, "examples": { "with_data": { "summary": "Response with detailed data", "value": { "data": { "domain_name": "rankiteo.com", "subdomain": [ { "subdomain_name": "rankiteo.com", "data": [ { "finding_id": "664243450d23b168a7886afa", "vector_type": "DKIM", "grade": "Good", "info": "x-xss-protection", "port": "NA", "internet_protocol": "DNS", "vulnerability": "NA", "information": "NA", "remediation": "Use OpenSSL or SSL implementation of your choice...", "sub_type": "NA", "ip_address": "NA", "domain": "rankiteo.com", "details": { "dkim_records_state": "One record found", "dkim_records_details": "The DKIM key length is highly secure." } } ] } ] }, "pagination": { "current_page": 1, "page_size": 10, "total_pages": 5, "total_items": 47 } } }, "no_findings": { "summary": "No subdomain findings found", "value": { "data": { "subdomain_name": "rankiteo.com", "message": "No DKIM findings for this domain" } } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_sub_domain": { "summary": "Invalid subdomain", "value": { "error": "Invalid subdomain. Please check and provide a valid subdomain" } }, "domain_associate_issue": { "summary": "Domain association", "value": { "error": "Required domain does not belong to linkedin id" } }, "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company and its subdomain associated with your account" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "subdomain_required_params": { "summary": "Subdomain is required parameter", "value": { "error": "subdomain is a required parameter" } }, "risk_vector_type_required_params": { "summary": "risk_vector_type is required parameter", "value": { "error": "risk_vector_type is a required parameter" } }, "invalid_risk_vector_type": { "summary": "Invalid request", "value": { "error": "Invalid risk vector type. Valid choices are- 'SPF','DKIM','OPEN-PORTS','CERTIFICATE-CVE','CERTIFICATE-INFO','CERTIFICATE-CONF','WEB-APPLICATION-HEADER','DMARC'" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-get-tail-risk-estimation": { "get": { "summary": "Get tail risk estimation", "tags": [ "Monitor" ], "description": "Get tail risk estimation for 6 months or 12 months for a specific company", "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Period value is a timeframe. It can be 6 or 12. By default its value is 6", "schema": { "type": "number", "example": 6 } } ], "responses": { "200": { "description": "Tail risk estimation response for three incident types - Cyber Attack, Human/System Error and Physical Attack", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "LinkedIn identifier for the company", "example": "google" }, "period": { "type": "integer", "description": "Timeframe of prediction", "example": 6 }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Incident type", "example": "Cyber Attack" }, "value_at_risk_95": { "type": "number", "format": "float", "description": "Estimation for value at risk at 95%", "example": 6352860.13 }, "value_at_risk_99": { "type": "number", "format": "float", "description": "Estimation for value at risk at 99%", "example": 6774684.59 }, "expected_shortfall_95": { "type": "number", "format": "float", "example": 6386932.96, "description": "Estimation for expected shortfall at 95%" }, "expected_shortfall_99": { "type": "number", "format": "float", "description": "Estimation for expected shortfall at 99%", "example": 14562857.57 } } } }, "message": { "type": "string", "example": "No estimations available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "period": 6, "data": [ { "type": "Cyber Attack", "value_at_risk_95": 6352860.13, "value_at_risk_99": 6774684.59, "expected_shortfall_95": 6386932.96, "expected_shortfall_99": 14562857.57 }, { "type": "Human/System Error", "value_at_risk_95": 2398303.03, "value_at_risk_99": 2557548.29, "expected_shortfall_95": 2411166.05, "expected_shortfall_99": 5497704.14 }, { "type": "Physical Attack", "value_at_risk_95": 1671020.76, "value_at_risk_99": 1781975.1, "expected_shortfall_95": 1679983.08, "expected_shortfall_99": 3830532.52 } ] } }, "no_data": { "summary": "Response with message only", "value": { "message": "No estimations available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_period": { "summary": "Invalid Period", "value": { "error": "Period value should be 6 or 12" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getall-subdomain-findings": { "get": { "summary": "Get all subdomain findings", "tags": [ "Monitor" ], "description": "Subdomain findings list", "parameters": [ { "name": "subdomain", "in": "query", "required": true, "description": "subdomain of company", "schema": { "type": "string", "example": "google.com" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomain findings and pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "rankiteo.com" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "rankiteo.com" }, "data": { "type": "array", "items": { "type": "object", "properties": { "finding_id": { "type": "string", "description": "Finding Id of the subdomain", "example": "664243450d23b168a7886afa" }, "vector_type": { "type": "string", "description": "Vector type of the subdomain", "example": "DKIM" }, "grade": { "type": "string", "description": "Grade of the vulnerability", "example": "Good" }, "info": { "type": "string", "description": "Info related to vector type", "example": "x-xss-protection" }, "port": { "type": "string", "description": "Open port of the subdomain website", "example": "NA" }, "internet_protocol": { "type": "string", "description": "Internet protocol subdomain website is using", "example": "DNS" }, "vulnerability": { "type": "string", "description": "Vulnerabily that subdomain have", "example": "NA" }, "information": { "type": "string", "description": "Information summary of the subdomain", "example": "NA" }, "remediation": { "type": "string", "description": "Remediation summary of the subdomain", "example": "Use OpenSSL or SSL implementation of your choice..." }, "sub_type": { "type": "string", "description": "Sub-type of the sobdomain", "example": "NA" }, "ip_address": { "type": "string", "description": "Ip address of the subsomain", "example": "NA" }, "domain": { "type": "string", "description": "Domain name of the linkedin id", "example": "rankiteo.com" }, "details": { "type": "object", "properties": { "dkim_records_state": { "type": "string", "description": "Record states", "example": "One record found" }, "dkim_records_details": { "type": "string", "description": "Record details", "example": "The DKIM key length is highly secure." } } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 5 }, "total_items": { "type": "integer", "example": 47 } } }, "message": { "type": "object", "example": { "data": { "subdomain_name": "rankiteo.com", "message": "No findings for this domain" } } } } }, "examples": { "with_data": { "summary": "Response with detailed data", "value": { "data": { "domain_name": "rankiteo.com", "subdomain": [ { "subdomain_name": "rankiteo.com", "data": [ { "finding_id": "664243450d23b168a7886afa", "vector_type": "DKIM", "grade": "Good", "info": "x-xss-protection", "port": "NA", "internet_protocol": "DNS", "vulnerability": "NA", "information": "NA", "remediation": "Use OpenSSL or SSL implementation of your choice...", "sub_type": "NA", "ip_address": "NA", "domain": "rankiteo.com", "details": { "dkim_records_state": "One record found", "dkim_records_details": "The DKIM key length is highly secure." } } ] } ] }, "pagination": { "current_page": 1, "page_size": 10, "total_pages": 5, "total_items": 47 } } }, "no_findings": { "summary": "No subdomain findings found", "value": { "data": { "subdomain_name": "rankiteo.com", "message": "No findings for this domain" } } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_sub_domain": { "summary": "Invalid subdomain", "value": { "error": "Invalid subdomain. Please check and provide a valid subdomain" } }, "domain_associate_issue": { "summary": "Domain association", "value": { "error": "Required domain does not belong to linkedin id" } }, "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company and its subdomain associated with your account" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "required_params": { "summary": "Required parameter", "value": { "error": "subdomain is a required parameter" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getall-vulnerability-detection": { "get": { "summary": "Get all vulnerability detection for a specific company", "tags": [ "Monitor" ], "description": "Company vulnerability detection", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing LinkedIn ID and vulnerability detection data", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "apple" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "CVE-2021-43138" }, "severity": { "type": "number", "example": 7.8 }, "hostname": { "type": "string", "example": "pedocs.apple.com" }, "impact_score": { "type": "number", "example": 5.9 }, "last_seen": { "type": "string", "example": "2024-03-29" }, "subsidiaries": { "type": "string", "example": "apple.com" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 59 }, "slug": { "type": "string", "example": "javascript-libraries" }, "name": { "type": "string", "example": "JavaScript libraries" } } } }, "cpe": { "type": "string", "example": "cpe:2.3:a:linuxfoundation:dojo:1.15.0:*:*:*:*:node.js:*:*" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 1 }, "total_items": { "type": "integer", "example": 1 } } }, "message": { "type": "string", "example": "No vulnerabilty detection found for this Linkedin Id" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "data": [ { "id": "CVE-2021-43138", "severity": 7.8, "hostname": "pedocs.apple.com", "impact_score": 5.9, "last_seen": "2024-03-29", "subsidiaries": "apple.com", "categories": [ { "id": 59, "slug": "javascript-libraries", "name": "JavaScript libraries" } ], "cpe": "cpe:2.3:a:linuxfoundation:dojo:1.15.0:*:*:*:*:node.js:*:*" } ], "pagination": { "current_page": 1, "page_size": 1, "total_pages": 1, "total_items": 1 } } }, "no_data": { "summary": "Response with message only", "value": { "linkedin_id": "apple", "message": "No vulnerabilty detection found for this Linkedin Id" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompany-history": { "get": { "summary": "Get company history", "tags": [ "Monitor" ], "description": "Company history information", "responses": { "200": { "description": "Successful response containing history", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "apple" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string", "example": "apple" }, "type": { "type": "string", "example": "Cyber Attack" }, "severity": { "type": "integer", "example": 100 }, "impact": { "type": "string", "example": 5 }, "seen": { "type": "string", "example": "09/2015" }, "id": { "type": "string", "example": "GOO12961222" }, "blog_url": { "type": "string", "example": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/" }, "description": { "type": "string", "example": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites" }, "explanation": { "type": "string", "example": "Attack threatening the organization's existence" } } } } } } }, "message": { "type": "string", "example": "No history available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "incidents": [ { "entity": "Apple", "type": "Cyber Attack", "severity": 100, "impact": "5", "seen": "11/2022", "id": "GOO12961222", "blog_url": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/", "description": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites", "explanation": "Attack threatening the organization's existence" } ] } }, "no_data": { "summary": "Response with message only", "value": { "linkedin_id": "apple", "message": "No history available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanyapplicationsassets": { "get": { "summary": "Get company applications assets", "tags": [ "Monitor" ], "description": "Company asset informations", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing company information, applications, and pagination data", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "Unique identifier for the company on LinkedIn", "example": "google" }, "company_name": { "type": "string", "description": "The official name of the company", "example": "Google" }, "website": { "type": "string", "description": "Official website URL of the company", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "description": "Industry category of the company", "example": "Software Development" }, "description": { "type": "string", "description": "A brief description of the company and its mission", "example": "A problem isn't truly solved until it's solved for all. Googlers build products that help create opportunities for everyone" }, "number_of_applications": { "type": "integer", "description": "Total number of applications or technologies identified as being used by the company", "example": 2241 }, "applications": { "type": "array", "description": "List of applications and technologies associated with the company", "items": { "type": "object", "properties": { "subdomain": { "type": "string", "description": "Subdomain of the application or technology", "example": "hivemint.xyz" }, "domain": { "type": "string", "description": "Main domain associated with the application or technology", "example": "withgoogle.com" }, "technology_name": { "type": "string", "description": "Name of the technology or application used", "example": "Node.js" }, "technology_cpe": { "type": "string", "description": "Common Platform Enumeration (CPE) identifier for the technology", "example": "cpe:/a:nodejs:node.js" }, "confidence": { "type": "integer", "description": "Confidence level of the identification accuracy, represented as a percentage", "example": 100 }, "category_id": { "type": "array", "description": "List of IDs representing the category of the technology", "items": { "type": "integer" }, "example": [ 27 ] }, "category_name": { "type": "array", "description": "List of category names corresponding to each category ID", "items": { "type": "string" }, "example": [ "Programming languages" ] }, "version": { "type": "string", "description": "Version of the technology or application", "example": "Python" }, "website": { "type": "string", "description": "Official website of the technology or application", "example": "http://nodejs.org" } } } }, "pagination": { "type": "object", "description": "Information about the pagination of results", "properties": { "current_page": { "type": "integer", "description": "The current page of the result set", "example": 1 }, "page_size": { "type": "integer", "description": "Number of items per page", "example": 2 }, "total_pages": { "type": "integer", "description": "Total number of pages available", "example": 1 }, "total_items": { "type": "integer", "description": "Total number of items in the result set", "example": 2 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "company_name": "Google", "website": "https://goo.gle/3DLEokh", "industry": "Software Development", "description": "A problem isn't truly solved until it's solved for all", "number_of_applications": 2241, "applications": [ { "subdomain": "hivemint.xyz", "domain": "withgoogle.com", "technology_name": "Node.js", "confidence": 100, "category_id": [ 27 ], "category_name": [ "Programming languages" ], "version": "-", "website": "http://nodejs.org" } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanyinfo": { "get": { "summary": "Get company details", "tags": [ "Monitor" ], "description": "Company information", "responses": { "200": { "description": "Company information response", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "LinkedIn identifier for the company", "example": "google" }, "company_name": { "type": "string", "description": "Name of the company", "example": "Google" }, "website": { "type": "string", "format": "uri", "description": "Website URL of the company", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "description": "Industry the company operates in", "example": "Software Development" }, "description": { "type": "string", "description": "Company description", "example": "A problem isn't truly solved until it's solved for all. Googlers build products that help create opportunities for everyone, whether down the street or across the globe" }, "company_id": { "type": "string", "description": "Unique company identifier", "example": "GOO_2660260" }, "crunchbase_id": { "type": "string", "format": "uri", "description": "URL to Crunchbase profile for the company", "example": "https://www.crunchbase.com/organization/google/funding_rounds/funding_rounds_list" }, "employees_number": { "type": "string", "description": "Total number of employees in the company", "example": "300967 employees" }, "followers_number": { "type": "integer", "description": "Total number of LinkedIn followers", "example": 34225598 }, "score": { "type": "number", "format": "float", "description": "Company score based on internal criteria", "example": 410.42 }, "naics_code": { "type": "string", "description": "NAICS code associated with the company's industry", "example": 511 }, "searched_by": { "type": "integer", "description": "Number of searches or views related to this company", "example": 8 }, "subsidiaries_list": { "type": "array", "items": { "type": "string" }, "description": "List of subsidiaries or associated entities under the company", "example": [ "Adometry (acquired by Google)", "Android", "Google Cloud", "YouTube" ] }, "ip_addresses": { "type": "integer", "description": "Number of IP addresses associated with the company", "example": 1600 } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanyinfrastructureassets": { "get": { "summary": "Get company infrastructure assets", "tags": [ "Monitor" ], "description": "Company infrastructure assets", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing company information, network endpoints, and pagination data", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "Unique identifier for the company on LinkedIn", "example": "google" }, "company_name": { "type": "string", "description": "The official name of the company", "example": "Google" }, "website": { "type": "string", "description": "Official website URL of the company", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "description": "Industry category of the company", "example": "Software Development" }, "description": { "type": "string", "description": "A brief description of the company and its mission", "example": "A problem isn't truly solved until it's solved for all. Googlers build products that help create opportunities for everyone" }, "number_of_infrastructure_endpoint": { "type": "integer", "description": "Total number of network endpoints associated with the company's infrastructure", "example": 1600 }, "network_endpoints": { "type": "array", "description": "List of network endpoints used by the company", "items": { "type": "object", "properties": { "ip": { "type": "string", "description": "IP address of the network endpoint", "example": "76.76.21.21" }, "identified_product": { "type": "string", "description": "Product or service identified to be hosted at this endpoint", "example": "AMAZON-02" }, "subdomain": { "type": "string", "description": "Subdomain of the network endpoint", "example": "fransandi.com" }, "domain": { "type": "string", "description": "Main domain of the network endpoint", "example": "flutter.dev" }, "isp": { "type": "string", "description": "Internet Service Provider associated with the endpoint", "example": "Amazon.com, Inc" }, "services": { "type": "array", "description": "List of services hosted at this endpoint", "items": { "type": "string" }, "example": [ "Hosting" ] }, "orgination": { "type": "string", "description": "Organization managing or operating the endpoint", "example": "Vercel, Inc" }, "region_name": { "type": "string", "description": "Name of the region where the endpoint is located", "example": "California" }, "country": { "type": "string", "description": "Country where the endpoint is located", "example": "United States" }, "continent": { "type": "string", "description": "Continent where the endpoint is located", "example": "North America" }, "country_code": { "type": "string", "description": "ISO code of the country where the endpoint is located", "example": "US" }, "zip": { "type": "string", "description": "Zip code of the endpoint’s location", "example": 91789 } } } }, "pagination": { "type": "object", "description": "Information about the pagination of results", "properties": { "current_page": { "type": "integer", "description": "The current page of the result set", "example": 1 }, "page_size": { "type": "integer", "description": "Number of items per page", "example": 2 }, "total_pages": { "type": "integer", "description": "Total number of pages available", "example": 1 }, "total_items": { "type": "integer", "description": "Total number of items in the result set", "example": 2 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "company_name": "Google", "website": "https://goo.gle/3DLEokh", "industry": "Software Development", "description": "A problem isn't truly solved until it's solved for all", "number_of_infrastructure_endpoint": 2241, "network_endpoints": [ { "ip": "76.76.21.21", "identified_product": "AMAZON-02", "subdomain": "fransandi.com", "domain": "flutter.dev", "isp": "Amazon.com, Inc.", "services": [ "Hosting" ], "orgination": "Vercel, Inc", "region_name": "California", "country": "United States", "continent": "North America", "country_code": "US", "zip": "91789" } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanysbom": { "get": { "summary": "Get company SBOM data", "tags": [ "Monitor" ], "description": "Company SBOM data includes technology information", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomains and technology information or a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "x.company" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "conscrypt.org" }, "data": { "type": "array", "items": { "type": "object", "properties": { "technology_name": { "type": "string", "example": "Bootstrap" }, "technology_version": { "type": "string", "example": "3.3.7" }, "cve_number": { "type": "array", "items": { "type": "string", "example": "CVE-2023-5317" } } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 10 }, "total_items": { "type": "integer", "example": 100 } } }, "message": { "type": "string", "example": "No SBOM vulnerability found" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "data": [ { "domain_name": "x.company", "subdomain": [ { "subdomain_name": "conscrypt.org", "data": [ { "technology_name": "Bootstrap", "technology_version": "3.3.7", "cve_number": [ "CVE-2023-5317" ] } ] } ] } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 }, "message": "Data fetched successfully" } }, "no_data": { "summary": "Response with message only", "value": { "message": "No SBOM vulnerability found" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanysbomcve": { "get": { "summary": "Get company SBOM data with CVE", "tags": [ "Monitor" ], "description": "Company SBOM data includes technology information with cve", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomains and technology information or a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "x.company" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "conscrypt.org" }, "data": { "type": "array", "items": { "type": "object", "properties": { "technology_name": { "type": "string", "example": "Bootstrap" }, "technology_version": { "type": "string", "example": "3.3.7" }, "cve_number": { "type": "array", "items": { "type": "string", "example": "CVE-2023-5317" } } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 10 }, "total_items": { "type": "integer", "example": 100 } } }, "message": { "type": "string", "example": "No SBOM vulnerability found" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "data": [ { "domain_name": "x.company", "subdomain": [ { "subdomain_name": "conscrypt.org", "data": [ { "technology_name": "Bootstrap", "technology_version": "3.3.7", "cve_number": [ "CVE-2023-5317" ] } ] } ] } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 }, "message": "Data fetched successfully" } }, "no_data": { "summary": "Response with message only", "value": { "message": "No SBOM vulnerability found" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanysbomdomain": { "get": { "summary": "Get company SBOM data by domain", "tags": [ "Monitor" ], "description": "Company SBOM data includes technology information", "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "domain of company", "schema": { "type": "string", "example": "google.com" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomains and technology information or a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "google.com" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "googleplus.com" }, "data": { "type": "array", "items": { "type": "object", "properties": { "technology_name": { "type": "string", "example": "jQuery" }, "technology_version": { "type": "string", "example": "1.11.3" }, "cve_number": { "type": "array", "items": { "type": "string", "example": "CVE-2022-1537" } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 3 }, "total_items": { "type": "integer", "example": 23 } } }, "message": { "type": "string", "example": "No SBOM vulnerability found" } } }, "examples": { "with_data": { "summary": "Response with detailed data", "value": { "data": { "domain_name": "google.com", "subdomain": [ { "subdomain_name": "googleplus.com", "data": [ { "technology_name": "jQuery", "technology_version": "1.11.3", "cve_number": [ "CVE-2022-1537" ] } ] } ] }, "pagination": { "current_page": 1, "page_size": 10, "total_pages": 3, "total_items": 23 } } }, "no_vulnerability": { "summary": "No vulnerability", "value": { "data": { "domain_name": "google.com", "message": "No SBOM vulnerability found" } } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_domain": { "summary": "Invalid domain", "value": { "error": "Invalid domain. Please check and provide a valid domain" } }, "domain_associate_issue": { "summary": "Domain association", "value": { "error": "Required domain does not belong to linkedin id" } }, "required_param_domain": { "summary": "domain is a required parameter", "value": { "error": "domain is a required parameter" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company and its domain associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanyscores": { "get": { "summary": "Get company global scoring", "tags": [ "Monitor" ], "description": "Company scoring without subsidiaries", "responses": { "200": { "description": "Successful response with LinkedIn company profile information", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google", "description": "LinkedIn ID of the company" }, "company_name": { "type": "string", "example": "Google", "description": "Name of the company" }, "website": { "type": "string", "format": "uri", "example": "https://goo.gle/3DLEokh", "description": "Company's website URL" }, "industry": { "type": "string", "example": "Software Development", "description": "Industry type" }, "description": { "type": "string", "example": "A problem isn't truly solved until it's solved for all", "description": "Company description" }, "subsidiaries_number": { "type": "integer", "example": 46, "description": "Number of subsidiaries" }, "score": { "type": "object", "properties": { "spf": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 71.39 } } }, "dkim": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 85.74 } } }, "certificate_conf": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 48.62 } } }, "certificate_info": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 11.09 } } }, "open_ports": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 39.07 } } }, "web_headers": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 18.22 } } }, "dmarc": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 68.39 } } }, "it_standardization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "digitalization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "certificate_cve": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 9.14 } } }, "vulnerabilities": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 47.15 } } }, "sbom": { "type": "object", "properties": { "letter": { "type": "string", "example": "F" }, "number": { "type": "number", "format": "float", "example": 1.4 } } } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "company_name": "Google", "website": "https://goo.gle/3DLEokh", "industry": "Software Development", "description": "A problem isn't truly solved until it's solved for all", "subsidiaries_number": 0, "score": { "spf": { "letter": "C", "number": 71.39 }, "dkim": { "letter": "C", "number": 85.74 }, "certificate_conf": { "letter": "E", "number": 48.62 }, "certificate_info": { "letter": "E", "number": 11.52 }, "open_ports": { "letter": "C", "number": 39.07 }, "web_headers": { "letter": "E", "number": 19.79 }, "dmarc": { "letter": "D", "number": 68.39 }, "it_standardization": { "letter": "F", "number": 2.87 }, "digitalization": { "letter": "F", "number": 2.87 }, "certificate_cve": { "letter": "E", "number": 9.14 }, "vulnerabilities": { "letter": "D", "number": 48.35 }, "sbom": { "letter": "F", "number": 1.4 } } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanystats": { "get": { "summary": "Get company statistics data", "tags": [ "Monitor" ], "description": "Company stats with all subsidiaries", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "parent_linkedin_id": { "type": "string", "example": "google" }, "subsidiaries_stats": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "adometry" }, "company_name": { "type": "string", "example": "Adometry (acquired by Google)" }, "company_domain": { "type": "string", "example": "google.com" }, "finding_stats": { "type": "object", "properties": { "nb_good": { "type": "integer", "example": 54902 }, "nb_warning": { "type": "integer", "example": 2174 }, "nb_bad": { "type": "integer", "example": 9182 }, "nb_neutral": { "type": "integer", "example": 1808 } } }, "peer_stats": { "type": "object", "properties": { "inside_top25_percentile": { "type": "string", "example": "yes" }, "inside_between_top25_and_top50_percentile": { "type": "string", "example": "no" }, "inside_between_low25_and_low50_percentile": { "type": "string", "example": "no" }, "inside_low25_percentile": { "type": "string", "example": "no" } } }, "last_6_month": { "type": "object", "additionalProperties": { "type": "object", "properties": { "month_year": { "type": "string", "example": "Nov 2024" }, "value": { "type": "integer", "example": 128 }, "difference": { "type": "string", "example": "128" } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 2 }, "page_size": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 46 }, "total_items": { "type": "integer", "example": 46 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "parent_linkedin_id": "apple", "subsidiaries_stats": [ { "linkedin_id": "apple", "company_name": "Apple", "company_domain": "apple.com", "finding_stats": { "nb_good": 180022, "nb_warning": 7912, "nb_bad": 15581, "nb_neutral": 4525 }, "peer_stats": { "inside_top25_percentile": "yes", "inside_between_top25_and_top50_percentile": "no", "inside_between_low25_and_low50_percentile": "no", "inside_low25_percentile": "no" }, "last_6_month": { "1": { "month_year": "Nov 2024", "value": 556, "difference": "0" }, "2": { "month_year": "Oct 2024", "value": 556, "difference": "0" }, "3": { "month_year": "Sep 2024", "value": 556, "difference": "22" }, "4": { "month_year": "Aug 2024", "value": 534, "difference": "-8" }, "5": { "month_year": "Jul 2024", "value": 542, "difference": "-51" }, "6": { "month_year": "Jun 2024", "value": 593, "difference": "14" } } } ], "pagination": { "current_page": 1, "page_size": 1, "total_pages": 1, "total_items": 1 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanysubscores": { "get": { "summary": "Get company scoring including subsidiaries", "tags": [ "Monitor" ], "description": "Company scoring with all subsidiaries", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing LinkedIn ID and subsidiaries' scores", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "subsidiaries_scores": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "company_name": { "type": "string", "example": "Google" }, "website": { "type": "string", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "example": "Software Development" }, "description": { "type": "string", "example": "A problem isn't truly solved until it's solved for all" }, "score": { "type": "object", "properties": { "spf": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 71.39 } } }, "dkim": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 85.74 } } }, "certificate_conf": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 48.62 } } }, "certificate_info": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 11.09 } } }, "open_ports": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 39.07 } } }, "web_headers": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 18.22 } } }, "dmarc": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 68.39 } } }, "it_standardization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "digitalization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "certificate_cve": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 9.14 } } }, "vulnerabilities": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 47.15 } } }, "sbom": { "type": "object", "properties": { "letter": { "type": "string", "example": "F" }, "number": { "type": "number", "format": "float", "example": 1.4 } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 1 }, "total_items": { "type": "integer", "example": 1 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "subsidiaries_scores": [ { "linkedin_id": "apple", "company_name": "Apple", "website": "http://www.apple.com/careers", "industry": "Computers and Electronics Manufacturing", "description": "We’re a diverse collective of thinkers and doers, continually reimagining what’s possible to help us all do what we love in new ways", "score": { "spf": { "letter": "A", "number": 120.69 }, "dkim": { "letter": "E", "number": 72.65 }, "certificate_conf": { "letter": "F", "number": 12.6 }, "certificate_info": { "letter": "F", "number": 2.8 }, "open_ports": { "letter": "F", "number": 21.28 }, "web_headers": { "letter": "F", "number": 7 }, "dmarc": { "letter": "A", "number": 172.41 }, "it_standardization": { "letter": "B", "number": 14.37 }, "digitalization": { "letter": "A", "number": 17.24 }, "certificate_cve": { "letter": "F", "number": 4.2 }, "vulnerabilities": { "letter": "A", "number": 103.45 }, "sbom": { "letter": "F", "number": 5.04 } } } ], "pagination": { "current_page": 1, "page_size": 1, "total_pages": 1, "total_items": 1 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-getcompanysubsidiaries": { "get": { "summary": "Get company subsidiaries", "tags": [ "Monitor" ], "description": "Company subsidiaries information", "responses": { "200": { "description": "Successful response with company profile information", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google", "description": "LinkedIn ID of the company" }, "company_name": { "type": "string", "example": "Google", "description": "Name of the company" }, "website": { "type": "string", "format": "uri", "example": "https://goo.gle/3DLEokh", "description": "Company's website URL" }, "industry": { "type": "string", "example": "Software Development", "description": "Industry type of the company" }, "description": { "type": "string", "example": "A problem isn't truly solved until it's solved for all", "description": "Company description" }, "company_id": { "type": "string", "example": "GOO_2660260", "description": "Unique company identifier" }, "crunchbase_id": { "type": "string", "format": "uri", "example": "https://www.crunchbase.com/organization/google/funding_rounds/funding_rounds_list", "description": "URL to the company's Crunchbase profile" }, "employees_number": { "type": "string", "example": "300967 employees", "description": "Approximate number of employees" }, "followers_number": { "type": "integer", "example": 34225598, "description": "Number of LinkedIn followers" }, "score": { "type": "number", "format": "float", "example": 410.42, "description": "Overall company score" }, "naics_code": { "type": "string", "example": 511, "description": "NAICS code for the company's industry" }, "serched_by": { "type": "integer", "example": 8, "description": "Number of times the company was searched" }, "ip_addresses": { "type": "integer", "example": 1600, "description": "Approximate number of associated IP addresses" } } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-listsubsidiaries": { "get": { "summary": "Get subsidiaries list", "tags": [ "Monitor" ], "description": "Company subsidiaries list", "responses": { "200": { "description": "Successful response containing subsidiary information", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "rankiteo" }, "subsidiaries_list": { "type": "array", "items": { "type": "object", "properties": { "subsidiary_name": { "type": "string", "example": "cyber" }, "subsidiary_id": { "type": "string", "example": "CYB_1522447" }, "parent_linkedin_id": { "type": "string", "example": "rankiteo" }, "subsidiary_parent_name": { "type": "string", "example": "Rankiteo" }, "linkedin_id": { "type": "string", "example": "CYB_1522447" }, "website": { "type": "string", "example": "www.cyber.rankiteo.com" }, "employees_number": { "type": "string", "example": "10 employees" }, "followers_number": { "type": "integer", "example": 1000 }, "industry_type": { "type": "string", "example": "Software Development" }, "parent_industry_type": { "type": "string", "example": "Software Development" }, "naics_code": { "type": "integer", "example": 4 } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 5 }, "total_pages": { "type": "integer", "example": 1 }, "total_items": { "type": "integer", "example": 5 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "rankiteo", "subsidiaries_list": [ { "subsidiary_name": "cyber", "subsidiary_id": "CYB_1522447", "parent_linkedin_id": "rankiteo", "subsidiary_parent_name": "Rankiteo", "linkedin_id": "CYB_1522447", "website": "www.cyber.rankiteo.com", "employees_number": "10 employees", "followers_number": 1000, "industry_type": "Software Development", "parent_industry_type": "Software Development", "naics_code": 4 } ], "pagination": { "current_page": 1, "page_size": 5, "total_pages": 1, "total_items": 5 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "company_not_found": { "summary": "Company Not Found", "value": { "error": "Not able to find any company associated with your account" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-rescan-subdomain-by-vectorid": { "put": { "summary": "Rescan subdomain by vector id", "tags": [ "Monitor" ], "description": "Rescan subdomain by vector id", "parameters": [ { "name": "subdomain", "in": "query", "required": true, "description": "subdomain of company", "schema": { "type": "string", "example": "google.com" } }, { "name": "risk_vector_id", "in": "query", "required": true, "description": "risk vector id", "schema": { "type": "string", "example": "674f9bfab40bb949f7649811" } } ], "responses": { "200": { "description": "Successful response for scan request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Scan request for subdomain rankiteo.com with vector type DKIM has been successfully received and will be processed soon" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_subdomain": { "summary": "Invalid subdomain", "value": { "error": "Invalid subdomain. Please check and provide a valid subdomain" } }, "subdomain_associate_issue": { "summary": "Subdomain association", "value": { "error": "Required subdomain does not belong to linkedin id" } }, "invalid_risk_vector_type": { "summary": "invalid risk vector id", "value": { "error": "Invalid risk vector id" } }, "required_param_subdomain": { "summary": "subdomain is a required parameter", "value": { "error": "subdomain is a required parameter" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company and its subdomain associated with your account" } }, "required_param_risk_vector_id": { "summary": "risk_vector_id is a required parameter", "value": { "error": "risk_vector_id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "Only PUT method is allowed" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/monitor-rescan-subdomain-by-vectortype": { "put": { "summary": "Rescan subdomain by vector type", "tags": [ "Monitor" ], "description": "Rescan subdomain by vector type", "parameters": [ { "name": "subdomain", "in": "query", "required": true, "description": "subdomain of company", "schema": { "type": "string", "example": "google.com" } }, { "name": "risk_vector_type", "in": "query", "required": true, "description": "risk vector type", "schema": { "type": "string", "example": "DKIM" } } ], "responses": { "200": { "description": "Successful response for scan request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Scan request for subdomain rankiteo.com with vector type DKIM has been successfully received and will be processed soon" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_subdomain": { "summary": "Invalid subdomain", "value": { "error": "Invalid subdomain. Please check and provide a valid subdomain" } }, "subdomain_associate_issue": { "summary": "Subdomain association", "value": { "error": "Required subdomain does not belong to linkedin id" } }, "invalid_risk_vector_type": { "summary": "invalid risk vector type", "value": { "error": "Invalid risk vector type. Valid choices are- ['SPF','DKIM','OPEN-PORTS','CERTIFICATE-CVE','CERTIFICATE-INFO','CERTIFICATE-CONF','WEB-APPLICATION-HEADER','DMARC']" } }, "required_param_subdomain": { "summary": "subdomain is a required parameter", "value": { "error": "subdomain is a required parameter" } }, "company_not_found": { "summary": "Company not found", "value": { "error": "Not able to find any company and its subdomain associated with your account" } }, "required_param_risk_vector_type": { "summary": "risk_vector_type is a required parameter", "value": { "error": "risk_vector_type is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the monitoring plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "Only PUT method is allowed" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-get-data-loss-prediction": { "get": { "summary": "Get data loss prediction", "tags": [ "Underwriter" ], "description": "Get data loss prediction for 6 months or 12 months for a specific company", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "period", "in": "query", "required": false, "description": "Period value is a timeframe. It can be 6 or 12. By default its value is 6", "schema": { "type": "number", "example": 6 } } ], "responses": { "200": { "description": "Data loss prediction response for three incident types - Cyber Attack, Human/System Error and Physical Attack", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "LinkedIn identifier for the company", "example": "google" }, "period": { "type": "integer", "description": "Timeframe of prediction", "example": 6 }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Incident type", "example": "Cyber Attack" }, "predicted_loss_upper_bound": { "type": "number", "format": "float", "description": "Upper bound of the prediction", "example": 6544536.4 }, "predicted_loss_lower_bound": { "type": "number", "format": "float", "description": "Lower bound of the prediction", "example": 4521529.57 }, "predicted_score": { "type": "number", "format": "float", "description": "Average predicted score", "example": 5464047.68 } } } }, "message": { "type": "string", "example": "No predictions available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "period": 6, "data": [ { "type": "Cyber Attack", "predicted_loss_upper_bound": 6544536.4, "predicted_loss_lower_bound": 4521529.57, "predicted_score": 5464047.68 }, { "type": "Human/System Error", "predicted_loss_upper_bound": 2470663.79, "predicted_loss_lower_bound": 1706947.4, "predicted_score": 2062762.57 }, { "type": "Physical Attack", "predicted_loss_upper_bound": 1721438.21, "predicted_loss_lower_bound": 1189317.82, "predicted_score": 1437232.51 } ] } }, "no_data": { "summary": "Response with message only", "value": { "message": "No predictions available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_period": { "summary": "Invalid Period", "value": { "error": "Period value should be 6 or 12" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-get-incident-prediction": { "get": { "summary": "Get incident prediction", "tags": [ "Underwriter" ], "description": "Get incident prediction for 6 months or 12 months for a specific company", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "period", "in": "query", "required": false, "description": "Period value is a timeframe. It can be 6 or 12. By default its value is 6", "schema": { "type": "number", "example": 6 } } ], "responses": { "200": { "description": "Incident prediction response for three incident types - Cyber Attack, Human/System Error and Physical Attack", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "period": { "type": "integer", "example": 6 }, "data": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number", "format": "float", "example": 22.24 }, "name": { "type": "string", "example": "Cyber Attack" } } } }, "message": { "type": "string", "example": "No predictions available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "period": 6, "data": [ { "value": 22.24, "name": "Cyber Attack" }, { "value": 2.88, "name": "Human/System Error" }, { "value": 0.44, "name": "Physical Attack" } ] } }, "no_data": { "summary": "Response with message only", "value": { "message": "No predictions available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_period": { "summary": "Invalid Period", "value": { "error": "Period value should be 6 or 12" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-get-tail-risk-estimation": { "get": { "summary": "Get tail risk estimation", "tags": [ "Underwriter" ], "description": "Get tail risk estimation for 6 months or 12 months for a specific company", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "period", "in": "query", "required": false, "description": "Period value is a timeframe. It can be 6 or 12. By default its value is 6", "schema": { "type": "number", "example": 6 } } ], "responses": { "200": { "description": "Tail risk estimation response for three incident types - Cyber Attack, Human/System Error and Physical Attack", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "LinkedIn identifier for the company", "example": "google" }, "period": { "type": "integer", "description": "Timeframe of prediction", "example": 6 }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Incident type", "example": "Cyber Attack" }, "value_at_risk_95": { "type": "number", "format": "float", "description": "Estimation for value at risk at 95%", "example": 6352860.13 }, "value_at_risk_99": { "type": "number", "format": "float", "description": "Estimation for value at risk at 99%", "example": 6774684.59 }, "expected_shortfall_95": { "type": "number", "format": "float", "example": 6386932.96, "description": "Estimation for expected shortfall at 95%" }, "expected_shortfall_99": { "type": "number", "format": "float", "description": "Estimation for expected shortfall at 99%", "example": 14562857.57 } } } }, "message": { "type": "string", "example": "No estimations available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "period": 6, "data": [ { "type": "Cyber Attack", "value_at_risk_95": 6352860.13, "value_at_risk_99": 6774684.59, "expected_shortfall_95": 6386932.96, "expected_shortfall_99": 14562857.57 }, { "type": "Human/System Error", "value_at_risk_95": 2398303.03, "value_at_risk_99": 2557548.29, "expected_shortfall_95": 2411166.05, "expected_shortfall_99": 5497704.14 }, { "type": "Physical Attack", "value_at_risk_95": 1671020.76, "value_at_risk_99": 1781975.1, "expected_shortfall_95": 1679983.08, "expected_shortfall_99": 3830532.52 } ] } }, "no_data": { "summary": "Response with message only", "value": { "message": "No estimations available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_period": { "summary": "Invalid Period", "value": { "error": "Period value should be 6 or 12" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getall-vulnerability-detection": { "get": { "summary": "Get all vulnerability detection for a specific company", "tags": [ "Underwriter" ], "description": "Company vulnerability detection", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing LinkedIn ID and vulnerability detection data", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "apple" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "CVE-2021-43138" }, "severity": { "type": "number", "example": 7.8 }, "hostname": { "type": "string", "example": "pedocs.apple.com" }, "impact_score": { "type": "number", "example": 5.9 }, "last_seen": { "type": "string", "example": "2024-03-29" }, "subsidiaries": { "type": "string", "example": "apple.com" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 59 }, "slug": { "type": "string", "example": "javascript-libraries" }, "name": { "type": "string", "example": "JavaScript libraries" } } } }, "cpe": { "type": "string", "example": "cpe:2.3:a:linuxfoundation:dojo:1.15.0:*:*:*:*:node.js:*:*" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 1 }, "total_items": { "type": "integer", "example": 1 } } }, "message": { "type": "string", "example": "No vulnerabilty detection found for this Linkedin Id" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "data": [ { "id": "CVE-2021-43138", "severity": 7.8, "hostname": "pedocs.apple.com", "impact_score": 5.9, "last_seen": "2024-03-29", "subsidiaries": "apple.com", "categories": [ { "id": 59, "slug": "javascript-libraries", "name": "JavaScript libraries" } ], "cpe": "cpe:2.3:a:linuxfoundation:dojo:1.15.0:*:*:*:*:node.js:*:*" } ], "pagination": { "current_page": 1, "page_size": 1, "total_pages": 1, "total_items": 1 } } }, "no_data": { "summary": "Response with message only", "value": { "linkedin_id": "apple", "message": "No vulnerabilty detection found for this Linkedin Id" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompaniesfromportfolio": { "get": { "summary": "Get all companies inside portfolio", "tags": [ "Underwriter" ], "description": "Portfolio companies list", "responses": { "200": { "description": "Successful response with security scores for multiple companies", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "meta", "description": "LinkedIn ID of the company" }, "company_name": { "type": "string", "example": "Meta", "description": "Name of the company" }, "security_score": { "type": "number", "format": "float", "example": 727.4, "description": "Security score of the company" }, "last_updated_score_date": { "type": "string", "format": "date-time", "example": "2024-10-21T08:06:07", "description": "Timestamp of the last update for the security score" } } } } } } }, "400": { "description": "API Issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "API issue, please reach out to support@rankiteo.com" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompany-history-crunchbase": { "get": { "summary": "Get company history by crunchbase", "tags": [ "Underwriter" ], "parameters": [ { "name": "crunchbase_id", "in": "query", "required": true, "description": "Cruchbase identifier for the target company", "schema": { "type": "string", "example": "apple" } } ], "description": "Company history information", "responses": { "200": { "description": "Successful response containing history", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "apple" }, "crunchbase_id": { "type": "string", "example": "apple" }, "crunchbase_link": { "type": "string", "example": "https://www.crunchbase.com/organization/apple" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string", "example": "apple" }, "type": { "type": "string", "example": "Cyber Attack" }, "severity": { "type": "integer", "example": 100 }, "impact": { "type": "string", "example": 5 }, "seen": { "type": "string", "example": "09/2015" }, "id": { "type": "string", "example": "GOO12961222" }, "blog_url": { "type": "string", "example": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/" }, "description": { "type": "string", "example": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites" }, "explanation": { "type": "string", "example": "Attack threatening the organization's existence" } } } } } } }, "message": { "type": "string", "example": "No history available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "crunchbase_id": "apple", "crunchbase_link": "https://www.crunchbase.com/organization/apple", "incidents": [ { "entity": "Apple", "type": "Cyber Attack", "severity": 100, "impact": "5", "seen": "11/2022", "id": "GOO12961222", "blog_url": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/", "description": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites", "explanation": "Attack threatening the organization's existence" } ] } }, "no_data": { "summary": "Response with message only", "value": { "linkedin_id": "apple", "crunchbase_id": "apple", "crunchbase_link": "https://www.crunchbase.com/organization/apple", "message": "No history available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_crunchbase_id": { "summary": "Invalid Crunchbase Id", "value": { "error": "Crunchbase ID not valid. Please check and provide a valid Crunchbase ID" } }, "required_params": { "summary": "Crunchbase Id is a required parameter", "value": { "error": "Crunchbase Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompany-history-domain": { "get": { "summary": "Get company history by domain", "tags": [ "Underwriter" ], "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "Domain identifier for the target company", "schema": { "type": "string", "example": "apple.com" } } ], "description": "Company history information", "responses": { "200": { "description": "Successful response containing history", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "example": "apple.com" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string", "example": "apple" }, "type": { "type": "string", "example": "Cyber Attack" }, "severity": { "type": "integer", "example": 100 }, "impact": { "type": "string", "example": 5 }, "seen": { "type": "string", "example": "09/2015" }, "id": { "type": "string", "example": "GOO12961222" }, "blog_url": { "type": "string", "example": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/" }, "description": { "type": "string", "example": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites" }, "explanation": { "type": "string", "example": "Attack threatening the organization's existence" } } } } } } }, "message": { "type": "string", "example": "No history available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "domain": "apple.com", "incidents": [ { "entity": "Apple", "type": "Cyber Attack", "severity": 100, "impact": "5", "seen": "11/2022", "id": "GOO12961222", "blog_url": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/", "description": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites", "explanation": "Attack threatening the organization's existence" } ] } }, "no_data": { "summary": "Response with message only", "value": { "domain": "apple.com", "message": "No history available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_domain": { "summary": "Invalid Domain", "value": { "error": "Domain not valid. Please check and provide a valid Domain" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "No Linkedin IDs found for domain" } }, "required_params": { "summary": "Domain is a required parameter", "value": { "error": "Domain is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompany-history": { "get": { "summary": "Get company history", "tags": [ "Underwriter" ], "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "apple" } } ], "description": "Company history information", "responses": { "200": { "description": "Successful response containing history", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "apple" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string", "example": "apple" }, "type": { "type": "string", "example": "Cyber Attack" }, "severity": { "type": "integer", "example": 100 }, "impact": { "type": "string", "example": 5 }, "seen": { "type": "string", "example": "09/2015" }, "id": { "type": "string", "example": "GOO12961222" }, "blog_url": { "type": "string", "example": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/" }, "description": { "type": "string", "example": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites" }, "explanation": { "type": "string", "example": "Attack threatening the organization's existence" } } } } } } }, "message": { "type": "string", "example": "No history available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "incidents": [ { "entity": "Apple", "type": "Cyber Attack", "severity": 100, "impact": "5", "seen": "11/2022", "id": "GOO12961222", "blog_url": "https://blog.rankiteo.com/goo12961222-google-cyber-attack-november-2022/", "description": "A significant search engine optimization (SEO) campaign hacked over 15,000 websites", "explanation": "Attack threatening the organization's existence" } ] } }, "no_data": { "summary": "Response with message only", "value": { "linkedin_id": "apple", "message": "No history available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanyapplicationsassets": { "get": { "summary": "Get specific company applications assets", "tags": [ "Underwriter" ], "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "description": "Company information", "responses": { "200": { "description": "Successful response containing company information, applications, and pagination data", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "Unique identifier for the company on LinkedIn", "example": "google" }, "company_name": { "type": "string", "description": "The official name of the company", "example": "Google" }, "website": { "type": "string", "description": "Official website URL of the company", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "description": "Industry category of the company", "example": "Software Development" }, "description": { "type": "string", "description": "A brief description of the company and its mission", "example": "A problem isn't truly solved until it's solved for all. Googlers build products that help create opportunities for everyone" }, "number_of_applications": { "type": "integer", "description": "Total number of applications or technologies identified as being used by the company", "example": 2241 }, "applications": { "type": "array", "description": "List of applications and technologies associated with the company", "items": { "type": "object", "properties": { "subdomain": { "type": "string", "description": "Subdomain of the application or technology", "example": "hivemint.xyz" }, "domain": { "type": "string", "description": "Main domain associated with the application or technology", "example": "withgoogle.com" }, "technology_name": { "type": "string", "description": "Name of the technology or application used", "example": "Node.js" }, "technology_cpe": { "type": "string", "description": "Common Platform Enumeration (CPE) identifier for the technology", "example": "cpe:/a:nodejs:node.js" }, "confidence": { "type": "integer", "description": "Confidence level of the identification accuracy, represented as a percentage", "example": 100 }, "category_id": { "type": "array", "description": "List of IDs representing the category of the technology", "items": { "type": "integer" }, "example": [ 27 ] }, "category_name": { "type": "array", "description": "List of category names corresponding to each category ID", "items": { "type": "string" }, "example": [ "Programming languages" ] }, "version": { "type": "string", "description": "Version of the technology or application", "example": "Python" }, "website": { "type": "string", "description": "Official website of the technology or application", "example": "http://nodejs.org" } } } }, "pagination": { "type": "object", "description": "Information about the pagination of results", "properties": { "current_page": { "type": "integer", "description": "The current page of the result set", "example": 1 }, "page_size": { "type": "integer", "description": "Number of items per page", "example": 2 }, "total_pages": { "type": "integer", "description": "Total number of pages available", "example": 1 }, "total_items": { "type": "integer", "description": "Total number of items in the result set", "example": 2 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "company_name": "Google", "website": "https://goo.gle/3DLEokh", "industry": "Software Development", "description": "A problem isn't truly solved until it's solved for all", "number_of_applications": 2241, "applications": [ { "subdomain": "hivemint.xyz", "domain": "withgoogle.com", "technology_name": "Node.js", "confidence": 100, "category_id": [ 27 ], "category_name": [ "Programming languages" ], "version": "-", "website": "http://nodejs.org" } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanyinfo": { "get": { "summary": "Get specific company details", "tags": [ "Underwriter" ], "description": "Company information", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } } ], "responses": { "200": { "description": "Company information response", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "LinkedIn identifier for the company", "example": "google" }, "company_name": { "type": "string", "description": "Name of the company", "example": "Google" }, "website": { "type": "string", "format": "uri", "description": "Website URL of the company", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "description": "Industry the company operates in", "example": "Software Development" }, "description": { "type": "string", "description": "Company description", "example": "A problem isn't truly solved until it's solved for all. Googlers build products that help create opportunities for everyone, whether down the street or across the globe" }, "company_id": { "type": "string", "description": "Unique company identifier", "example": "GOO_2660260" }, "crunchbase_id": { "type": "string", "format": "uri", "description": "URL to Crunchbase profile for the company", "example": "https://www.crunchbase.com/organization/google/funding_rounds/funding_rounds_list" }, "employees_number": { "type": "string", "description": "Total number of employees in the company", "example": "300967 employees" }, "followers_number": { "type": "integer", "description": "Total number of LinkedIn followers", "example": 34225598 }, "score": { "type": "number", "format": "float", "description": "Company score based on internal criteria", "example": 410.42 }, "naics_code": { "type": "string", "description": "NAICS code associated with the company's industry", "example": 511 }, "searched_by": { "type": "integer", "description": "Number of searches or views related to this company", "example": 8 }, "subsidiaries_list": { "type": "array", "items": { "type": "string" }, "description": "List of subsidiaries or associated entities under the company", "example": [ "Adometry (acquired by Google)", "Android", "Google Cloud", "YouTube" ] }, "ip_addresses": { "type": "integer", "description": "Number of IP addresses associated with the company", "example": 1600 } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanyinfrastructureassets": { "get": { "summary": "Get specific company infrastructure assets", "tags": [ "Underwriter" ], "description": "Company information", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing company information, network endpoints, and pagination data", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "description": "Unique identifier for the company on LinkedIn", "example": "google" }, "company_name": { "type": "string", "description": "The official name of the company", "example": "Google" }, "website": { "type": "string", "description": "Official website URL of the company", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "description": "Industry category of the company", "example": "Software Development" }, "description": { "type": "string", "description": "A brief description of the company and its mission", "example": "A problem isn't truly solved until it's solved for all. Googlers build products that help create opportunities for everyone" }, "number_of_infrastructure_endpoint": { "type": "integer", "description": "Total number of network endpoints associated with the company's infrastructure", "example": 1600 }, "network_endpoints": { "type": "array", "description": "List of network endpoints used by the company", "items": { "type": "object", "properties": { "ip": { "type": "string", "description": "IP address of the network endpoint", "example": "76.76.21.21" }, "identified_product": { "type": "string", "description": "Product or service identified to be hosted at this endpoint", "example": "AMAZON-02" }, "subdomain": { "type": "string", "description": "Subdomain of the network endpoint", "example": "fransandi.com" }, "domain": { "type": "string", "description": "Main domain of the network endpoint", "example": "flutter.dev" }, "isp": { "type": "string", "description": "Internet Service Provider associated with the endpoint", "example": "Amazon.com, Inc" }, "services": { "type": "array", "description": "List of services hosted at this endpoint", "items": { "type": "string" }, "example": [ "Hosting" ] }, "orgination": { "type": "string", "description": "Organization managing or operating the endpoint", "example": "Vercel, Inc" }, "region_name": { "type": "string", "description": "Name of the region where the endpoint is located", "example": "California" }, "country": { "type": "string", "description": "Country where the endpoint is located", "example": "United States" }, "continent": { "type": "string", "description": "Continent where the endpoint is located", "example": "North America" }, "country_code": { "type": "string", "description": "ISO code of the country where the endpoint is located", "example": "US" }, "zip": { "type": "string", "description": "Zip code of the endpoint’s location", "example": 91789 } } } }, "pagination": { "type": "object", "description": "Information about the pagination of results", "properties": { "current_page": { "type": "integer", "description": "The current page of the result set", "example": 1 }, "page_size": { "type": "integer", "description": "Number of items per page", "example": 2 }, "total_pages": { "type": "integer", "description": "Total number of pages available", "example": 1 }, "total_items": { "type": "integer", "description": "Total number of items in the result set", "example": 2 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "company_name": "Google", "website": "https://goo.gle/3DLEokh", "industry": "Software Development", "description": "A problem isn't truly solved until it's solved for all", "number_of_infrastructure_endpoint": 2241, "network_endpoints": [ { "ip": "76.76.21.21", "identified_product": "AMAZON-02", "subdomain": "fransandi.com", "domain": "flutter.dev", "isp": "Amazon.com, Inc.", "services": [ "Hosting" ], "orgination": "Vercel, Inc", "region_name": "California", "country": "United States", "continent": "North America", "country_code": "US", "zip": "91789" } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanysbom": { "get": { "summary": "Get company SBOM data by linkedin id", "tags": [ "Underwriter" ], "description": "Company SBOM data includes technology information", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomains and technology information or a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "x.company" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "conscrypt.org" }, "data": { "type": "array", "items": { "type": "object", "properties": { "technology_name": { "type": "string", "example": "Bootstrap" }, "technology_version": { "type": "string", "example": "3.3.7" }, "cve_number": { "type": "array", "items": { "type": "string", "example": "CVE-2023-5317" } } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 10 }, "total_items": { "type": "integer", "example": 100 } } }, "message": { "type": "string", "example": "No SBOM vulnerability found" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "data": [ { "domain_name": "x.company", "subdomain": [ { "subdomain_name": "conscrypt.org", "data": [ { "technology_name": "Bootstrap", "technology_version": "3.3.7", "cve_number": [ "CVE-2023-5317" ] } ] } ] } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No SBOM vulnerability found" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanysbomcve": { "get": { "summary": "Get company SBOM data with CVE by linkedin id", "tags": [ "Underwriter" ], "description": "Company SBOM data includes technology information with cve", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomains and technology information or a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "x.company" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "conscrypt.org" }, "data": { "type": "array", "items": { "type": "object", "properties": { "technology_name": { "type": "string", "example": "Bootstrap" }, "technology_version": { "type": "string", "example": "3.3.7" }, "cve_number": { "type": "array", "items": { "type": "string", "example": "CVE-2023-5317" } } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 10 }, "total_items": { "type": "integer", "example": 100 } } }, "message": { "type": "string", "example": "No SBOM vulnerability found" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "data": [ { "domain_name": "x.company", "subdomain": [ { "subdomain_name": "conscrypt.org", "data": [ { "technology_name": "Bootstrap", "technology_version": "3.3.7", "cve_number": [ "CVE-2023-5317" ] } ] } ] } ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 10, "total_items": 100 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No SBOM vulnerability found" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanysbomdomain": { "get": { "summary": "Get company SBOM data by domain and linkedin id", "tags": [ "Underwriter" ], "description": "Company SBOM data includes technology information", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "domain", "in": "query", "required": true, "description": "domain of company", "schema": { "type": "string", "example": "google.com" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing subdomains and technology information or a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "google.com" }, "subdomain": { "type": "array", "items": { "type": "object", "properties": { "subdomain_name": { "type": "string", "example": "googleplus.com" }, "data": { "type": "array", "items": { "type": "object", "properties": { "technology_name": { "type": "string", "example": "jQuery" }, "technology_version": { "type": "string", "example": "1.11.3" }, "cve_number": { "type": "array", "items": { "type": "string", "example": "CVE-2022-1537" } } } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 3 }, "total_items": { "type": "integer", "example": 23 } } }, "message": { "type": "string", "example": "No SBOM vulnerability found" } } }, "examples": { "with_data": { "summary": "Response with detailed data", "value": { "data": { "domain_name": "google.com", "subdomain": [ { "subdomain_name": "googleplus.com", "data": [ { "technology_name": "jQuery", "technology_version": "1.11.3", "cve_number": [ "CVE-2022-1537" ] } ] } ] }, "pagination": { "current_page": 1, "page_size": 10, "total_pages": 3, "total_items": 23 } } }, "no_vulnerability": { "summary": "No vulnerability", "value": { "data": { "domain_name": "google.com", "message": "No SBOM vulnerability found" } } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_domain": { "summary": "Invalid domain", "value": { "error": "Invalid domain. Please check and provide a valid domain" } }, "domain_associate_issue": { "summary": "Domain association", "value": { "error": "Required domain does not belong to linkedin id" } }, "invalid_linkedin_id_or_domain": { "summary": "Invalid Linkedin Id or Domain", "value": { "error": "Invalid linkedin id or domain. Please check and provide a valid linkedin id or domain" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_param_linkedin_id": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "required_param_domain": { "summary": "domain is a required parameter", "value": { "error": "domain is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanyscores": { "get": { "summary": "Get specific company global scoring", "tags": [ "Underwriter" ], "description": "Company scoring without subsidiaries", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier belonging to the target company", "schema": { "type": "string", "example": "google" } } ], "responses": { "200": { "description": "Successful response with LinkedIn company profile information", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google", "description": "LinkedIn ID of the company" }, "company_name": { "type": "string", "example": "Google", "description": "Name of the company" }, "website": { "type": "string", "format": "uri", "example": "https://goo.gle/3DLEokh", "description": "Company's website URL" }, "industry": { "type": "string", "example": "Software Development", "description": "Industry type" }, "description": { "type": "string", "example": "A problem isn't truly solved until it's solved for all", "description": "Company description" }, "subsidiaries_number": { "type": "integer", "example": 46, "description": "Number of subsidiaries" }, "score": { "type": "object", "properties": { "spf": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 71.39 } } }, "dkim": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 85.74 } } }, "certificate_conf": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 48.62 } } }, "certificate_info": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 11.09 } } }, "open_ports": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 39.07 } } }, "web_headers": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 18.22 } } }, "dmarc": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 68.39 } } }, "it_standardization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "digitalization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "certificate_cve": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 9.14 } } }, "vulnerabilities": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 47.15 } } }, "sbom": { "type": "object", "properties": { "letter": { "type": "string", "example": "F" }, "number": { "type": "number", "format": "float", "example": 1.4 } } } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "google", "company_name": "Google", "website": "https://goo.gle/3DLEokh", "industry": "Software Development", "description": "A problem isn't truly solved until it's solved for all", "subsidiaries_number": 0, "score": { "spf": { "letter": "C", "number": 71.39 }, "dkim": { "letter": "C", "number": 85.74 }, "certificate_conf": { "letter": "E", "number": 48.62 }, "certificate_info": { "letter": "E", "number": 11.52 }, "open_ports": { "letter": "C", "number": 39.07 }, "web_headers": { "letter": "E", "number": 19.79 }, "dmarc": { "letter": "D", "number": 68.39 }, "it_standardization": { "letter": "F", "number": 2.87 }, "digitalization": { "letter": "F", "number": 2.87 }, "certificate_cve": { "letter": "E", "number": 9.14 }, "vulnerabilities": { "letter": "D", "number": 48.35 }, "sbom": { "letter": "F", "number": 1.4 } } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanystats": { "get": { "summary": "Get company statistics data for specific company", "tags": [ "Underwriter" ], "description": "Company stats with all subsidiaries", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "parent_linkedin_id": { "type": "string", "example": "google" }, "subsidiaries_stats": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "adometry" }, "company_name": { "type": "string", "example": "Adometry (acquired by Google)" }, "company_domain": { "type": "string", "example": "google.com" }, "finding_stats": { "type": "object", "properties": { "nb_good": { "type": "integer", "example": 54902 }, "nb_warning": { "type": "integer", "example": 2174 }, "nb_bad": { "type": "integer", "example": 9182 }, "nb_neutral": { "type": "integer", "example": 1808 } } }, "peer_stats": { "type": "object", "properties": { "inside_top25_percentile": { "type": "string", "example": "yes" }, "inside_between_top25_and_top50_percentile": { "type": "string", "example": "no" }, "inside_between_low25_and_low50_percentile": { "type": "string", "example": "no" }, "inside_low25_percentile": { "type": "string", "example": "no" } } }, "last_6_month": { "type": "object", "additionalProperties": { "type": "object", "properties": { "month_year": { "type": "string", "example": "Nov 2024" }, "value": { "type": "integer", "example": 128 }, "difference": { "type": "string", "example": "128" } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 2 }, "page_size": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 46 }, "total_items": { "type": "integer", "example": 46 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "parent_linkedin_id": "apple", "subsidiaries_stats": [ { "linkedin_id": "apple", "company_name": "Apple", "company_domain": "apple.com", "finding_stats": { "nb_good": 180022, "nb_warning": 7912, "nb_bad": 15581, "nb_neutral": 4525 }, "peer_stats": { "inside_top25_percentile": "yes", "inside_between_top25_and_top50_percentile": "no", "inside_between_low25_and_low50_percentile": "no", "inside_low25_percentile": "no" }, "last_6_month": { "1": { "month_year": "Nov 2024", "value": 556, "difference": "0" }, "2": { "month_year": "Oct 2024", "value": 556, "difference": "0" }, "3": { "month_year": "Sep 2024", "value": 556, "difference": "22" }, "4": { "month_year": "Aug 2024", "value": 534, "difference": "-8" }, "5": { "month_year": "Jul 2024", "value": 542, "difference": "-51" }, "6": { "month_year": "Jun 2024", "value": 593, "difference": "14" } } } ], "pagination": { "current_page": 1, "page_size": 1, "total_pages": 1, "total_items": 1 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getcompanysubscores": { "get": { "summary": "Get specific company scoring including subsidiaries", "tags": [ "Underwriter" ], "description": "Company scoring with all subsidiaries", "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "LinkedIn identifier for the target company", "schema": { "type": "string", "example": "google" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Successful response containing LinkedIn ID and subsidiaries' scores", "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "subsidiaries_scores": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "google" }, "company_name": { "type": "string", "example": "Google" }, "website": { "type": "string", "example": "https://goo.gle/3DLEokh" }, "industry": { "type": "string", "example": "Software Development" }, "description": { "type": "string", "example": "A problem isn't truly solved until it's solved for all" }, "score": { "type": "object", "properties": { "spf": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 71.39 } } }, "dkim": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 85.74 } } }, "certificate_conf": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 48.62 } } }, "certificate_info": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 11.09 } } }, "open_ports": { "type": "object", "properties": { "letter": { "type": "string", "example": "C" }, "number": { "type": "number", "format": "float", "example": 39.07 } } }, "web_headers": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 18.22 } } }, "dmarc": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 68.39 } } }, "it_standardization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "digitalization": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 3.81 } } }, "certificate_cve": { "type": "object", "properties": { "letter": { "type": "string", "example": "E" }, "number": { "type": "number", "format": "float", "example": 9.14 } } }, "vulnerabilities": { "type": "object", "properties": { "letter": { "type": "string", "example": "D" }, "number": { "type": "number", "format": "float", "example": 47.15 } } }, "sbom": { "type": "object", "properties": { "letter": { "type": "string", "example": "F" }, "number": { "type": "number", "format": "float", "example": 1.4 } } } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 1 }, "total_items": { "type": "integer", "example": 1 } } }, "message": { "type": "string", "example": "No data available" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "subsidiaries_scores": [ { "linkedin_id": "apple", "company_name": "Apple", "website": "http://www.apple.com/careers", "industry": "Computers and Electronics Manufacturing", "description": "We’re a diverse collective of thinkers and doers, continually reimagining what’s possible to help us all do what we love in new ways", "score": { "spf": { "letter": "A", "number": 120.69 }, "dkim": { "letter": "E", "number": 72.65 }, "certificate_conf": { "letter": "F", "number": 12.6 }, "certificate_info": { "letter": "F", "number": 2.8 }, "open_ports": { "letter": "F", "number": 21.28 }, "web_headers": { "letter": "F", "number": 7 }, "dmarc": { "letter": "A", "number": 172.41 }, "it_standardization": { "letter": "B", "number": 14.37 }, "digitalization": { "letter": "A", "number": 17.24 }, "certificate_cve": { "letter": "F", "number": 4.2 }, "vulnerabilities": { "letter": "A", "number": 103.45 }, "sbom": { "letter": "F", "number": 5.04 } } } ], "pagination": { "current_page": 1, "page_size": 1, "total_pages": 1, "total_items": 1 } } }, "no_data": { "summary": "Response with message only", "value": { "message": "No data available" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should be greater than 0" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getincidentdetail-by-id": { "get": { "summary": "Get company incident details", "tags": [ "Underwriter" ], "parameters": [ { "name": "incident_id", "in": "query", "required": true, "description": "Incident id identifier for the target incident", "schema": { "type": "string", "example": "WES518052325" } } ], "description": "Company incident details", "responses": { "200": { "description": "Successful response containing incident details", "content": { "application/json": { "schema": { "type": "object", "properties": { "incident_id": { "type": "string", "example": "WES518052325" }, "data": { "type": "object", "properties": { "title": { "type": "string", "example": "West Lothian Council Ransomware Attack" }, "description": { "type": "string", "example": "West Lothian Council confirmed that ransomware actors have stolen personal and sensitive information stored on its education network\n" }, "date_detected": { "type": "string", "format": "date", "example": "2024-05-06" }, "date_publicly_disclosed": { "type": "string", "format": "date", "example": "2024-05-21" }, "type": { "type": "string", "example": "Ransomware" }, "attack_vector": { "type": "string", "example": "Ransomware" }, "threat_actor": { "type": "string", "example": "Interlock Gang" }, "motivation": { "type": "string", "example": "Financial" }, "impact": { "type": "object", "properties": { "data_compromised": { "type": "array", "items": { "type": "string" } }, "systems_affected": { "type": "array", "items": { "type": "string" } }, "operational_impact": { "type": "string", "example": "Contingency plans expected to continue until the end of the current school term" } } }, "affected_entities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "industry": { "type": "string" }, "location": { "type": "string" } } } }, "response": { "type": "object", "properties": { "law_enforcement_notified": { "type": "string" }, "containment_measures": { "type": "string" }, "communication_strategy": { "type": "string" } } }, "data_breach": { "type": "object", "properties": { "type_of_data_compromised": { "type": "array", "items": { "type": "string" } }, "number_of_records_exposed": { "type": "string" }, "sensitivity_of_data": { "type": "array", "items": { "type": "string" } }, "data_exfiltration": { "type": "string" }, "file_types_exposed": { "type": "array", "items": { "type": "string" } }, "personally_identifiable_information": { "type": "array", "items": { "type": "string" } } } }, "ransomware": { "type": "object", "properties": { "ransomware_strain": { "type": "string" }, "data_exfiltration": { "type": "string" } } }, "references": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" } } } }, "investigation_status": { "type": "string" }, "stakeholder_advisories": { "type": "string" }, "customer_advisories": { "type": "string" } } } } }, "example": { "incident_id": "WES518052325", "data": { "title": "West Lothian Council Ransomware Attack", "description": "West Lothian Council confirmed that ransomware actors have stolen personal and sensitive information stored on its education network\n", "date_detected": "2024-05-06", "date_publicly_disclosed": "2024-05-21", "type": "Ransomware", "attack_vector": "Ransomware", "threat_actor": "Interlock Gang", "motivation": "Financial", "impact": { "data_compromised": [ "personal and sensitive data", "operational issues for schools", "passports", "driver's licenses", "various other documents" ], "systems_affected": [ "education network", "IT systems used by 13 secondary schools, 69 primary schools and 61 nurseries" ], "operational_impact": "Contingency plans expected to continue until the end of the current school term" }, "affected_entities": [ { "name": "West Lothian Council", "type": "Local Authority", "industry": "Education", "location": "West Lothian, Scotland" } ], "response": { "law_enforcement_notified": "Police Scotland, Scottish government", "containment_measures": "Isolated education network from the rest of its IT infrastructure", "communication_strategy": "Contacting parents and carers, offering advice on phishing and password changes" }, "data_breach": { "type_of_data_compromised": [ "personal data", "sensitive data", "operational issues for schools" ], "number_of_records_exposed": "3,349,196 files and 580,783 folders", "sensitivity_of_data": [ "low to high" ], "data_exfiltration": "2.63 TB of data", "file_types_exposed": [ "images of passports", "driver's licenses", "various other documents" ], "personally_identifiable_information": [ "passports", "driver's licenses" ] }, "ransomware": { "ransomware_strain": "Interlock", "data_exfiltration": "Yes" }, "references": [ { "source": "West Lothian Council" } ], "investigation_status": "Ongoing", "stakeholder_advisories": "Parents and carers at every school in West Lothian", "customer_advisories": "Contacting parents and carers, offering advice on phishing and password changes" } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "required_params": { "summary": "Incident Id is a required parameter", "value": { "error": "Incident Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "invalid_incident_id": { "summary": "Invalid incident id", "value": { "error": "Invalid incident id" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-getlastcompaniesscanned": { "get": { "summary": "Get companies scoring data recently scanned", "tags": [ "Underwriter" ], "description": "Last scanned companies", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } } ], "responses": { "200": { "description": "Companies information response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "List of companies", "items": { "type": "object", "properties": { "company_name": { "type": "string", "description": "Company name", "example": "Emergency Medical Services Authority (EMSA)" }, "linkedin_id": { "type": "string", "description": "LinkedIn ID", "example": "emergency-medical-services-authority-emsa-" }, "score": { "type": "integer", "description": "Company score", "example": 954 }, "last_date_updated": { "type": "string", "format": "date-time", "description": "Last update timestamp", "example": "2024-10-28 08:06:53" } } } }, "pagination": { "type": "object", "description": "Pagination details", "properties": { "current_page": { "type": "integer", "description": "Current page number", "example": 1 }, "page_size": { "type": "integer", "description": "Items per page", "example": 2 }, "total_pages": { "type": "integer", "description": "Total pages", "example": 1 }, "total_items": { "type": "integer", "description": "Total items", "example": 2 } } } } } } } }, "400": { "description": "API Issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "API issue, please reach out to support@rankiteo.com" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-similar-crunchbase-company": { "get": { "summary": "Get similar company by crunchbase id", "tags": [ "Underwriter" ], "parameters": [ { "name": "crunchbase_id", "in": "query", "required": true, "description": "Crunchbase id identifier for the target company", "schema": { "type": "string", "example": "apple" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } }, { "name": "min_employee_count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Minimum Employee Count", "example": 100 } }, { "name": "max_employee_count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum Employee Count", "example": 1000 } } ], "description": "Company Linkedin id", "responses": { "200": { "description": "Successful response containing linkedin ids", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "crunchbase_id": { "type": "string", "example": "apple" }, "data": { "type": "array", "items": { "type": "string", "example": [ "ness-ses", "linkedin", "v-nova-ltd-", "blackbaud", "vmwarehorizon", "citrix", "kaseya", "software-ag", "redocly", "dynamicweb-software" ] } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 5 }, "total_items": { "type": "integer", "example": 47 } } } } } }, "message": { "type": "string", "example": "No companies found" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "crunchbase_id": "apple", "data": [ "ness-ses", "linkedin", "v-nova-ltd-", "blackbaud", "vmwarehorizon", "citrix", "kaseya", "software-ag", "redocly", "dynamicweb-software" ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 5, "total_items": 47 } } }, "no_data": { "summary": "Response with message only", "value": { "crunchbase_id": "apple", "data": "No companies found" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should not be less than 0" } }, "invalid_min_employee_count": { "summary": "Invalid Minimun Employee Count", "value": { "error": "Minimum employee count should be less than 0" } }, "invalid_max_employee_count": { "summary": "Invalid Maximun Employee Count", "value": { "error": "Minimum employee count should be less than 0" } }, "invalid_page_input": { "summary": "Invalid Page Input", "value": { "error": "Page must be a number" } }, "invalid_min_employee_count_input": { "summary": "Invalid Minimun Employee Count Input", "value": { "error": "Minimum employee count must be a number" } }, "invalid_max_employee_count_input": { "summary": "Invalid Maximun Employee Count Input", "value": { "error": "Maximum employee count must be a number" } }, "invalid_emp_range": { "summary": "Invalid Employee Count Range", "value": { "error": "Minimum employee count should not be greater than maximum employee count" } }, "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/underwriter-similar-linkedin-company": { "get": { "summary": "Get similar company by linkedin id", "tags": [ "Underwriter" ], "parameters": [ { "name": "linkedin_id", "in": "query", "required": true, "description": "Linkedin id identifier for the target company", "schema": { "type": "string", "example": "apple" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "example": 1 } }, { "name": "min_employee_count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Minimum Employee Count", "example": 100 } }, { "name": "max_employee_count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum Employee Count", "example": 1000 } } ], "description": "Company Linkedin id", "responses": { "200": { "description": "Successful response containing linkedin ids", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": "string", "example": "apple" }, "data": { "type": "array", "items": { "type": "string", "example": [ "ness-ses", "linkedin", "v-nova-ltd-", "blackbaud", "vmwarehorizon", "citrix", "kaseya", "software-ag", "redocly", "dynamicweb-software" ] } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 5 }, "total_items": { "type": "integer", "example": 47 } } } } } }, "message": { "type": "string", "example": "No companies found" } } }, "examples": { "with_data": { "summary": "Response with data", "value": { "linkedin_id": "apple", "data": [ "ness-ses", "linkedin", "v-nova-ltd-", "blackbaud", "vmwarehorizon", "citrix", "kaseya", "software-ag", "redocly", "dynamicweb-software" ], "pagination": { "current_page": 1, "page_size": 10, "total_pages": 5, "total_items": 47 } } }, "no_data": { "summary": "Response with message only", "value": { "linkedin_id": "apple", "data": "No companies found" } } } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "invalid_page": { "summary": "Invalid Page", "value": { "error": "Page value should not be less than 0" } }, "invalid_min_employee_count": { "summary": "Invalid Minimun Employee Count", "value": { "error": "Minimum employee count should be less than 0" } }, "invalid_max_employee_count": { "summary": "Invalid Maximun Employee Count", "value": { "error": "Minimum employee count should be less than 0" } }, "invalid_page_input": { "summary": "Invalid Page Input", "value": { "error": "Page must be a number" } }, "invalid_min_employee_count_input": { "summary": "Invalid Minimun Employee Count Input", "value": { "error": "Minimum employee count must be a number" } }, "invalid_max_employee_count_input": { "summary": "Invalid Maximun Employee Count Input", "value": { "error": "Maximum employee count must be a number" } }, "invalid_emp_range": { "summary": "Invalid Employee Count Range", "value": { "error": "Minimum employee count should not be greater than maximum employee count" } }, "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_linkedin_id": { "summary": "Invalid Linkedin Id", "value": { "error": "LinkedIn ID not valid. Please check and provide a valid LinkedIn ID" } }, "linkedin_id_not_found": { "summary": "Linkedin Id not found", "value": { "error": "This linkedin id has not been processed yet by our system, but the scan will start soon" } }, "required_params": { "summary": "Linkedin Id is a required parameter", "value": { "error": "Linkedin Id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } } } } } }, "401": { "description": "API key or membership related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } }, "package_issue": { "summary": "Package issue", "value": { "error": "You do not have access to the requested API. Please upgrade to the underwriter plan" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/vulnerability-describe-cve-id": { "get": { "summary": "Get all available information for the specified CVE", "tags": [ "Vulnerability" ], "description": "Information for the specified CVE", "parameters": [ { "name": "cve_id", "in": "query", "required": true, "description": "CVE Id (Common Vulnerability and Exposure)", "schema": { "type": "string", "example": "CVE-2016-3333" } } ], "responses": { "200": { "description": "Successful response containing information", "content": { "application/json": { "schema": { "type": "object", "properties": { "refmap": { "type": "object", "properties": { "bid": { "type": "array", "items": { "type": "string" } }, "sectrack": { "type": "array", "items": { "type": "string" } } } }, "vulnerable_configuration": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique CPE identifier" }, "title": { "type": "string", "description": "The title of the configuration" } } } }, "vulnerable_configuration_cpe_2_2": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique CPE identifier" }, "title": { "type": "string", "description": "The title of the configuration" } } } }, "vulnerable_product": { "type": "array", "items": { "type": "string" } }, "msbulletin": { "type": "array", "items": { "type": "object", "properties": { "bulletin_id": { "type": "string" }, "bulletin_url": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "impact": { "type": "string" }, "knowledgebase_id": { "type": "string" }, "knowledgebase_url": { "type": "string", "nullable": true }, "severity": { "type": "string" }, "title": { "type": "string" } } } }, "modified": { "type": "string", "format": "date-time" }, "published": { "type": "string", "format": "date-time" }, "access": { "type": "object", "properties": { "authentication": { "type": "string" }, "complexity": { "type": "string" }, "vector": { "type": "string" } } }, "assigner": { "type": "string" }, "capec": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prerequisites": { "type": "string" }, "related_weakness": { "type": "array", "items": { "type": "string" } }, "related_capecs": { "type": "array", "items": { "type": "string" } }, "solutions": { "type": "string" }, "summary": { "type": "string" }, "loa": { "type": "string" }, "typical_severity": { "type": "string" }, "taxonomy": { "type": "object" }, "execution_flow": { "type": "object", "additionalProperties": { "type": "object", "properties": { "Phase": { "type": "string" }, "Description": { "type": "string" }, "Techniques": { "type": "array", "items": { "type": "string" } } } } } } } }, "cvss": { "type": "number" }, "impactScore": { "type": "number" }, "exploitabilityScore": { "type": "number" }, "cvssTime": { "type": "string", "format": "date-time" }, "cvssVector": { "type": "string" }, "cwe": { "type": "string" }, "id": { "type": "string" }, "impact": { "type": "object", "properties": { "availability": { "type": "string" }, "confidentiality": { "type": "string" }, "integrity": { "type": "string" } } }, "impact3": { "type": "object", "properties": { "availability": { "type": "string" }, "confidentiality": { "type": "string" }, "integrity": { "type": "string" } } }, "exploitability3": { "type": "object", "properties": { "attackvector": { "type": "string" }, "attackcomplexity": { "type": "string" }, "privilegesrequired": { "type": "string" }, "userinteraction": { "type": "string" }, "scope": { "type": "string" } } }, "cvss3": { "type": "number" }, "impactScore3": { "type": "number" }, "exploitabilityScore3": { "type": "number" }, "lastModified": { "type": "string", "format": "date-time" }, "references": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" } } }, "example": { "refmap": { "bid": [ "94009" ], "sectrack": [ "1037252" ] }, "vulnerable_configuration": [ { "id": "cpe:2.3:o:microsoft:windows_10:-:*:*:*:*:*:*:*", "title": "cpe:2.3:o:microsoft:windows_10:-:*:*:*:*:*:*:*" }, { "id": "cpe:2.3:o:microsoft:windows_10:1511:*:*:*:*:*:*:*", "title": "cpe:2.3:o:microsoft:windows_10:1511:*:*:*:*:*:*:*" } ], "vulnerable_configuration_cpe_2_2": [ { "id": "cpe:2.3:o:microsoft:windows_10:-:*:*:*:*:*:*:*", "title": "cpe:2.3:o:microsoft:windows_10:-:*:*:*:*:*:*:*" }, { "id": "cpe:2.3:o:microsoft:windows_10:1511:*:*:*:*:*:*:*", "title": "cpe:2.3:o:microsoft:windows_10:1511:*:*:*:*:*:*:*" } ], "vulnerable_product": [ "cpe:2.3:o:microsoft:windows_10:-:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_10:1511:*:*:*:*:*:*:*" ], "msbulletin": [ { "bulletin_id": "MS16-134", "bulletin_url": null, "date": "2016-11-08T00:00:00", "impact": "Elevation of Privilege", "knowledgebase_id": "3193706", "knowledgebase_url": null, "severity": "Important", "title": "Security Update for Common Log File System Driver" } ], "modified": "2024-11-21T02:49:49.193000", "published": "2016-11-10T06:59:02.653000", "access": { "authentication": "NONE", "complexity": "MEDIUM", "vector": "NETWORK" }, "assigner": "secure@microsoft.com", "capec": [ { "id": "10", "name": "Buffer Overflow via Environment Variables", "prerequisites": "The application uses environment variables. An environment variable exposed to the user is vulnerable to a buffer overflow", "related_weakness": [ "118", "119", "120" ], "related_capecs": [ "100" ], "solutions": "Do not expose environment variable to the user. Do not use untrusted data in your environment variables", "summary": "This attack pattern involves causing a buffer overflow through manipulation of environment variables", "loa": "High", "typical_severity": "High", "taxonomy": {}, "execution_flow": { "1": { "Phase": "Explore", "Description": "[Identify target application] The adversary identifies a target application or program to perform the buffer overflow on", "Techniques": [] }, "2": { "Phase": "Experiment", "Description": "[Find injection vector] The adversary identifies an injection vector to deliver the excessive content to the targeted application's buffer", "Techniques": [ "Change the values of environment variables thought to be used by the application to contain excessive data" ] }, "3": { "Phase": "Experiment", "Description": "[Craft overflow content] The adversary crafts the content to be injected", "Techniques": [ "Create malicious shellcode that will execute when the program execution is returned to it", "Use a NOP-sled in the overflow content to more easily 'slide' into the malicious code" ] }, "4": { "Phase": "Exploit", "Description": "[Overflow the buffer] Using the injection vector, the adversary injects the crafted overflow content into the buffer", "Techniques": [] } } } ], "cvss": 9.3, "impactScore": 10, "exploitabilityScore": 8.6, "cvssTime": "2024-11-21T02:49:49.193000", "cvssVector": "AV:N/AC:M/Au:N/C:C/I:C/A:C", "cwe": "CWE-119", "id": "CVE-2016-3333", "impact": { "availability": "COMPLETE", "confidentiality": "COMPLETE", "integrity": "COMPLETE" }, "impact3": { "availability": "HIGH", "confidentiality": "HIGH", "integrity": "HIGH" }, "exploitability3": { "attackvector": "LOCAL", "attackcomplexity": "LOW", "privilegesrequired": "NONE", "userinteraction": "REQUIRED", "scope": "UNCHANGED" }, "cvss3": 7.8, "impactScore3": 5.9, "exploitabilityScore3": 1.8, "lastModified": "2024-11-21T02:49:49.193000", "references": [ "http://www.securityfocus.com/bid/94009", "http://www.securitytracker.com/id/1037252", "https://docs.microsoft.com/en-us/security-updates/securitybulletins/2016/ms16-134" ], "summary": "The Common Log File System (CLFS) driver in Microsoft Windows Vista SP2, Windows Server 2008 SP2 and R2 SP1, Windows 7 SP1, Windows 8.1, Windows Server 2012 Gold and R2, Windows RT 8.1, Windows 10 Gold, 1511, and 1607, and Windows Server 2016 allows local users to gain privileges via a crafted application" } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "required_params": { "summary": "cve_id is a required parameter", "value": { "error": "cve_id is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "error_processing_request": { "summary": "Error processing request", "value": { "error": "The messages indicating the cause or reason for failure or success" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/vulnerability-get-cve-from-cpe-id": { "get": { "summary": "Get a list of CVEs related to the product", "tags": [ "Vulnerability" ], "description": "CVEs related to the product", "parameters": [ { "name": "cpe", "in": "query", "required": true, "description": "cpe of the product", "schema": { "type": "string", "example": "cpe:2.3:o:gemteks:wrtm-127acn_firmware:01.01.02.141:*:*:*:*:*:*:*" } }, { "name": "limit", "in": "query", "required": false, "description": "Limit of response items. Default value is 500", "schema": { "type": "number", "example": 50 } } ], "responses": { "200": { "description": "Successful response containing information", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "refmap": { "type": "object", "properties": { "misc": { "type": "array", "items": { "type": "string" } } } }, "vulnerable_configuration": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" } } } }, "vulnerable_configuration_cpe_2_2": { "type": "array", "items": { "type": "string" } }, "vulnerable_product": { "type": "array", "items": { "type": "string" } }, "modified": { "type": "string", "format": "date-time" }, "published": { "type": "string", "format": "date-time" }, "access": { "type": "object", "properties": { "authentication": { "type": "string" }, "complexity": { "type": "string" }, "vector": { "type": "string" } } }, "assigner": { "type": "string" }, "cvss": { "type": "number" }, "impactScore": { "type": "number" }, "exploitabilityScore": { "type": "number" }, "cvssTime": { "type": "string", "format": "date-time" }, "cvssVector": { "type": "string" }, "cwe": { "type": "string" }, "id": { "type": "string" }, "impact": { "type": "object", "properties": { "availability": { "type": "string" }, "confidentiality": { "type": "string" }, "integrity": { "type": "string" } } }, "impact3": { "type": "object", "properties": { "availability": { "type": "string" }, "confidentiality": { "type": "string" }, "integrity": { "type": "string" } } }, "exploitability3": { "type": "object", "properties": { "attackvector": { "type": "string" }, "attackcomplexity": { "type": "string" }, "privilegesrequired": { "type": "string" }, "userinteraction": { "type": "string" }, "scope": { "type": "string" } } }, "cvss3": { "type": "number" }, "impactScore3": { "type": "number" }, "exploitabilityScore3": { "type": "number" }, "lastModified": { "type": "string", "format": "date-time" }, "references": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" } } } }, "example": [ { "refmap": { "misc": [ "http://packetstormsecurity.com/files/160136/Gemtek-WVRTM-127ACN-01.01.02.141-Command-Injection.html", "https://pastebin.com/QTev1TjM" ] }, "vulnerable_configuration": [ { "id": "cpe:2.3:o:gemteks:wrtm-127acn_firmware:01.01.02.141:*:*:*:*:*:*:*", "title": "cpe:2.3:o:gemteks:wrtm-127acn_firmware:01.01.02.141:*:*:*:*:*:*:*" }, { "id": "cpe:2.3:h:gemteks:wrtm-127acn:-:*:*:*:*:*:*:*", "title": "cpe:2.3:h:gemteks:wrtm-127acn:-:*:*:*:*:*:*:*" } ], "vulnerable_configuration_cpe_2_2": [], "vulnerable_product": [ "cpe:2.3:o:gemteks:wrtm-127acn_firmware:01.01.02.141:*:*:*:*:*:*:*", "cpe:2.3:o:gemteks:wrtm-127x9_firmware:01.01.02.127:*:*:*:*:*:*:*" ], "modified": "2024-11-21T05:14:40.330000", "published": "2020-09-24T15:15:14.437000", "access": { "authentication": "SINGLE", "complexity": "LOW", "vector": "NETWORK" }, "assigner": "cve@mitre.org", "cvss": 9, "impactScore": 10, "exploitabilityScore": 8, "cvssTime": "2024-11-21T05:14:40.330000", "cvssVector": "AV:N/AC:L/Au:S/C:C/I:C/A:C", "cwe": "CWE-1188", "id": "CVE-2020-24365", "impact": { "availability": "COMPLETE", "confidentiality": "COMPLETE", "integrity": "COMPLETE" }, "impact3": { "availability": "HIGH", "confidentiality": "HIGH", "integrity": "HIGH" }, "exploitability3": { "attackvector": "NETWORK", "attackcomplexity": "LOW", "privilegesrequired": "LOW", "userinteraction": "NONE", "scope": "UNCHANGED" }, "cvss3": 8.8, "impactScore3": 5.9, "exploitabilityScore3": 2.8, "lastModified": "2024-11-21T05:14:40.330000", "references": [ "http://packetstormsecurity.com/files/160136/Gemtek-WVRTM-127ACN-01.01.02.141-Command-Injection.html", "https://pastebin.com/QTev1TjM" ], "summary": "An issue was discovered on Gemtek WRTM-127ACN 01.01.02.141 and WRTM-127x9 01.01.02.127 devices. The Monitor Diagnostic network page allows an authenticated attacker to execute a command directly on the target machine" } ] } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "required_params": { "summary": "cpe is a required parameter", "value": { "error": "cpe is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "error_processing_request": { "summary": "Error processing request", "value": { "error": "The messages indicating the cause or reason for failure or success" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/vulnerability-get-last": { "get": { "summary": "Get last n amount of vulnerabilities", "tags": [ "Vulnerability" ], "description": "Last n amount of vulnerabilities", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Limit of response items. Default value is 30", "schema": { "type": "number", "example": 50 } } ], "responses": { "200": { "description": "Successful response containing domain information", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "vulnerable_configuration_cpe_2_2": { "type": "array", "items": { "type": "string" } }, "modified": { "type": "string", "format": "date-time" }, "published": { "type": "string", "format": "date-time" }, "assigner": { "type": "string" }, "cwe": { "type": "string" }, "id": { "type": "string" }, "impact3": { "type": "object", "properties": { "availability": { "type": "string" }, "confidentiality": { "type": "string" }, "integrity": { "type": "string" } } }, "exploitability3": { "type": "object", "properties": { "attackvector": { "type": "string" }, "attackcomplexity": { "type": "string" }, "privilegesrequired": { "type": "string" }, "userinteraction": { "type": "string" }, "scope": { "type": "string" } } }, "cvss3": { "type": "number" }, "impactScore3": { "type": "number" }, "exploitabilityScore3": { "type": "number" }, "lastModified": { "type": "string", "format": "date-time" }, "references": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" } } } }, "example": [ { "vulnerable_configuration_cpe_2_2": [], "modified": "2025-01-23T23:15:08.113000", "published": "2025-01-23T23:15:08.113000", "assigner": "cve@mitre.org", "cwe": "Unknown", "id": "CVE-2024-55573", "impact3": { "availability": "HIGH", "confidentiality": "HIGH", "integrity": "HIGH" }, "exploitability3": { "attackvector": "NETWORK", "attackcomplexity": "LOW", "privilegesrequired": "HIGH", "userinteraction": "NONE", "scope": "CHANGED" }, "cvss3": 9.1, "impactScore3": 6, "exploitabilityScore3": 2.3, "lastModified": "2025-01-23T23:15:08.113000", "references": [ "https://github.com/centreon/centreon/releases", "https://thewatch.centreon.com/latest-security-bulletins-64/cve-2024-55573-centreon-web-critical-severity-4264" ], "summary": "An issue was discovered in Centreon centreon-web 24.10.x before 24.10.3, 24.04.x before 24.04.9, 23.10.x before 23.10.19, 23.04.x before 23.04.24. A user with high privileges is able to inject SQL into the form used to create virtual metrics" } ] } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "error_processing_request": { "summary": "Error processing request", "value": { "error": "The messages indicating the cause or reason for failure or success" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/vulnerability-get-product-by-vendor": { "get": { "summary": "Get a list of products by vendors", "tags": [ "Vulnerability" ], "description": "List of products by vendors", "parameters": [ { "name": "vendor", "in": "query", "required": true, "description": "Vendor name", "schema": { "type": "string", "example": "microsoft" } } ], "responses": { "200": { "description": "Successful response containing information", "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor": { "type": "string", "example": "microsoft" }, "product": { "type": "array", "items": { "type": "string" } } } }, "example": { "vendor": "microsoft", "product": [ ".net_core", ".net_core_sdk", ".net_framework" ] } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "error_processing_request": { "summary": "Error processing request", "value": { "error": "The messages indicating the cause or reason for failure or success" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/vulnerability-get-vendors": { "get": { "summary": "Get a list of vendors", "tags": [ "Vulnerability" ], "description": "List of vendors", "responses": { "200": { "description": "Successful response containing information", "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor": { "type": "array", "items": { "type": "string" } } } }, "example": { "vendor": [ "01-scripts", "01generator", "01org" ] } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "error_processing_request": { "summary": "Error processing request", "value": { "error": "The messages indicating the cause or reason for failure or success" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } }, "/vulnerability-search-by-vendor": { "get": { "summary": "Get a list of CVEs related to the product", "tags": [ "Vulnerability" ], "description": "List of CVEs related to the product", "parameters": [ { "name": "product", "in": "query", "required": true, "description": "Product name", "schema": { "type": "string", "example": "excel" } }, { "name": "vendor", "in": "query", "required": true, "description": "Vendor name", "schema": { "type": "string", "example": "microsoft" } } ], "responses": { "200": { "description": "Successful response containing cve information", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "vulnerable_configuration": { "type": "array", "items": { "type": "string" } }, "vulnerable_configuration_cpe_2_2": { "type": "array", "items": { "type": "string" } }, "vulnerable_product": { "type": "array", "items": { "type": "string" } }, "modified": { "type": "string", "format": "date-time" }, "published": { "type": "string", "format": "date-time" }, "access": { "type": "object", "properties": { "authentication": { "type": "string" }, "complexity": { "type": "string" }, "vector": { "type": "string" } } }, "assigner": { "type": "string" }, "capec": { "type": "string", "nullable": true }, "cvss": { "type": "number" }, "impactScore": { "type": "number" }, "exploitabilityScore": { "type": "number" }, "cvssTime": { "type": "string", "format": "date-time" }, "cvssVector": { "type": "string" }, "cwe": { "type": "string" }, "id": { "type": "string" }, "impact": { "type": "object", "properties": { "availability": { "type": "string" }, "confidentiality": { "type": "string" }, "integrity": { "type": "string" } } }, "impact3": { "type": "object", "additionalProperties": true }, "exploitability3": { "type": "object", "additionalProperties": true }, "cvss3": { "type": "number", "nullable": true }, "impactScore3": { "type": "number", "nullable": true }, "exploitabilityScore3": { "type": "number", "nullable": true }, "cvss3-vector": { "type": "string", "nullable": true }, "lastModified": { "type": "string", "format": "date-time" }, "references": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" } } } } } }, "example": { "results": [ { "vulnerable_configuration": [ "cpe:2.3:a:microsoft:excel:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_2000:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_95:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_98:*:gold:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_nt:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_nt:4.0:*:*:*:*:*:*:*" ], "vulnerable_configuration_cpe_2_2": [], "vulnerable_product": [ "cpe:2.3:a:microsoft:excel:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_2000:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_95:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_98:*:gold:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_nt:*:*:*:*:*:*:*:*", "cpe:2.3:o:microsoft:windows_nt:4.0:*:*:*:*:*:*:*" ], "modified": "2024-11-20T23:29:18.273000", "published": "1999-05-07T04:00:00", "access": { "authentication": "NONE", "complexity": "HIGH", "vector": "NETWORK" }, "assigner": "cve@mitre.org", "capec": null, "cvss": 2.6, "impactScore": 2.9, "exploitabilityScore": 4.9, "cvssTime": "2024-11-20T23:29:18.273000", "cvssVector": "AV:N/AC:H/Au:N/C:N/I:P/A:N", "cwe": "NVD-CWE-Other", "id": "CVE-1999-0717", "impact": { "availability": "NONE", "confidentiality": "NONE", "integrity": "PARTIAL" }, "impact3": {}, "exploitability3": {}, "cvss3": null, "impactScore3": null, "exploitabilityScore3": null, "cvss3-vector": null, "lastModified": "2024-11-20T23:29:18.273000", "references": [ "http://support.microsoft.com/default.aspx?scid=kb%3B%5BLN%5D%3BQ231304", "https://docs.microsoft.com/en-us/security-updates/securitybulletins/1999/ms99-014", "http://support.microsoft.com/default.aspx?scid=kb%3B%5BLN%5D%3BQ231304", "https://docs.microsoft.com/en-us/security-updates/securitybulletins/1999/ms99-014" ], "summary": "A remote attacker can disable the virus warning mechanism in Microsoft Excel 97" } ] } } } }, "400": { "description": "Generic Issues", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_issue": { "summary": "API Issue", "value": { "error": "API issue, please reach out to support@rankiteo.com" } }, "required_param_vendor": { "summary": "Vendor is a required parameter", "value": { "error": "Vendor is a required parameter" } }, "required_param_product": { "summary": "Product is a required parameter", "value": { "error": "Product is a required parameter" } }, "invalid_request": { "summary": "Invalid request", "value": { "error": "Invalid request" } }, "error_processing_request": { "summary": "Error processing request", "value": { "error": "The messages indicating the cause or reason for failure or success" } } } } } }, "401": { "description": "API key related issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_key_issue": { "summary": "API key issue", "value": { "error": "Invalid API key" } }, "deactivated_api_key": { "summary": "Deactivated API key", "value": { "error": "API key is deactivated" } }, "api_key_missing": { "summary": "API key missing", "value": { "error": "API Key is required" } } } } } }, "404": { "description": "Route Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_msg": { "type": "string", "example": "404 Route Not Found" } } } } } }, "429": { "description": "Rate limit issue", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "api_rate_limit": { "summary": "API rate limit exceeded", "value": { "error": "API rate limit exceeded" } }, "too_many_requests": { "summary": "Too many requests", "value": { "error": "Too many API requests per minute" } } } } } } } } } } }