REST/JSON API over the Interos supplier-resilience graph: organization search, organization and risk profiles, supplier connections and tiers, organization groups, custom fields, and scenario watchlists. Cursor-paginated; authenticated with x-api-key and x-customer-id headers.
{"components":{"schemas":{"Address":{"properties":{"city":{"title":"City","type":"string","description":"City of the organization's branch location"},"country_code":{"title":"Country Code","type":"string","description":"3 digit country code of organization's branch location"},"is_primary":{"title":"Is Primary","type":"boolean","description":"Not used - see ultimate_parent fields"},"latitude":{"title":"Latitude","type":"number","description":"Latitude of organization's branch location"},"longitude":{"title":"Longitude","type":"number","description":"Longitude of organization's branch location"},"postal_code":{"title":"Postal Code","type":"string","description":"Postal code of organization's branch location"},"province":{"title":"Province","type":"string","description":"Province of organization's branch location"},"street_address":{"title":"Street Address","type":"string","description":"Street address of organization's branch location (Line 1)"},"street_address_2":{"title":"Street Address 2","type":"string","description":"Street address of organization's branch location (Line 2)"}},"title":"Address","type":"object"},"APICustomField":{"title":"APICustomField","required":["custom_field_id","field_title","field_type","field_slug"],"type":"object","properties":{"custom_field_id":{"title":"Custom Field Id","type":"string","format":"uuid"},"field_title":{"title":"Field Title","type":"string"},"field_type":{"$ref":"#/components/schemas/FieldType"},"field_slug":{"title":"Field Slug","type":"string"},"description":{"title":"Description","type":"string"},"metadata":{"title":"Metadata","type":"object","additionalProperties":{"type":"string"}},"scenario_id":{"title":"Scenario Id","type":"string","format":"uuid"},"category_id":{"title":"Category Id","type":"string","format":"uuid"},"category_name":{"title":"Category Name","type":"string"}}},"APICustomFieldsResponse":{"title":"APICustomFieldsResponse","type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/APICustomField"},"default":[]},"total_count":{"title":"Total Count","type":"integer"},"next":{"title":"Next","type":"string"}}},"Attribute":{"title":"Attribute","required":["attribute_key"],"type":"object","properties":{"attribute_key":{"title":"Attribute Key","type":"string"},"attribute_name":{"title":"Attribute Name","type":"string"},"attribute_description":{"title":"Attribute Description","type":"string"},"risk_subfactor_key":{"title":"Risk Subfactor Key","type":"string"}}},"AttributeDataElementValue":{"title":"AttributeDataElementValue","required":["attribute_key"],"type":"object","properties":{"data_element_type":{"title":"Data Element Type","enum":["attribute"],"type":"string","default":"attribute"},"attribute_key":{"title":"Attribute Key","type":"string"},"value":{"title":"Value","anyOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"$ref":"#/components/schemas/EntityTableFieldValue"}]},"formatted_value":{"title":"Formatted Value","type":"string"}}},"CustomField":{"title":"CustomField","required":["custom_field_id","field_title","field_type","field_slug"],"type":"object","properties":{"custom_field_id":{"title":"Custom Field Id","type":"string","format":"uuid"},"field_title":{"title":"Field Title","type":"string"},"field_type":{"title":"Field Type","type":"string"},"field_slug":{"title":"Field Slug","type":"string"},"description":{"title":"Description","type":"string"},"metadata":{"title":"Metadata","type":"object"},"field_settings":{"title":"Field Settings","type":"object"}}},"CustomFieldDataElementValue":{"title":"CustomFieldDataElementValue","required":["field_slug"],"type":"object","properties":{"data_element_type":{"title":"Data Element Type","enum":["custom_field"],"type":"string","default":"custom_field"},"field_slug":{"title":"Field Slug","type":"string"},"value":{"title":"Value","anyOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"$ref":"#/components/schemas/EntityTableFieldValue"}]}}},"EntityTableFieldValue":{"title":"EntityTableFieldValue","required":["column_slugs","rows"],"type":"object","properties":{"column_slugs":{"title":"Column Slugs","type":"array","items":{"type":"string"},"description":"The slugs of the columns. The ordering of the slugs derives the ordering of cell values within the rows."},"rows":{"title":"Rows","type":"array","items":{"$ref":"#/components/schemas/EntityTableFieldValueRow"},"description":"The rows making up this table value."}}},"EntityTableFieldValueRow":{"title":"EntityTableFieldValueRow","required":["cell_values"],"type":"object","properties":{"cell_values":{"title":"Cell Values","type":"array","items":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"number"}]},"description":"The values this row has for each cell."}}},"FieldType":{"title":"FieldType","enum":["BOOLEAN","DATE","DATE_TIME","DECIMAL","DYNAMIC_BOOLEAN","DYNAMIC_DECIMAL","DYNAMIC_INTEGER","DYNAMIC_PRIORITY","DYNAMIC_TEXT","INTEGER","LONG_TEXT","MULTI_SELECT","SHORT_TEXT","SINGLE_SELECT","TABLE"],"description":"An enumeration."},"ForbiddenError":{"properties":{"detail":{"title":"Detail","type":"string"}},"title":"ForbiddenError","type":"object"},"GetOrgsWithScenariosForWatchlistReferenceData":{"title":"GetOrgsWithScenariosForWatchlistReferenceData","required":["scenarios","custom_fields","attributes","risk_subfactors"],"type":"object","properties":{"scenarios":{"title":"Scenarios","type":"array","items":{"$ref":"#/components/schemas/Scenario"}},"custom_fields":{"title":"Custom Fields","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"attributes":{"title":"Attributes","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"risk_subfactors":{"title":"Risk Subfactors","type":"array","items":{"$ref":"#/components/schemas/RiskSubfactor"}}}},"GroupWithOrgTiers":{"title":"GroupWithOrgTiers","required":["group_id","group_name","tiers"],"type":"object","properties":{"group_id":{"title":"Group Id","type":"string","format":"uuid"},"group_name":{"title":"Group Name","type":"string"},"tiers":{"title":"Tiers","type":"array","items":{"type":"integer"}}}},"HTTPDetail":{"title":"HTTPDetail","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Loc","type":"array","items":{"type":"string"}},"msg":{"title":"Msg","type":"string"},"type":{"title":"Type","type":"string"}}},"HTTPError":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"HTTPError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"IScore":{"properties":{"level":{"$ref":"#/components/schemas/ScoreLevel"},"score":{"title":"Score","type":"integer"}},"title":"IScore","type":"object"},"Organization":{"properties":{"country_code":{"nullable":true,"title":"Country Code","type":"string","description":"3 digit country code of organization's primary location"},"description":{"nullable":true,"title":"Description","type":"string","description":"Short description of organization"},"description_long":{"nullable":true,"title":"Description Long","type":"string","description":"Expanded description of organization"},"founding_date":{"format":"date","nullable":true,"title":"Founding Date","type":"string","description":"Date on which organization was founded"},"group_info":{"items":{"$ref":"#/components/schemas/OrganizationGroupBase"},"nullable":true,"title":"Group Info","type":"array"},"industry":{"nullable":true,"title":"DEPRECATED Industry","type":"string","description":"DEPRECATED NAICS industry name"},"industry_category_code":{"nullable":true,"title":"Industry Category Code","type":"string","description":"Industry Category Code"},"industry_category_name":{"nullable":true,"title":"Industry Category Name","type":"string","description":"Industry Category Name"},"industry_naics_code":{"nullable":true,"title":"Industry NAICS Code","type":"string","description":"Industry NAICS Code"},"industry_naics_name":{"nullable":true,"title":"Industry NAICS Name","type":"string","description":"Industry NAICS Name"},"industry_sic_code":{"nullable":true,"title":"Industry SIC Code","type":"string","description":"Industry SIC Code"},"industry_sic_name":{"nullable":true,"title":"Industry SIC Name","type":"string","description":"Industry SIC Name"},"is_pr":{"nullable":true,"title":"Is Pr","type":"boolean","description":"True if organization is on any Restrictions lists"},"is_unlocked":{"nullable":true,"title":"Is Unlocked","type":"boolean","description":"Indicates if organization is unlocked for the accessing customer"},"locations":{"items":{"$ref":"#/components/schemas/Address"},"nullable":true,"title":"Locations","type":"array"},"name":{"title":"Name","type":"string","description":"Official legal name of organization"},"organization_id":{"format":"uuid","title":"Organization Id","type":"string","description":"Unique Interos identifier of organization"},"new_organization_id":{"nullable":true,"format":"uuid","title":"New Organization Id","type":"string","description":"(New) Unique Interos identifier of organization, if the current `organization_id` is deprecated"},"primary_cage_code":{"nullable":true,"title":"Primary Cage Code","type":"string","description":"Primary CAGE Code of the organization"},"primary_duns_number":{"nullable":true,"title":"Primary Duns Number","type":"string"},"primary_location":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true,"title":"Primary Location"},"product_categories_bought":{"items":{"$ref":"#/components/schemas/ProductCategory"},"nullable":true,"title":"Product Categories Bought","type":"array","description":"List of product categories bought and last observed dates associated with this organization, ordered by last observed date"},"product_categories_sold":{"items":{"$ref":"#/components/schemas/ProductCategory"},"nullable":true,"title":"Product Categories Sold","type":"array","description":"List of product categories sold and last observed dates associated with this organization, ordered by last observed date"},"profile_link":{"nullable":true,"title":"Profile Link","type":"string","description":"URL to the organization's Interos profile"},"restrictions":{"items":{"$ref":"#/components/schemas/RestrictedList"},"nullable":true,"title":"Restrictions","type":"array"},"risk_profile":{"allOf":[{"$ref":"#/components/schemas/RiskProfile"}],"nullable":true,"title":"Risk Profile"},"risk_score":{"allOf":[{"$ref":"#/components/schemas/IScore"}],"nullable":true,"title":"Risk Score"},"ultimate_parent_id":{"nullable":true,"title":"Ultimate Parent Id","type":"string","description":"Unique Interos identifier of ultimate parent"},"ultimate_parent_name":{"nullable":true,"title":"Ultimate Parent Name","type":"string","description":"Official legal name of ultimate parent"},"ultimate_parent_country_code":{"nullable":true,"title":"Ultimate Parent Country Code","type":"string","description":"3 digit country code of ultimate parent's primary location"},"updated_date":{"format":"date-time","nullable":true,"title":"Updated Date","type":"string","description":"Last time the organization was updated"},"url":{"nullable":true,"title":"Url","type":"string","description":"Homepage URL of organization"}},"required":["organization_id","name"],"title":"Organization","type":"object"},"OrganizationDetailLevel":{"description":"An enumeration.","enum":["detailed","basic"],"title":"OrganizationDetailLevel","type":"string"},"OrganizationGroup":{"properties":{"created_date":{"format":"date-time","title":"Created Date","type":"string"},"customer_id":{"title":"Customer Id","type":"string"},"description":{"title":"Description","type":"string"},"group_id":{"format":"uuid","title":"Group Id","type":"string"},"is_my_ecosystem_group":{"title":"Is My Ecosystem Group","type":"boolean"},"is_unlocked_orgs_group":{"title":"Is Unlocked Orgs Group","type":"boolean"},"name":{"title":"Name","type":"string"},"organization_count":{"default":0,"title":"Organization Count","type":"integer"}},"required":["group_id","customer_id","name","created_date","is_my_ecosystem_group","is_unlocked_orgs_group"],"title":"OrganizationGroup","type":"object"},"OrganizationGroupBase":{"properties":{"group_id":{"format":"uuid","title":"Group Id","type":"string","description":"Unique identifier of the customer defined group"},"name":{"title":"Name","type":"string","description":"Name of the customer defined group"}},"required":["group_id","name"],"title":"OrganizationGroupBase","type":"object"},"OrganizationGroupList":{"properties":{"data":{"default":[],"items":{"$ref":"#/components/schemas/OrganizationGroup"},"title":"Data","type":"array"},"next":{"title":"Next","type":"string"},"total_count":{"title":"Total Count","type":"integer"}},"title":"PaginatedList[OrganizationGroup]","type":"object"},"OrganizationList":{"properties":{"data":{"default":[],"items":{"$ref":"#/components/schemas/Organization"},"title":"Data","type":"array"},"next":{"title":"Next","type":"string"},"total_count":{"title":"Total Count","type":"integer"}},"title":"PaginatedList[Organization]","type":"object"},"OrganizationSearchLiteResult":{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"name":{"nullable":true,"title":"Name","type":"string"},"url":{"nullable":true,"title":"Url","type":"string"},"city":{"nullable":true,"title":"City","type":"string"},"province":{"nullable":true,"title":"Province","type":"string"},"country_code":{"nullable":true,"title":"Country Code","type":"string"},"street_address":{"nullable":true,"title":"Street Address","type":"string"},"street_address_2":{"nullable":true,"title":"Street Address 2","type":"string"},"postal_code":{"nullable":true,"title":"Postal Code","type":"string"},"duns":{"items":{"type":"string"},"nullable":true,"title":"Duns","type":"array"},"cage_code":{"items":{"type":"string"},"nullable":true,"title":"Cage Code","type":"array"},"ueid":{"items":{"type":"string"},"nullable":true,"title":"Ueid","type":"array"}},"required":["id"],"title":"OrganizationSearchLiteResult","type":"object"},"PaginatedListWithReferenceData_WatchlistOrganization__GetOrgsWithScenariosForWatchlistReferenceData_":{"title":"PaginatedListWithReferenceData[WatchlistOrganization, GetOrgsWithScenariosForWatchlistReferenceData]","type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/WatchlistOrganization"},"default":[]},"reference_data":{"title":"Reference Data","allOf":[{"$ref":"#/components/schemas/GetOrgsWithScenariosForWatchlistReferenceData"}],"default":{}},"total_count":{"title":"Total Count","type":"integer"},"next":{"title":"Next","type":"string"}}},"PostOrganizationWithStaticCustomFieldValues":{"title":"PostOrganizationWithStaticCustomFieldValues","required":["organization_id","values"],"type":"object","properties":{"organization_id":{"title":"Organization Id","type":"string","format":"uuid"},"values":{"title":"Values","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PostStaticCustomFieldValue"}}}},"PostOrganizationsStaticCustomFieldsValuesInvalidOrganization":{"title":"PostOrganizationsStaticCustomFieldsValuesInvalidOrganization","required":["organization_id","validation_errors"],"type":"object","properties":{"organization_id":{"title":"Organization Id","type":"string","format":"uuid"},"validation_errors":{"title":"Validation Errors","type":"array","items":{"$ref":"#/components/schemas/PostOrganizationsStaticCustomFieldsValuesValidationError"}}}},"PostOrganizationsStaticCustomFieldsValuesRequest":{"title":"PostOrganizationsStaticCustomFieldsValuesRequest","required":["custom_field_slugs","organizations"],"type":"object","properties":{"custom_field_slugs":{"title":"Custom Field Slugs","maxItems":50,"minItems":1,"type":"array","items":{"type":"string"}},"organizations":{"title":"Organizations","maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PostOrganizationWithStaticCustomFieldValues"}}}},"PostOrganizationsStaticCustomFieldsValuesResponse":{"title":"PostOrganizationsStaticCustomFieldsValuesResponse","required":["updated_organization_ids","invalid_organizations"],"type":"object","properties":{"updated_organization_ids":{"title":"Updated Organization Ids","type":"array","items":{"type":"string","format":"uuid"}},"invalid_organizations":{"title":"Invalid Organizations","type":"array","items":{"$ref":"#/components/schemas/PostOrganizationsStaticCustomFieldsValuesInvalidOrganization"}}}},"PostOrganizationsStaticCustomFieldsValuesValidationError":{"title":"PostOrganizationsStaticCustomFieldsValuesValidationError","required":["message","type"],"type":"object","properties":{"message":{"title":"Message","type":"string"},"type":{"title":"Type","type":"string"},"field_index":{"title":"Field Index","type":"integer"}}},"PostStaticCustomFieldValue":{"title":"PostStaticCustomFieldValue","type":"object","properties":{"value":{"title":"Value"}}},"ProductCategory":{"properties":{"product_category_name":{"title":"Product Cateogry Name","type":"string","description":"Product category name"},"last_observed_date":{"title":"Last Observed Date","type":"string","description":"Most recent date when this organization was observed to have bought or sold this product category"}},"title":"ProductCategory","type":"object"},"RestrictedList":{"properties":{"list_category":{"nullable":true,"title":"List Category","type":"string","description":"Label under which the Restrictions list is categorized"},"list_description":{"nullable":true,"title":"List Description","type":"string","description":"Short description of the Restrictions list"},"list_id":{"format":"uuid","title":"List Id","type":"string","description":"Interos unique ID for the Restrictions list"},"list_key":{"nullable":true,"title":"List Key","type":"string","description":"(Unused)"},"list_name":{"title":"List Name","type":"string","description":"Short name of the Restrictions list"},"list_segment":{"allOf":[{"$ref":"#/components/schemas/Segment"}],"default":"Firm","description":"Indicates whether the Restrictions list applies to the organization or primary country"},"list_source_url":{"nullable":true,"title":"List Source Url","type":"string","description":"URL to where the Restrictions list can be accessed"},"list_additional_context":{"nullable":true,"title":"List Additional Context","type":"string","description":"Description that explains why the company is on a restrictions list"},"list_first_added_date":{"nullable":true,"title":"List First Added Date","type":"string","description":"The date a company was first added to a restrictions list"},"list_removed_date":{"nullable":true,"title":"List Removed Date","type":"string","description":"The date a company was removed from a restrictions list"},"list_last_observed_date":{"nullable":true,"title":"List Last Observed Date","type":"string","description":"The date a company's listing was most recently updated"},"list_active_status":{"nullable":true,"title":"List Active Status","type":"boolean","description":"Indicator to identify if a restriction is active or not"}},"required":["list_id","list_name"],"title":"RestrictedList","type":"object"},"RiskAttribute":{"properties":{"description":{"title":"Description","type":"string"},"display_value":{"title":"Display Value","type":"string"},"key":{"title":"Key","type":"string"},"label":{"title":"Label","type":"string"},"source_name":{"title":"Source Name","type":"string"},"source_url":{"title":"Source Url","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","label"],"title":"RiskAttribute","type":"object"},"RiskFactorCodes":{"title":"RiskFactorCodes","enum":["geopolitical","finance","cyber","esg","operations","restrictions","catastrophic"],"type":"string","description":"An enumeration."},"RiskFactorScore":{"properties":{"description":{"nullable":true,"title":"Description","type":"string","description":"Short description of the Risk Factor this data supports"},"label":{"title":"Label","type":"string","description":"Overarching label that is given to the Risk Factor"},"level":{"$ref":"#/components/schemas/ScoreLevel","description":"Level of risk that the Risk Factor data presents to the organization"},"name":{"title":"Name","type":"string","description":"Name of Risk Factor this data supports: Cyber, Finance, ESG, Geopolitical, Operations, or Restrictions"},"risk_variables":{"items":{"$ref":"#/components/schemas/RiskVariableScore"},"nullable":true,"title":"Risk Variables","type":"array"},"score":{"title":"Score","type":"integer"},"timestamp":{"format":"date-time","title":"Timestamp","type":"string"},"count_restriction_lists":{"nullable":true,"title":"Count Restriction Lists","type":"integer","description":"Count of current active restriction lists (only for the restrictions risk factor)"}},"required":["level","name","timestamp"],"title":"RiskFactorScore","type":"object"},"RiskFactorScoreDataElementValue":{"title":"RiskFactorScoreDataElementValue","required":["risk_factor_key"],"type":"object","properties":{"data_element_type":{"title":"Data Element Type","enum":["risk_factor_score"],"type":"string","default":"risk_factor_score"},"risk_factor_key":{"$ref":"#/components/schemas/RiskFactorCodes"},"value":{"title":"Value","type":"integer"}}},"RiskProfile":{"properties":{"overall":{"$ref":"#/components/schemas/Score"},"risk_factors":{"items":{"$ref":"#/components/schemas/RiskFactorScore"},"title":"Risk Factors","type":"array"}},"required":["overall"],"title":"RiskProfile","type":"object"},"RiskSubfactor":{"title":"RiskSubfactor","required":["risk_subfactor_key"],"type":"object","properties":{"risk_subfactor_key":{"title":"Risk Subfactor Key","type":"string"},"risk_subfactor_name":{"title":"Risk Subfactor Name","type":"string"},"risk_subfactor_segment":{"title":"Risk Subfactor Segment","type":"string"},"risk_subfactor_description":{"title":"Risk Subfactor Description","type":"string"},"risk_factor_key":{"title":"Risk Factor Key","type":"string"}}},"RiskSubfactorScoreDataElementValue":{"title":"RiskSubfactorScoreDataElementValue","required":["risk_subfactor_key"],"type":"object","properties":{"data_element_type":{"title":"Data Element Type","enum":["risk_subfactor_score"],"type":"string","default":"risk_subfactor_score"},"risk_subfactor_key":{"title":"Risk Subfactor Key","type":"string"},"value":{"title":"Value","type":"integer"}}},"RiskVariableScore":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/RiskAttribute"},"nullable":true,"title":"Attributes","type":"array"},"description":{"nullable":true,"title":"Description","type":"string"},"label":{"title":"Label","type":"string"},"level":{"$ref":"#/components/schemas/ScoreLevel"},"name":{"title":"Name","type":"string"},"score":{"title":"Score","type":"integer"},"segment":{"title":"Segment","type":"string"},"timestamp":{"format":"date-time","title":"Timestamp","type":"string"}},"required":["name","label","timestamp"],"title":"RiskVariableScore","type":"object"},"Scenario":{"title":"Scenario","required":["scenario_id","scenario_name","backing_custom_field_id"],"type":"object","properties":{"scenario_id":{"title":"Scenario Id","type":"string","format":"uuid"},"scenario_name":{"title":"Scenario Name","type":"string"},"scenario_description":{"title":"Scenario Description","type":"string"},"backing_custom_field_id":{"title":"Backing Custom Field Id","type":"string","format":"uuid"}}},"ScenarioActivity":{"title":"ScenarioActivity","enum":["ALL","POSITIVE","NEGATIVE"],"description":"An enumeration."},"ScenarioOrganizationLink":{"title":"ScenarioOrganizationLink","required":["scenario_id","organization_id","first_detected","status_updated","most_recent_positive_detection"],"type":"object","properties":{"scenario_id":{"title":"Scenario ID","type":"string","description":"The ID of the scenario.","format":"uuid"},"organization_id":{"title":"Organization ID","type":"string","description":"The ID of the organization.","format":"uuid"},"first_detected":{"title":"First Detected","type":"string","description":"The date and time this organization was first detected as triggering this scenario.","format":"date-time"},"status_updated":{"title":"Status Updated","type":"string","description":"The date and time this organization given its current status for this scenario.","format":"date-time"},"most_recent_positive_detection":{"title":"Most Recent Positive Detection","type":"string","description":"The date and time this organization was most recently detected as triggering this scenario.","format":"date-time"},"most_recent_negative_detection":{"title":"Most Recent Negative Detection","type":"string","description":"The date and time this organization was most recently detected as not triggering this scenario.","format":"date-time"},"contributing_variables_last_updated":{"title":"Contributing Variables Last Updated","type":"string","description":"The date and time this organization most recently had a change in the variables that contribute to this scenario detection.","format":"date-time"},"has_had_current_trigger_state_since":{"title":"Has Had Current Trigger state since","type":"string","description":"The date and time this organization last changed from triggering this scenario to not triggering, or vice versa.","format":"date-time"},"status":{"title":"Status","allOf":[{"$ref":"#/components/schemas/ScenarioOrganizationStatus"}],"description":"Status of this organization for this scenario."},"current_detection_details":{"title":"Current Detection Details","allOf":[{"$ref":"#/components/schemas/ScenarioOrganizationLinkCurrentDetectionDetails"}],"description":"Information about the current detection. Null if the organization is not currently triggering this scenario."}}},"ScenarioOrganizationLinkCurrentDetectionDetails":{"title":"ScenarioOrganizationLinkCurrentDetectionDetails","required":["contributing_data_elements"],"type":"object","properties":{"contributing_data_elements":{"title":"Contributing Data Elements","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/CustomFieldDataElementValue"},{"$ref":"#/components/schemas/AttributeDataElementValue"},{"$ref":"#/components/schemas/RiskSubfactorScoreDataElementValue"},{"$ref":"#/components/schemas/RiskFactorScoreDataElementValue"}]},"description":"The data elements that are contributing to this organization triggering this scenario."}}},"ScenarioOrganizationStatus":{"title":"ScenarioOrganizationStatus","enum":["open","in_progress","closed"],"description":"An enumeration."},"Score":{"properties":{"description":{"nullable":true,"title":"Description","type":"string"},"label":{"title":"Label","type":"string"},"level":{"$ref":"#/components/schemas/ScoreLevel"},"name":{"title":"Name","type":"string"},"score":{"title":"Score","type":"integer"},"timestamp":{"format":"date-time","title":"Timestamp","type":"string"}},"required":["name","label","timestamp"],"title":"Score","type":"object"},"ScoreLevel":{"description":"An enumeration.","enum":["Low","Medium","High","Extreme","No"],"title":"ScoreLevel","type":"string"},"Segment":{"description":"An enumeration.","enum":["Firm","Country","Industry"],"title":"Segment","type":"string"},"SimplePathOrganization":{"properties":{"country_code":{"nullable":true,"title":"Country Code","type":"string"},"organization_id":{"format":"uuid","title":"Organization Id","type":"string"},"organization_name":{"nullable":true,"title":"Organization Name","type":"string"},"risk_factor_scores":{"items":{"$ref":"#/components/schemas/SimpleScore"},"nullable":true,"title":"Risk Factor Scores","type":"array"},"risk_score":{"allOf":[{"$ref":"#/components/schemas/IScore"}],"nullable":true,"title":"Risk Score"},"primary_industry":{"nullable":true,"title":"DEPRECATED Primary Industry","type":"string","description":"DEPRECATED Primary Industry Name"},"industry_category_code":{"nullable":true,"title":"Industry Category Code","type":"string","description":"Industry Category Code"},"industry_category_name":{"nullable":true,"title":"Industry Category Name","type":"string","description":"Industry Category Name"}},"required":["organization_id"],"title":"SimplePathOrganization","type":"object"},"SimplePathOrganizationList":{"properties":{"data":{"default":[],"items":{"items":{"$ref":"#/components/schemas/SimplePathOrganization"},"type":"array"},"title":"Data","type":"array"},"next":{"title":"Next","type":"string"},"total_count":{"title":"Total Count","type":"integer"}},"title":"SimplePathOrganizationList","type":"object"},"SimpleScore":{"properties":{"label":{"title":"Label","type":"string"},"level":{"$ref":"#/components/schemas/ScoreLevel"},"name":{"title":"Name","type":"string"},"score":{"title":"Score","type":"integer"}},"required":["name","label"],"title":"SimpleScore","type":"object"},"UnauthorizedError":{"properties":{"message":{"title":"Detail","type":"string"}},"title":"UnauthorizedError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"validApiKey":{"properties":{"statusCode":{"title":"statusCode","type":"integer"},"time":{"format":"Common Log","title":"time","type":"string"},"valid":{"title":"valid","type":"boolean"}},"required":["statusCode","time","valid"],"title":"validApiKey","type":"object"},"WatchlistOrganization":{"title":"WatchlistOrganization","required":["organization_id","priority_value","groups","scenario_links","data_element_values"],"type":"object","properties":{"organization_id":{"title":"Organization Id","type":"string","format":"uuid"},"organization_name":{"title":"Organization Name","type":"string"},"priority_value":{"title":"Priority Value","type":"integer"},"groups":{"title":"Groups","type":"array","items":{"$ref":"#/components/schemas/GroupWithOrgTiers"}},"scenario_links":{"title":"Scenario Links","type":"array","items":{"$ref":"#/components/schemas/ScenarioOrganizationLink"}},"data_element_values":{"title":"Data Element Values","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/CustomFieldDataElementValue"},{"$ref":"#/components/schemas/AttributeDataElementValue"},{"$ref":"#/components/schemas/RiskSubfactorScoreDataElementValue"},{"$ref":"#/components/schemas/RiskFactorScoreDataElementValue"}]},"description":"Values this organization has for the data elements used by watchlist columns."}}}},"securitySchemes":{"Interos API Key":{"in":"header","name":"x-api-key","type":"apiKey"},"Interos Customer ID":{"in":"header","name":"x-customer-id","type":"apiKey"}}},"info":{"title":"Interos API","version":"1.0.0","description":"This API uses location data provided by https://geocode.earth/","x-logo":"https://www.interos.ai/wp-content/uploads/2019/12/logo_blue-black-1.png"},"openapi":"3.0.2","paths":{"/health":{"get":{"description":"Validate a developer api-key","parameters":[{"description":"Developer API-Key","in":"header","name":"x-api-key","schema":{"default":"","description":"The developer api-key to be validated.","title":"x-api-key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/validApiKey"}}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden Response"}},"summary":"Validate that a developer api-key is still active","tags":["health"]}},"/v1/organizations/search_lite":{"get":{"description":"Search organizations by name, duns, cage code, ueid or interos id with optional country filter","operationId":"get_organizations_search_lite_v1_external_organizations_search_lite_get","parameters":[{"description":"Search term to match against organization names, duns, cage code, ueid or interos id","in":"query","name":"search_term","required":true,"schema":{"description":"Search term to match against organization names, duns, cage code, ueid or interos id","title":"Search Term","type":"string"}},{"description":"Optional ISO country code to filter results","in":"query","name":"country_code","required":false,"schema":{"description":"Optional ISO country code to filter results","nullable":true,"title":"Country Code","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrganizationSearchLiteResult"},"title":"Response Get Organizations Search Lite","type":"array"}}},"description":"Succeeded"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/interos/refs/heads/main/openapi/interos-openapi.json