openapi.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "Tradeverifyd",
    "description": "\nThe Tradeverifyd API offers advanced capabilities for analyzing supply chain entities and their intricate relationships, enabling users to gain deep insights into the complex dynamics of global trade networks.\n\nFor more information visit [tradeverifyd.com](https://tradeverifyd.com).\n\nIf you have questions regarding specific use cases or how to accomplish them, please reach out to [support@tradeverifyd.com](mailto:support@tradeverifyd.com?subject=Tradeverifyd%20use%20cases) for guidance.\n\nWhen making requests that require a Tradeverifyd API Key make sure the correct HTTP Header is included.\n\nFor example:\n\n```bash\ncurl --silent --location -G 'https://.../v1/search/entities' \\\n--data-urlencode 'name=Contoso Corporation' \\\n--data-urlencode 'jurisdiction=US' \\\n--header \"ocp-apim-subscription-key: $TRADEVERIFYD_API_KEY\"\n```\n",
    "termsOfService": "https://tradeverifyd.com/terms-of-service",
    "contact": {
      "name": "tradeverifyd.com",
      "url": "https://tradeverifyd.com/",
      "email": "support@tradeverifyd.com"
    },
    "license": {
      "name": "Proprietary License",
      "url": "https://tradeverifyd.com/terms-of-service"
    },
    "version": "0.2.0"
  },
  "servers": [
    {
      "url": "https://api.tradeverifyd.com",
      "description": "Production server"
    }
  ],
  "paths": {
    "/v1/search/entities": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Entity Search",
        "description": "Search for Entities that match the provided search parameters.",
        "operationId": "search_entities_search_entities_get",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Entity name.",
              "title": "Name"
            },
            "description": "Entity name."
          },
          {
            "name": "address",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Entity address.",
              "title": "Address",
              "type": "string",
              "nullable": true
            },
            "description": "Entity address."
          },
          {
            "name": "jurisdiction",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Two-letter ISO country code the entity should be associated with.",
              "title": "Jurisdiction",
              "type": "string",
              "minLength": 2,
              "maxLength": 2,
              "nullable": true
            },
            "description": "Two-letter ISO country code the entity should be associated with."
          },
          {
            "name": "size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "description": "The maximum number of results to return. Must be between 1 and 100, inclusive.",
              "default": 10,
              "title": "Size"
            },
            "description": "The maximum number of results to return. Must be between 1 and 100, inclusive."
          },
          {
            "name": "flagged_only",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "If 'true', results will be limited to Entities currently affected by 1 or more Flags.",
              "default": false,
              "title": "Flagged Only"
            },
            "description": "If 'true', results will be limited to Entities currently affected by 1 or more Flags."
          }
        ],
        "responses": {
          "200": {
            "description": "Entities matching search criteria",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EntitySearchResult"
                  },
                  "title": "Response Search Entities Search Entities Get"
                },
                "examples": {
                  "entity_name_search": {
                    "summary": "Search by entity name",
                    "description": "Find entities matching a specific company name",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439011",
                        "name": "Global Manufacturing Corp",
                        "aliases": [
                          "GMC"
                        ],
                        "jurisdiction": "US",
                        "addresses": [
                          "123 Industrial Blvd, Detroit, MI 48201, USA",
                          "456 Factory St, Cleveland, OH 44113, USA"
                        ],
                        "flagged": true,
                        "description": "Large-scale manufacturing company specializing in automotive components",
                        "primary_role": "manufacturer",
                        "url": "https://globalmanufacturingcorp.example",
                        "monitor": true,
                        "references": {
                          "flags": {
                            "total": 2
                          },
                          "relationships": {
                            "total": 15,
                            "from_relationships": {
                              "count": 8
                            },
                            "to_relationships": {
                              "count": 7
                            }
                          },
                          "risk_events": {
                            "total": 1
                          }
                        },
                        "external_ids": [
                          {
                            "id": "US-12345678-901",
                            "type": "duns",
                            "source": "dun_bradstreet"
                          },
                          {
                            "id": "98765432109876543210",
                            "type": "lei",
                            "source": "gleif"
                          }
                        ],
                        "modified_date": "2024-10-15T14:30:00Z"
                      },
                      {
                        "id": "507f1f77bcf86cd799439012",
                        "name": "Global Manufacturing Example Solutions",
                        "aliases": [
                          "GMES"
                        ],
                        "jurisdiction": "CA",
                        "addresses": [
                          "789 Commerce Way, Toronto, ON M5V 3B6, Canada"
                        ],
                        "flagged": false,
                        "description": "Manufacturing solutions provider",
                        "primary_role": "supplier",
                        "references": {
                          "flags": {
                            "total": 0
                          },
                          "relationships": {
                            "total": 3
                          },
                          "risk_events": {
                            "total": 0
                          }
                        },
                        "count_inferred_relationships": {
                          "depth": 3,
                          "value": 3,
                          "flagged_count": 0,
                          "last_updated": "2025-10-08T19:34:19.447000Z"
                        },
                        "modified_date": "2024-10-20T09:15:00Z",
                        "hs_codes": {
                          "incoming": [
                            "52",
                            "5214",
                            "521462"
                          ],
                          "outgoing": [
                            "81",
                            "8105",
                            "810507"
                          ]
                        }
                      }
                    ]
                  },
                  "flagged_entities_only": {
                    "summary": "Search flagged entities only",
                    "description": "Find only entities with active compliance flags",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439013",
                        "name": "Risky Suppliers Ltd",
                        "aliases": [
                          "Risky Ltd."
                        ],
                        "jurisdiction": "CN",
                        "addresses": [
                          "Room 1001, Building A, Shenzhen, Guangdong, China"
                        ],
                        "flagged": true,
                        "description": "Electronics components supplier with compliance concerns",
                        "primary_role": "supplier",
                        "monitor": true,
                        "references": {
                          "flags": {
                            "total": 3
                          },
                          "relationships": {
                            "total": 12
                          },
                          "risk_events": {
                            "total": 2
                          }
                        },
                        "modified_date": "2024-10-18T16:45:00Z"
                      }
                    ]
                  },
                  "jurisdiction_search": {
                    "summary": "Search by jurisdiction",
                    "description": "Find entities in a specific country (Germany)",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439014",
                        "name": "Great German Engineering Co.",
                        "aliases": [
                          "GEC"
                        ],
                        "jurisdiction": "DE",
                        "addresses": [
                          "Industriestra\u00dfe 42, 70565 Stuttgart, Germany"
                        ],
                        "flagged": false,
                        "description": "High-precision manufacturing and engineering services",
                        "primary_role": "manufacturer",
                        "url": "https://great-engineering-example.de",
                        "references": {
                          "flags": {
                            "total": 0
                          },
                          "relationships": {
                            "total": 8
                          },
                          "risk_events": {
                            "total": 0
                          }
                        },
                        "external_ids": [
                          {
                            "id": "HRB123456",
                            "type": "company_registration",
                            "source": "german_trade_register"
                          }
                        ],
                        "count_inferred_relationships": {
                          "depth": 3,
                          "value": 3,
                          "flagged_count": 1,
                          "last_updated": "2025-01-01T00:00:00Z"
                        },
                        "modified_date": "2024-10-10T11:20:00Z",
                        "hs_codes": {
                          "incoming": [],
                          "outgoing": [
                            "1050"
                          ]
                        }
                      }
                    ]
                  },
                  "empty_results": {
                    "summary": "No matching entities",
                    "description": "Search that returns no results",
                    "value": []
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid search parameters",
            "content": {
              "application/json": {
                "examples": {
                  "missing_search_criteria": {
                    "summary": "Missing required search criteria",
                    "value": {
                      "detail": "Either name or entity_id must be provided"
                    }
                  },
                  "invalid_jurisdiction": {
                    "summary": "Invalid jurisdiction code",
                    "value": {
                      "detail": "Jurisdiction must be a 2-letter ISO country code"
                    }
                  },
                  "invalid_size": {
                    "summary": "Invalid size parameter",
                    "value": {
                      "detail": "Size must be between 1 and 100"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/resolve/entity": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Entity Resolution",
        "description": "Resolve to the top-scoring Entity that matches the provided search parameters.",
        "operationId": "resolve_entity_resolve_entity_get",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Entity name.",
              "title": "Name"
            },
            "description": "Entity name."
          },
          {
            "name": "address",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Entity address.",
              "title": "Address",
              "type": "string",
              "nullable": true
            },
            "description": "Entity address."
          },
          {
            "name": "jurisdiction",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Two-letter ISO country code the entity should be associated with.",
              "title": "Jurisdiction",
              "type": "string",
              "minLength": 2,
              "maxLength": 2,
              "nullable": true
            },
            "description": "Two-letter ISO country code the entity should be associated with."
          },
          {
            "name": "flagged_only",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "If 'true', results will be limited to Entities currently affected by 1 or more Flags.",
              "default": false,
              "title": "Flagged Only"
            },
            "description": "If 'true', results will be limited to Entities currently affected by 1 or more Flags."
          }
        ],
        "responses": {
          "200": {
            "description": "Best matching entity resolved from search criteria",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EntitySearchResult"
                  },
                  "title": "Response Resolve Entity Resolve Entity Get"
                },
                "examples": {
                  "perfect_name_match": {
                    "summary": "Perfect entity name match",
                    "description": "Exact match found for entity name with high confidence",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439015",
                        "name": "Example Contoso Inc.",
                        "aliases": [
                          "CONTOSO",
                          "EX CONTOSO"
                        ],
                        "jurisdiction": "US",
                        "addresses": [
                          "123 Main Street, Anytown, State, 12345"
                        ],
                        "flagged": false,
                        "description": "Multinational technology company specializing in consumer electronics",
                        "primary_role": "manufacturer",
                        "url": "https://contoso.example",
                        "monitor": true,
                        "auto_research": true,
                        "references": {
                          "flags": {
                            "total": 0
                          },
                          "relationships": {
                            "total": 247,
                            "from_relationships": {
                              "count": 156
                            },
                            "to_relationships": {
                              "count": 91
                            }
                          },
                          "risk_events": {
                            "total": 0
                          }
                        },
                        "external_ids": [
                          {
                            "id": "32019387069",
                            "type": "duns",
                            "source": "dun_bradstreet"
                          },
                          {
                            "id": "HWUPKR0MPOU8FGXBT394",
                            "type": "lei",
                            "source": "gleif"
                          },
                          {
                            "id": "CONT",
                            "type": "ticker",
                            "source": "nasdaq"
                          }
                        ],
                        "count_inferred_relationships": {
                          "depth": 3,
                          "value": 3,
                          "flagged_count": 0,
                          "last_updated": "2025-10-08T19:34:19.447000Z"
                        },
                        "modified_date": "2024-10-22T08:30:00Z",
                        "hs_codes": {
                          "incoming": [],
                          "outgoing": [
                            "68",
                            "6802",
                            "680221"
                          ]
                        }
                      }
                    ]
                  },
                  "fuzzy_name_match": {
                    "summary": "Fuzzy entity name match",
                    "description": "Best match found despite slight name variations",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439016",
                        "name": "Contoso Inc.",
                        "aliases": [
                          "CONTOSO"
                        ],
                        "jurisdiction": "US",
                        "addresses": [
                          "123 Main Street, Anytown, State, 12345"
                        ],
                        "flagged": false,
                        "description": "Technology corporation developing software, services, and solutions",
                        "primary_role": "manufacturer",
                        "url": "https://contoso.example",
                        "monitor": true,
                        "references": {
                          "flags": {
                            "total": 0
                          },
                          "relationships": {
                            "total": 189
                          },
                          "risk_events": {
                            "total": 0
                          }
                        },
                        "external_ids": [
                          {
                            "id": "06-1232893",
                            "type": "ein",
                            "source": "irs"
                          },
                          {
                            "id": "CONT",
                            "type": "ticker",
                            "source": "nasdaq"
                          }
                        ],
                        "modified_date": "2024-10-21T14:15:00Z"
                      }
                    ]
                  },
                  "jurisdiction_resolved": {
                    "summary": "Resolution with jurisdiction filtering",
                    "description": "Best match within specific jurisdiction constraint",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439017",
                        "name": "ACME CORP",
                        "aliases": [
                          "ACME"
                        ],
                        "jurisdiction": "US",
                        "addresses": [
                          "789 1st Street, Anytown, State, 12345"
                        ],
                        "flagged": false,
                        "description": "Multinational automotive manufacturer",
                        "primary_role": "manufacturer",
                        "url": "https://acme.example",
                        "monitor": true,
                        "references": {
                          "flags": {
                            "total": 0
                          },
                          "relationships": {
                            "total": 412,
                            "from_relationships": {
                              "count": 298
                            },
                            "to_relationships": {
                              "count": 114
                            }
                          },
                          "risk_events": {
                            "total": 0
                          }
                        },
                        "external_ids": [
                          {
                            "id": "US-7200001008846",
                            "type": "corporate_number",
                            "source": "us_corporate_number"
                          },
                          {
                            "id": "AC",
                            "type": "ticker",
                            "source": "nyse"
                          }
                        ],
                        "modified_date": "2024-10-19T10:45:00Z"
                      }
                    ]
                  },
                  "flagged_entity_resolved": {
                    "summary": "Flagged entity resolution",
                    "description": "Best match for flagged entity with compliance issues",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439018",
                        "name": "Sanctioned Trading LLC",
                        "aliases": [
                          "Sanctioned Trading"
                        ],
                        "jurisdiction": "RU",
                        "addresses": [
                          "123 Red Square, Moscow, Russia"
                        ],
                        "flagged": true,
                        "description": "Trading company with active sanctions flags",
                        "primary_role": "trader",
                        "monitor": true,
                        "auto_research": false,
                        "references": {
                          "flags": {
                            "total": 5
                          },
                          "relationships": {
                            "total": 23
                          },
                          "risk_events": {
                            "total": 3
                          }
                        },
                        "external_ids": [
                          {
                            "id": "RU-1027700132195",
                            "type": "ogrn",
                            "source": "russian_business_register"
                          }
                        ],
                        "modified_date": "2024-10-23T12:00:00Z"
                      }
                    ]
                  },
                  "no_resolution": {
                    "summary": "No entity resolved",
                    "description": "No suitable match found for search criteria",
                    "value": []
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid resolution parameters.",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_jurisdiction": {
                    "summary": "Invalid jurisdiction code",
                    "description": "Provided jurisdiction has too many characters",
                    "value": {
                      "detail": [
                        {
                          "type": "string_too_long",
                          "loc": [
                            "query",
                            "jurisdiction"
                          ],
                          "msg": "String should have at most 2 characters",
                          "input": "USA",
                          "ctx": {
                            "max_length": 2
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/by-flag-type/{flag_type_id}": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entities by Flag Type",
        "description": "Get entities that have flags of a specific flag type. To view possible flag types, use\nthe Get Flags Types endpoint `/flags/types`.\n\nThis endpoint allows customers to query entities based on specific compliance flags.\nResults are filtered by organization, meaning only entities with flags that are either\npublic or belong to the user's organization will be returned.\n\nThe response includes a list of entities that have a flag of the specified type, including information\non entity details, Tradeverifyd scores, and flag information.\nBecause the response can be large, entities are returned across multiple pages of the response.\nThe response includes information on the maximum number of pages.\nUse the `limit` parameter to specify how many results should be returned in one page.\nUse the `page` parameter to select a page number.",
        "operationId": "get_entities_by_flag_type_entities_by_flag_type__flag_type_id__get",
        "parameters": [
          {
            "name": "flag_type_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "ObjectId of the flag type to filter entities by",
              "title": "Flag Type Id"
            },
            "description": "ObjectId of the flag type to filter entities by"
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Page number for pagination",
              "default": 1,
              "title": "Page"
            },
            "description": "Page number for pagination"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of entities per page",
              "default": 50,
              "title": "Limit"
            },
            "description": "Number of entities per page"
          }
        ],
        "responses": {
          "200": {
            "description": "Entities with the specified flag type",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true,
                  "title": "Response Get Entities By Flag Type Entities By Flag Type  Flag Type Id  Get"
                },
                "examples": {
                  "ndaa_1260h_entities": {
                    "summary": "NDAA 1260H flagged entities",
                    "description": "Entities flagged under Section 1260H of the National Defense Authorization Act",
                    "value": {
                      "entities": [
                        {
                          "id": "67ca2eb28f1f60aa37278f33",
                          "name": "EXAMPLE CONTOSO INC.",
                          "jurisdiction": "US",
                          "type": "Company",
                          "status": "Active",
                          "addresses": [
                            "123 Main Street, Anytown, State, 12345"
                          ],
                          "flags": [
                            {
                              "id": "6808e96feb30f71f4da957c8",
                              "created_at": "2025-03-15T00:11:31.376Z",
                              "type": "67db2af315fadaf237af6a0e",
                              "flag_type": "Sanctions & Restricted Entities Risk",
                              "flag_subtype": "1260H Entities",
                              "flag_polarity": -1,
                              "description": "A flag that describes an staged_flag on the OpenSanctions default list.",
                              "sources": [
                                {
                                  "url": "https://www.defense.gov/News/Releases/Release/Article/4023145/"
                                }
                              ]
                            }
                          ],
                          "aliases": [
                            "CONTOSO",
                            "EX CONTOSO"
                          ]
                        }
                      ],
                      "pagination": {
                        "page": 1,
                        "limit": 50,
                        "total_entities": 127,
                        "total_pages": 3,
                        "has_next": true,
                        "has_previous": false
                      },
                      "filter_summary": {
                        "flag_type_id": "67db2af315fadaf237af6a0e",
                        "flag_type": "Sanctions & Restricted Entities Risk",
                        "flag_subtype": "1260H Entities",
                        "flag_polarity": -1
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid parameters",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_object_id": {
                    "summary": "Invalid flag type ID format",
                    "value": {
                      "detail": "flag_type_id must be a valid ObjectId"
                    }
                  },
                  "invalid_pagination": {
                    "summary": "Invalid pagination parameters",
                    "value": {
                      "detail": "page must be >= 1, limit must be >= 1 and <= 500"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Flag type not found",
            "content": {
              "application/json": {
                "examples": {
                  "flag_type_not_found": {
                    "summary": "Flag type does not exist",
                    "value": {
                      "detail": "Flag type not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/{entity_id}": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entity",
        "description": "Retrieve a single Entity by its Id",
        "operationId": "get_entity_entities__entity_id__get",
        "parameters": [
          {
            "name": "entity_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Entity Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful entity match.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetEntityResponse"
                },
                "examples": {
                  "entity_id_search": {
                    "summary": "Search by entity_id",
                    "description": "Find a single entity by entity_id.",
                    "value": {
                      "id": "507f1f77bcf86cd799439015",
                      "name": "Example Contoso Inc.",
                      "description": "Large-scale manufacturing company specializing in automotive components",
                      "primary_role": "manufacturer",
                      "aliases": [
                        "Contoso",
                        "EX CONTOSO"
                      ],
                      "url": "https://globalmanufacturingcorp.example",
                      "jurisdiction": "US",
                      "addresses": [
                        "123 Main Street, Anytown, State, 12345"
                      ],
                      "monitor": false,
                      "created_at": "1970-01-01T00:00:00.000Z",
                      "modified": "1970-01-01T00:00:00.000Z",
                      "region": "State",
                      "affiliated_jurisdiction": "CA",
                      "tradeverifyd_score": 550,
                      "references": {
                        "flags": {
                          "total": 2
                        },
                        "relationships": {
                          "total": 15,
                          "from_relationships": {
                            "count": 8
                          },
                          "to_relationships": {
                            "count": 7
                          }
                        },
                        "risk_events": {
                          "total": 1
                        }
                      },
                      "count_inferred_relationships": {
                        "depth": 2,
                        "value": 2,
                        "last_updated": "1970-01-01T00:00:00.000Z"
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/{entity_id}/risk_events": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entity Risk Events",
        "description": "Get Risk Events affecting an Entity.",
        "operationId": "get_entity_risk_events_entities__entity_id__risk_events_get",
        "parameters": [
          {
            "name": "entity_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Entity Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RiskEvent"
                  },
                  "title": "Response Get Entity Risk Events Entities  Entity Id  Risk Events Get"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/{entity_id}/verification": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entity Verification by entity id",
        "description": "Retrieves the Tradeverifyd Supplier Assessment (TSA) details for a given entity. Returns the current\nsupplier assessment and compliance information recorded for the specified entity.\n\nNote: To generate a Tradeverifyd Advanced Supplier Assessment (TASA), use the POST /reports endpoint.",
        "operationId": "get_entity_verification_details_entities__entity_id__verification_get",
        "parameters": [
          {
            "name": "entity_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Id of the Entity to use as the starting node for graph retrieval.",
              "title": "Entity Id"
            },
            "description": "Id of the Entity to use as the starting node for graph retrieval."
          },
          {
            "name": "hs_code",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Optional HS code (2, 4, or 6-digit) to filter the supplier graph used for assessment. When provided, only supplier relationships (IS_SUPPLIER_OF edges) that match the HS code are considered when analyzing the entity's supply chain. This filters the graph to show suppliers of specific products. Less specific codes (e.g., '52') match more specific codes (e.g., '5201', '520100'). Note: Supplier jurisdiction filtering will be added in future updates.",
              "title": "Hs Code",
              "type": "string",
              "nullable": true
            },
            "description": "Optional HS code (2, 4, or 6-digit) to filter the supplier graph used for assessment. When provided, only supplier relationships (IS_SUPPLIER_OF edges) that match the HS code are considered when analyzing the entity's supply chain. This filters the graph to show suppliers of specific products. Less specific codes (e.g., '52') match more specific codes (e.g., '5201', '520100'). Note: Supplier jurisdiction filtering will be added in future updates."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful entity verification retrieval.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EntityVerificationDetails"
                },
                "examples": {
                  "verification_id_search": {
                    "summary": "Get entity verification details by entity_id.",
                    "description": "Find an entity's verification details by entity_id.",
                    "value": {
                      "id": "507f1f77bcf86cd799439015",
                      "name": "Example Contoso Inc.",
                      "jurisdiction": "US",
                      "addresses": [
                        "123 Main Street, Anytown, State, 12345"
                      ],
                      "text_summary": "One company in this supply chain has been flagged for compliance issues.",
                      "problematic_entities": [
                        {
                          "id": "507f1f77bcf86cd799439017",
                          "name": "ACME CORP.",
                          "flags": [
                            {
                              "sources": [
                                "https://www.dhs.gov/uflpa-entity-list"
                              ],
                              "type": "Human Rights Violation Risk",
                              "subtype": "Forced Labor Risk",
                              "flag_polarity": -1
                            }
                          ],
                          "addresses": [
                            {
                              "address": "789 1st Street, Anytown, State, 12345",
                              "problematic": true,
                              "problem_region": "AK"
                            }
                          ],
                          "jurisdiction": "US",
                          "depth": 3,
                          "tvpra_risks": [
                            {
                              "risk_type": "forced_labor",
                              "suspect_hs_codes": [
                                "52"
                              ]
                            }
                          ],
                          "has_excessive_addresses": false
                        }
                      ],
                      "tradeverifyd_score": 550,
                      "total_entity_ct": 1,
                      "identifiers": [
                        {
                          "type": "lei",
                          "source": "https://lei-lookup.com/record/example",
                          "id": "1b070d5e-eb8d-41e6-9055-a26f8f638571"
                        }
                      ],
                      "incoming_products": [
                        "52",
                        "61"
                      ],
                      "outgoing_products": [
                        "74"
                      ],
                      "top_supplier_connections": [
                        {
                          "id": "507f1f77bcf86cd799439018",
                          "name": "SANCTIONED TRADING LLC",
                          "jurisdiction": "RU"
                        }
                      ],
                      "top_customer_connections": [
                        {
                          "id": "507f1f77bcf86cd799439013",
                          "name": "RISKY SUPPLIERS LTD",
                          "jurisdiction": "CN"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/{identifier_type}/{identifier_value}/verification": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entity Verification by identifier",
        "description": "Retrieves a Tradeverifyd Supplier Assesssment (TSA) for an entity from alternative identifiers.\nThe purpose of this endpoint is to use external IDs (such as manufacturing or bank identifiers) to\nretrieve entity verification details in the form of a TSA.\n\nFor example:\n- Retrieving by LEI id: `GET /v1/entities/lei/559312VRR0Z0AXO77J92/verification`\n- Retrieving by BIC id: `GET /v1/entities/bic/XCDVTLBIXXX/verification`",
        "operationId": "get_entity_verification_details_by_identifier_entities__identifier_type___identifier_value__verification_get",
        "parameters": [
          {
            "name": "identifier_type",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The type of the identifier (e.g., lei, mid)",
              "title": "Identifier Type"
            },
            "description": "The type of the identifier (e.g., lei, mid)"
          },
          {
            "name": "identifier_value",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The value of the identifier",
              "title": "Identifier Value"
            },
            "description": "The value of the identifier"
          },
          {
            "name": "hs_code",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Optional HS code to filter the graph considered when calculating verification details for the requested Entity.",
              "title": "Hs Code",
              "type": "string",
              "nullable": true
            },
            "description": "Optional HS code to filter the graph considered when calculating verification details for the requested Entity."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful entity verification retrieval.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EntityVerificationDetails"
                },
                "examples": {
                  "verification_id_search": {
                    "summary": "Get entity verification details by identifier type and value.",
                    "description": "Find an entity's verification details by identifier type and value.",
                    "value": {
                      "id": "607f1f77bcf86cd799439016",
                      "name": "Example Construction Ltd.",
                      "jurisdiction": "US",
                      "addresses": [
                        "101 Main Street, New York City, New York, 10001"
                      ],
                      "text_summary": "One company in this supply chain has been flagged for issues related to labor.",
                      "problematic_entities": [
                        {
                          "id": "507f1f77bcf86cd799439017",
                          "name": "ACME CORP.",
                          "flags": [
                            {
                              "sources": [
                                "https://www.dhs.gov/uflpa-entity-list"
                              ],
                              "type": "Worker & Consumer Safety Risk",
                              "subtype": "Transportation Safety Violations",
                              "flag_polarity": -1
                            }
                          ],
                          "addresses": [
                            {
                              "address": "789 1st Street, Anytown, State, 12345",
                              "problematic": true,
                              "problem_region": "AK"
                            }
                          ],
                          "jurisdiction": "US",
                          "depth": 3,
                          "tvpra_risks": [
                            {
                              "risk_type": "forced_labor",
                              "suspect_hs_codes": [
                                "52"
                              ]
                            }
                          ],
                          "has_excessive_addresses": false
                        }
                      ],
                      "tradeverifyd_score": 550,
                      "total_entity_ct": 1,
                      "identifiers": [
                        {
                          "type": "lei",
                          "source": "https://lei-lookup.com/record/example",
                          "id": "1b070d5e-eb8d-41e6-9055-a26f8f638571"
                        }
                      ],
                      "incoming_products": [
                        "52",
                        "61"
                      ],
                      "outgoing_products": [
                        "74"
                      ],
                      "top_supplier_connections": [
                        {
                          "id": "507f1f77bcf86cd799439018",
                          "name": "SANCTIONED TRADING LLC",
                          "jurisdiction": "RU"
                        }
                      ],
                      "top_customer_connections": [
                        {
                          "id": "507f1f77bcf86cd799439013",
                          "name": "RISKY SUPPLIERS LTD",
                          "jurisdiction": "CN"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/{entity_id}/graph": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entity Graph",
        "description": "Retrieve a graph of paginated relationships for a single Entity.\n\nThis endpoint provides information about the relationships of an Entity,\nsuch as partnerships, affiliations, or any other defined connections. The\nreturned graph contains entity relationship data and includes\nentity properties.\n\nIn the returned relationships data, relationships are described as having\na `source`, an `target`, and a `type`. The direction of the relationship\nmoves from source to target, and is described by the type.\n\nThe page and page_size parameters determine the number of relationships\nto return per page.\n\nThe total_records and total_pages fields are only returned if depth is 3 or less.\nIf depth is greater than 3, these fields are omitted.\n\nNote: This endpoint includes Flags but NOT Risk Events data. Use the\n/risk_events endpoint to retrieve that information for specific entities.",
        "operationId": "get_entity_graph_entities__entity_id__graph_get",
        "parameters": [
          {
            "name": "entity_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Id of the Entity to use as the starting or root entity for graph retrieval.",
              "title": "Entity Id"
            },
            "description": "Id of the Entity to use as the starting or root entity for graph retrieval."
          },
          {
            "name": "hs_codes",
            "in": "query",
            "required": false,
            "schema": {
              "description": "A comma separated list of 2, 4, or 6-digit HS codes to filter by. A less-specific HS code will always match a more-specific code with the same chapter or heading. For example, code '12' will match '1234' and '1256'. If list is empty or null, all relationships are returned.",
              "title": "Hs Codes",
              "type": "string",
              "nullable": true
            },
            "description": "A comma separated list of 2, 4, or 6-digit HS codes to filter by. A less-specific HS code will always match a more-specific code with the same chapter or heading. For example, code '12' will match '1234' and '1256'. If list is empty or null, all relationships are returned."
          },
          {
            "name": "depth",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Limits how many levels of related relationships the query will explore. For example, a depth of 1 returns only directly related items, while higher values include more distant connections.",
              "default": 3,
              "title": "Depth",
              "type": "integer",
              "nullable": true
            },
            "description": "Limits how many levels of related relationships the query will explore. For example, a depth of 1 returns only directly related items, while higher values include more distant connections."
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Page to retrieve",
              "default": 1,
              "title": "Page",
              "type": "integer",
              "nullable": true
            },
            "description": "Page to retrieve"
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Number of relationships to return per page (max 100)",
              "default": 100,
              "title": "Page Size",
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "nullable": true
            },
            "description": "Number of relationships to return per page (max 100)"
          },
          {
            "name": "include_affiliates",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Set True to preserve affiliate relationships when filtering by HS codes. When True, affiliate relationships will be included in the graph even if they don't match the specified HS codes.",
              "default": false,
              "title": "Include Affiliates",
              "type": "boolean",
              "nullable": true
            },
            "description": "Set True to preserve affiliate relationships when filtering by HS codes. When True, affiliate relationships will be included in the graph even if they don't match the specified HS codes."
          },
          {
            "name": "direction",
            "in": "query",
            "required": false,
            "schema": {
              "enum": [
                "in",
                "out"
              ],
              "type": "string",
              "description": "The graph direction from the root entity.  Values are 'in' and 'out'. A typical relationship such as IS_SUPPLIER_OF is an inbound relationship pointing to the root entity. The default value is 'in', resulting in a graph of inbound relationships.",
              "default": "in",
              "title": "Direction"
            },
            "description": "The graph direction from the root entity.  Values are 'in' and 'out'. A typical relationship such as IS_SUPPLIER_OF is an inbound relationship pointing to the root entity. The default value is 'in', resulting in a graph of inbound relationships."
          }
        ],
        "responses": {
          "200": {
            "description": "Graph of entities related to the entrypoint",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicAbridgedGraph"
                },
                "examples": {
                  "returned_graph": {
                    "summary": "Returned graph",
                    "description": "Successfully returned graph",
                    "value": {
                      "entrypoint": {
                        "id": "64ac25c572c173ba6f32e840",
                        "name": "COMPANY A",
                        "jurisdiction": "DE",
                        "flags": [],
                        "coordinates": [],
                        "addresses": [],
                        "aliases": [],
                        "ids": []
                      },
                      "entities": [
                        {
                          "id": "64ac25c572c173ba6f32e840",
                          "name": "COMPANY A",
                          "jurisdiction": "DE",
                          "flags": [
                            {
                              "id": "67ffefdc070a88cf06635ee9",
                              "entity_id": "64ac25c572c173ba6f32e840",
                              "entity_jurisdiction": "DE",
                              "type": "Compliant",
                              "subtype": "Forced Labor Risk",
                              "flag_polarity": 1,
                              "modified": "2023-05-23T20:31:42Z",
                              "source": [
                                "https://modernslaveryregister.gov.au/statements/"
                              ],
                              "tags": [
                                "COMPLIANT - Australia Modern Slavery Act 2018"
                              ]
                            }
                          ],
                          "coordinates": [],
                          "addresses": [
                            "123 abc street chicago illinois 12345"
                          ],
                          "aliases": [
                            "Company A. Inc.",
                            "Company A.",
                            "Company A. LLC"
                          ],
                          "ids": [
                            {
                              "id": "AAAAAAAAAAAAAAAAAAAA",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080132",
                              "type": "lei",
                              "source": "https://www.gleif.org/en"
                            },
                            {
                              "id": "COAAAMUXXX",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080144",
                              "type": "bic",
                              "source": "https://www.gleif.org/en"
                            }
                          ]
                        },
                        {
                          "id": "64ac25c772c173ba6f3c9c57",
                          "name": "Company B",
                          "jurisdiction": "DE",
                          "flags": [],
                          "coordinates": [],
                          "addresses": [],
                          "aliases": [
                            "Company B. Inc."
                          ],
                          "ids": [
                            {
                              "id": "12345_ABCDEFGH",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080169",
                              "type": "opencorporates",
                              "source": "https://www.handelsregister.de/"
                            },
                            {
                              "id": "12345_ABCDEFGH",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080180",
                              "type": "opencorporates_native_company_number",
                              "source": "https://www.handelsregister.de/"
                            },
                            {
                              "id": "BBBBBBBBBBBBBBBBBBBB",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080192",
                              "type": "lei",
                              "source": "opencorporates_additional_identifiers"
                            }
                          ]
                        },
                        {
                          "id": "64ac25c772c173ba6f3d0aa1",
                          "name": "Company C",
                          "jurisdiction": "JP",
                          "flags": [],
                          "coordinates": [],
                          "addresses": [],
                          "aliases": [
                            "Company C. Inc."
                          ],
                          "ids": [
                            {
                              "id": "CCCCCCCCCCCCCCCCCCCC",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080207",
                              "type": "lei",
                              "source": "https://www.gleif.org/en"
                            },
                            {
                              "id": "CCCCCCCCCCCCCCCCCCCC",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080218",
                              "type": "mid",
                              "source": "Customs Directive 1234-567"
                            }
                          ]
                        },
                        {
                          "id": "64ac25c772c173ba6f3e637f",
                          "name": "Company D",
                          "jurisdiction": "JP",
                          "flags": [],
                          "coordinates": [],
                          "addresses": [],
                          "ids": [
                            {
                              "id": "DDDDDDDDDDDDDDDDDDDD",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080233",
                              "type": "lei",
                              "source": "https://www.gleif.org/en"
                            }
                          ]
                        },
                        {
                          "id": "64ac25c872c173ba6f407757",
                          "name": "Company E",
                          "jurisdiction": "US",
                          "flags": [],
                          "coordinates": [
                            {
                              "lat": 100.0,
                              "lng": 112.0,
                              "type": "headquarters"
                            },
                            {
                              "lat": 12.0,
                              "lng": 24.0,
                              "type": "legal"
                            }
                          ],
                          "addresses": [
                            "456 abc street",
                            "123 abc street"
                          ],
                          "aliases": [
                            "Company E. Inc."
                          ],
                          "ids": [
                            {
                              "id": "EEEEEEEEEEEEEEEEEEEE",
                              "active": true,
                              "created": "2025-09-24T12:29:26.080247",
                              "type": "lei",
                              "source": "https://www.gleif.org/en"
                            }
                          ]
                        }
                      ],
                      "relationships": [
                        {
                          "id": "64ac2a7172c173ba6f57dad2",
                          "type": "DIRECTLY_CONSOLIDATES",
                          "target": "64ac25c572c173ba6f3316cf",
                          "source": "64ac25c672c173ba6f36283d",
                          "modified": "2024-04-25T17:55:44.263000Z",
                          "sources": [
                            "https://search.gleif.org/#/record/AAAAAAAAAAAAAAAAAAAA/",
                            "https://search.gleif.org/#/record/BBBBBBBBBBBBBBBBBBBB/"
                          ]
                        },
                        {
                          "id": "64ac2a7272c173ba6f5d4ed0",
                          "type": "DIRECTLY_CONSOLIDATES",
                          "target": "64ac25d472c173ba6f530da1",
                          "source": "64ac25d472c173ba6f541022",
                          "modified": "2024-04-25T17:55:45.505000Z",
                          "sources": [
                            "https://search.gleif.org/#/record/CCCCCCCCCCCCCCCCCCCC/",
                            "https://search.gleif.org/#/record/DDDDDDDDDDDDDDDDDDDD/"
                          ]
                        },
                        {
                          "id": "64ac87dd1102a154bf0cbbc8",
                          "type": "IS_SUPPLIER_OF",
                          "target": "645a550a992fba23b295e4ea",
                          "source": "645a550a992fba23b295e4e9",
                          "hs_codes": [
                            "8541"
                          ],
                          "modified": "2025-02-20T16:10:51.079000Z",
                          "sources": [
                            "https://www.shu.ac.uk/helena-kennedy-centre-international-justice/research-and-projects/all-projects/in-broad-daylight"
                          ]
                        }
                      ],
                      "page": 1,
                      "page_size": 1000,
                      "records": 134,
                      "total_records": 134,
                      "total_pages": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid depth",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_depth": {
                    "summary": "Invalid depth parameter.",
                    "value": {
                      "detail": "Depth must be between 1 and 10."
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Content - invalid parameters",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_direction": {
                    "summary": "Provided direction must be 'in' or 'out'.",
                    "value": {
                      "detail": [
                        {
                          "type": "literal_error",
                          "loc": [
                            "query",
                            "direction"
                          ],
                          "msg": "Input should be 'in' or 'out'",
                          "input": "between",
                          "ctx": {
                            "expected": "'in' or 'out'"
                          }
                        }
                      ]
                    }
                  },
                  "invalid_depth_type": {
                    "summary": "Provided depth must be an integer.",
                    "value": {
                      "detail": [
                        {
                          "type": "int_parsing",
                          "loc": [
                            "query",
                            "depth"
                          ],
                          "msg": "Input should be a valid integer, unable to parse string as an integer",
                          "input": "three"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/entities/{entity_id}/graph/flagged_relationships": {
      "get": {
        "tags": [
          "Entity"
        ],
        "summary": "Get Entity Graph Flagged Relationships",
        "description": "Get flagged relationships for an entity with full entity, relationship, and flag details.\n\nThis endpoint returns the shortest paths between the specified entity and all\nupstream flagged entities that pass through the provided HS codes. The response\nincludes complete details for all entities, relationships, and flags referenced\nin the paths.\n\nArgs:\n- entity_id: The ID of the entity to use as the starting point for relationship search\n- hs_codes: List of HS codes that paths must pass through to be considered\n- include_flags: Optional list of flag types to filter by (if not provided, all flag types are considered)\n- include_affiliates: When True, paths connected by affiliate relationships are included\n- paging: Pagination parameters\n\nReturns:\n- FlaggedRelationshipsResponse: Contains entities, relationships, and flags with all\nObjectIds serialized as strings with all ObjectIds serialized as strings",
        "operationId": "get_entity_graph_flagged_relationships_entities__entity_id__graph_flagged_relationships_get",
        "parameters": [
          {
            "name": "entity_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Entity Id"
            }
          },
          {
            "name": "hs_codes",
            "in": "query",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "title": "Hs Codes"
            }
          },
          {
            "name": "include_flags",
            "in": "query",
            "required": false,
            "schema": {
              "title": "Include Flags",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "include_affiliates",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Set True to preserve affiliate relationships when filtering by HS codes. When True, affiliate relationships will be included in the graph even if they don't match the specified HS codes.",
              "default": false,
              "title": "Include Affiliates",
              "type": "boolean",
              "nullable": true
            },
            "description": "Set True to preserve affiliate relationships when filtering by HS codes. When True, affiliate relationships will be included in the graph even if they don't match the specified HS codes."
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "default": 1,
              "title": "Page",
              "type": "integer",
              "nullable": true
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "default": 25,
              "title": "Page Size",
              "type": "integer",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlaggedRelationshipsResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/relationship-types": {
      "get": {
        "tags": [
          "Relationships"
        ],
        "summary": "Get Relationship Types Detailed",
        "description": "Get all available relationship types with enhanced metadata.\n\nThis endpoint provides a comprehensive list of all relationship types used in the system\nwith additional metadata including category, display name, and bidirectional flag.\n\n**Categories:**\nRelationship types are organized into two categories:\n- `affiliate`: Affiliate connections including ownership, control, and partnership relationships\n- `trade`: Trade relationships including supply chain, financial, corporate, and other business connections\n\nUse this endpoint to understand the meaning and categorization of relationship types\nthat appear in other API responses such as entity graphs and relationship queries.",
        "operationId": "get_relationship_types_detailed_relationship_types_get",
        "responses": {
          "200": {
            "description": "List of all available relationship types with enhanced metadata",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/RelationshipTypeDetailResponse"
                  },
                  "type": "array",
                  "title": "Response Get Relationship Types Detailed Relationship Types Get"
                },
                "examples": {
                  "relationship_types": {
                    "summary": "Example Relationship Types",
                    "value": [
                      {
                        "type": "IS_SUPPLIER_OF",
                        "display_name": "Is Supplier Of",
                        "category": "trade",
                        "description": "An entity provides goods or services to another entity, usually in a commercial context.",
                        "bidirectional": false
                      },
                      {
                        "type": "IS_AFFILIATE_OF",
                        "display_name": "Is Affiliate Of",
                        "category": "affiliate",
                        "description": "An entity is associated with another, usually through ownership or control.",
                        "bidirectional": false
                      }
                    ]
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/relationship-type-categories": {
      "get": {
        "tags": [
          "Relationships"
        ],
        "summary": "Get Relationship Type Categories",
        "description": "Get all relationship type categories with their associated types.\n\nThis endpoint provides a categorized view of all relationship types,\ngrouping them by their business purpose (e.g., ownership, supply chain, financial).\n\nUse this to understand the different categories of relationships and which\nspecific relationship types belong to each category.",
        "operationId": "get_relationship_type_categories_relationship_type_categories_get",
        "responses": {
          "200": {
            "description": "List of all relationship type categories with their associated types",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RelationshipTypeCategoriesResponse"
                },
                "examples": {
                  "categories": {
                    "summary": "Example Categories",
                    "value": {
                      "categories": [
                        {
                          "name": "ownership",
                          "display_name": "Ownership Relationships",
                          "description": "Relationships indicating ownership or control between entities",
                          "relationship_count": 4,
                          "types": [
                            "IS_MAJORITY_SHAREHOLDER_OF",
                            "IS_SUBISIDIARY_OF",
                            "IS_THE_HOLDING_COMPANY_OF",
                            "IS_THE_PARENT_COMPANY_OF"
                          ]
                        },
                        {
                          "name": "supply_chain",
                          "display_name": "Supply Chain Relationships",
                          "description": "Relationships in the supply chain including suppliers, manufacturers, and shipping",
                          "relationship_count": 6,
                          "types": [
                            "IS_SUPPLIER_OF",
                            "IS_LIKELY_SUPPLIER_OF",
                            "IS_MANUFACTURER_OF",
                            "IS_A_VENDOR_OF",
                            "SHIPS_GOODS_TO",
                            "SHIPS_VIA"
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/relationships/types": {
      "get": {
        "tags": [
          "Relationships"
        ],
        "summary": "Get Relationship Types",
        "description": "Get all available relationship types with their descriptions.\n\nThis endpoint provides a comprehensive list of all relationship types used in the system\n(e.g., \"IS_SUPPLIER_OF\", \"IS_OTHERWISE_LINKED_TO\", \"DIRECTLY_CONSOLIDATES\") along with\ndetailed descriptions of what each type means.\n\nUse this endpoint to understand the meaning of relationship types that appear in other\nAPI responses such as entity graphs and relationship queries.",
        "operationId": "get_relationship_types_relationships_types_get",
        "responses": {
          "200": {
            "description": "List of all available relationship types with their descriptions",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/RelationshipTypeResponse"
                  },
                  "type": "array",
                  "title": "Response Get Relationship Types Relationships Types Get"
                },
                "examples": {
                  "relationship_types": {
                    "summary": "Example Relationship Types",
                    "value": [
                      {
                        "relationship_type": "IS_SUPPLIER_OF",
                        "description": "An entity provides goods or services to another entity, usually in a commercial context."
                      },
                      {
                        "relationship_type": "IS_OTHERWISE_LINKED_TO",
                        "description": "One entity has been manually identified as relating to another, or there is a business reason to display two entities as connected when they otherwise would not be. Relations of this type must have a batch ID so they can easily be removed. The meaning of this relationship is poorly-defined and should be used sparingly as a last resort."
                      },
                      {
                        "relationship_type": "DIRECTLY_CONSOLIDATES",
                        "description": "The parent entity fully consolidates the accounts of the child entity, as per the accounting standard(s) specified; the child entity is the closest entity being fully consolidated by the parent in any applicable hierarchical ownership structure."
                      }
                    ]
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/risk_events/{event_id}": {
      "get": {
        "tags": [
          "Risk Events"
        ],
        "summary": "Get Event",
        "description": "Retrieve a specific risk event by its ID.\n\nThis endpoint provides detailed information about a particular event in the\ncontext of supply chain operations. It is useful for fetching specific\ndetails about compliance, trade disruptions, or other significant events.",
        "operationId": "get_event_risk_events__event_id__get",
        "parameters": [
          {
            "name": "event_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Unique Risk Event identifier.",
              "title": "Event Id"
            },
            "description": "Unique Risk Event identifier."
          }
        ],
        "responses": {
          "200": {
            "description": "Risk event details retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RiskEvent"
                },
                "examples": {
                  "port_congestion": {
                    "summary": "Port congestion disruption event",
                    "description": "Example of a transportation disruption risk event affecting major ports",
                    "value": {
                      "id": "65f8a2b1c3d4e5f6a7b8c9d0",
                      "timestamp": "2024-03-15T08:30:00Z",
                      "last_modified": "2024-03-15T10:45:00Z",
                      "countries": [
                        "US",
                        "CN"
                      ],
                      "time_start": "2024-03-14T00:00:00Z",
                      "time_end": "2024-03-20T23:59:59Z",
                      "title": "Major Port Congestion at Los Angeles/Long Beach",
                      "description": "Severe congestion at the Los Angeles and Long Beach ports due to increased import volumes and labor shortages, causing significant delays in cargo processing and ship berthing.",
                      "sources": [
                        "https://www.reuters.example/business/port-congestion-2024",
                        "https://www.bloomberg.example/news/la-port-delays"
                      ],
                      "type": "port_congestion"
                    }
                  },
                  "semiconductor_shortage": {
                    "summary": "Global semiconductor shortage",
                    "description": "Example of a supply shortage risk event affecting technology supply chains",
                    "value": {
                      "id": "65f8a2b1c3d4e5f6a7b8c9d1",
                      "timestamp": "2024-02-28T14:20:00Z",
                      "last_modified": "2024-03-01T09:15:00Z",
                      "countries": [
                        "TW",
                        "KR",
                        "JP"
                      ],
                      "time_start": "2024-02-15T00:00:00Z",
                      "title": "Global Semiconductor Shortage Intensifies",
                      "description": "Ongoing semiconductor chip shortage affecting automotive and electronics industries, with Taiwan and South Korea production facilities operating at maximum capacity.",
                      "sources": [
                        "https://www.ft.example/semiconductor-shortage-2024"
                      ],
                      "type": "semiconductor_shortage"
                    }
                  },
                  "hurricane_disruption": {
                    "summary": "Hurricane supply chain impact",
                    "description": "Natural disaster affecting regional supply chains and logistics",
                    "value": {
                      "id": "65f8a2b1c3d4e5f6a7b8c9d2",
                      "timestamp": "2024-09-10T16:00:00Z",
                      "last_modified": "2024-09-12T08:30:00Z",
                      "countries": [
                        "US",
                        "MX"
                      ],
                      "time_start": "2024-09-08T00:00:00Z",
                      "time_end": "2024-09-15T23:59:59Z",
                      "title": "Hurricane Impacts Gulf Coast Supply Chains",
                      "description": "Category 4 hurricane disrupts oil refineries, chemical plants, and shipping routes along the Gulf Coast, affecting energy and petrochemical supply chains.",
                      "sources": [
                        "https://www.noaa.gov/hurricane-tracker-2024",
                        "https://www.wsj.example/gulf-coast-supply-disruption"
                      ],
                      "type": "hurricane"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Risk event not found",
            "content": {
              "application/json": {
                "examples": {
                  "not_found": {
                    "summary": "Risk event does not exist",
                    "value": {
                      "detail": "Risk Event '65f8a2b1c3d4e5f6a7b8c9d9' does not exist."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/risk_events": {
      "get": {
        "tags": [
          "Risk Events"
        ],
        "summary": "Get Risk Events",
        "description": "Retrieve a paginated feed of Risk Events matching the specifed filters,\nsorted by event creation time.",
        "operationId": "get_risk_events_risk_events_get",
        "parameters": [
          {
            "name": "event_types",
            "in": "query",
            "required": false,
            "schema": {
              "description": "If set, only Risk Events of the provided types will be included in the result set. If 'null', all types will be included in the result set.",
              "title": "Event Types",
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "enum": [
                      "earthquake",
                      "hurricane",
                      "tsunami",
                      "flood",
                      "tornado",
                      "cyclone",
                      "volcanic_eruption",
                      "wildfire",
                      "drought",
                      "landslide",
                      "blizzard",
                      "ice_storm",
                      "heatwave",
                      "sandstorm",
                      "pandemic",
                      "insect_infestation"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "economic_sanction",
                      "trade_war",
                      "political_unrest",
                      "embargo",
                      "military_conflict",
                      "terrorist_attack"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "shipping_delay",
                      "port_congestion",
                      "transportation_strike",
                      "fuel_shortage",
                      "infrastructure_failure"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "raw_material_scarcity",
                      "component_shortage",
                      "semiconductor_shortage",
                      "crop_disease"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "strike",
                      "labor_shortage",
                      "skilled_labor_shortage",
                      "workforce_demographic_problem",
                      "forced_labor",
                      "child_labor"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "inflation",
                      "recession",
                      "economic_downturn",
                      "currency_fluctuation",
                      "interest_rate_change",
                      "stock_market_volatility"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "environmental_regulation",
                      "trade_regulation",
                      "labor_law",
                      "safety_regulation",
                      "compliance_standard"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "cyber_attack",
                      "data_breach",
                      "system_failure",
                      "technology_obsolete",
                      "software_bug"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "oil_price_increase",
                      "renewable_energy_outage",
                      "energy_rationing",
                      "nuclear_energy_incident"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "climate_change",
                      "biodiversity_loss",
                      "pollution",
                      "sustainable_resource_management"
                    ],
                    "type": "string"
                  },
                  {
                    "enum": [
                      "consumer_trend_shift",
                      "demand_surge",
                      "demand_slump",
                      "new_market_entrant"
                    ],
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "enum": [
                      "healthcare_system_overload"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "other"
                    ]
                  }
                ]
              },
              "nullable": true
            },
            "description": "If set, only Risk Events of the provided types will be included in the result set. If 'null', all types will be included in the result set."
          },
          {
            "name": "countries",
            "in": "query",
            "required": false,
            "schema": {
              "description": "If set, only Risk Events impacting the provided countries will be included in the result set. If 'null', all countries will be included in the result set.",
              "title": "Countries",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            },
            "description": "If set, only Risk Events impacting the provided countries will be included in the result set. If 'null', all countries will be included in the result set."
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Result page.",
              "default": 1,
              "title": "Page"
            },
            "description": "Result page."
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Number of results to return per-query.",
              "default": 10,
              "title": "Per Page"
            },
            "description": "Number of results to return per-query."
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of risk events",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetRiskEventsResponse"
                },
                "examples": {
                  "multiple_events": {
                    "summary": "Multiple risk events with facets",
                    "description": "Paginated response showing various types of supply chain risk events with facet counts",
                    "value": {
                      "facets": [
                        {
                          "type": "event_type",
                          "value": "port_congestion",
                          "count": 15
                        },
                        {
                          "type": "event_type",
                          "value": "semiconductor_shortage",
                          "count": 8
                        },
                        {
                          "type": "event_type",
                          "value": "hurricane",
                          "count": 5
                        },
                        {
                          "type": "event_country",
                          "value": "US",
                          "count": 12
                        },
                        {
                          "type": "event_country",
                          "value": "CN",
                          "count": 10
                        },
                        {
                          "type": "event_country",
                          "value": "TW",
                          "count": 6
                        }
                      ],
                      "page_results": [
                        {
                          "id": "65f8a2b1c3d4e5f6a7b8c9d0",
                          "timestamp": "2024-03-15T08:30:00Z",
                          "last_modified": "2024-03-15T10:45:00Z",
                          "countries": [
                            "US",
                            "CN"
                          ],
                          "time_start": "2024-03-14T00:00:00Z",
                          "time_end": "2024-03-20T23:59:59Z",
                          "title": "Major Port Congestion at Los Angeles/Long Beach",
                          "description": "Severe congestion at the Los Angeles and Long Beach ports due to increased import volumes and labor shortages",
                          "sources": [
                            "https://www.reuters.example/business/port-congestion-2024",
                            "https://www.bloomberg.example/news/la-port-delays"
                          ],
                          "type": "port_congestion"
                        },
                        {
                          "id": "65f8a2b1c3d4e5f6a7b8c9d1",
                          "timestamp": "2024-02-28T14:20:00Z",
                          "last_modified": "2024-03-01T09:15:00Z",
                          "countries": [
                            "TW",
                            "KR",
                            "JP"
                          ],
                          "time_start": "2024-02-15T00:00:00Z",
                          "title": "Global Semiconductor Shortage Intensifies",
                          "description": "Ongoing semiconductor chip shortage affecting automotive and electronics industries worldwide",
                          "sources": [
                            "https://www.ft.example/semiconductor-shortage-2024"
                          ],
                          "type": "semiconductor_shortage"
                        },
                        {
                          "id": "65f8a2b1c3d4e5f6a7b8c9d2",
                          "timestamp": "2024-01-10T12:00:00Z",
                          "last_modified": "2024-01-12T14:30:00Z",
                          "countries": [
                            "RU",
                            "UA"
                          ],
                          "time_start": "2024-01-10T00:00:00Z",
                          "title": "Trade Route Disruption in Black Sea Region",
                          "description": "Ongoing military conflict affecting grain and energy exports through Black Sea shipping lanes",
                          "sources": [
                            "https://www.bbc.example/news/black-sea-trade-2024",
                            "https://www.wsj.example/grain-exports-disrupted"
                          ],
                          "type": "military_conflict"
                        }
                      ],
                      "current_page": 1,
                      "total_results": 28
                    }
                  },
                  "filtered_by_type": {
                    "summary": "Filtered by event type",
                    "description": "Results filtered to show only natural disaster events",
                    "value": {
                      "facets": [
                        {
                          "type": "event_type",
                          "value": "hurricane",
                          "count": 3
                        },
                        {
                          "type": "event_type",
                          "value": "earthquake",
                          "count": 2
                        },
                        {
                          "type": "event_type",
                          "value": "flood",
                          "count": 4
                        },
                        {
                          "type": "event_country",
                          "value": "US",
                          "count": 5
                        },
                        {
                          "type": "event_country",
                          "value": "JP",
                          "count": 2
                        }
                      ],
                      "page_results": [
                        {
                          "id": "65f8a2b1c3d4e5f6a7b8c9d3",
                          "timestamp": "2024-09-10T16:00:00Z",
                          "last_modified": "2024-09-12T08:30:00Z",
                          "countries": [
                            "US",
                            "MX"
                          ],
                          "time_start": "2024-09-08T00:00:00Z",
                          "time_end": "2024-09-15T23:59:59Z",
                          "title": "Hurricane Impacts Gulf Coast Supply Chains",
                          "description": "Category 4 hurricane disrupts oil refineries and chemical plants",
                          "sources": [
                            "https://www.noaa.gov/hurricane-tracker-2024"
                          ],
                          "type": "hurricane"
                        },
                        {
                          "id": "65f8a2b1c3d4e5f6a7b8c9d4",
                          "timestamp": "2024-08-22T03:45:00Z",
                          "last_modified": "2024-08-22T10:00:00Z",
                          "countries": [
                            "JP"
                          ],
                          "time_start": "2024-08-22T03:45:00Z",
                          "time_end": "2024-08-23T00:00:00Z",
                          "title": "Major Earthquake Disrupts Japanese Manufacturing",
                          "description": "7.2 magnitude earthquake affects automotive and electronics production facilities in central Japan",
                          "sources": [
                            "https://www.jma.go.jp/earthquake-2024"
                          ],
                          "type": "earthquake"
                        }
                      ],
                      "current_page": 1,
                      "total_results": 9
                    }
                  },
                  "empty_results": {
                    "summary": "No matching events",
                    "description": "Query returned no matching risk events",
                    "value": {
                      "facets": [],
                      "page_results": [],
                      "current_page": 1,
                      "total_results": 0
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reports/{report_id}/status": {
      "get": {
        "tags": [
          "Reports"
        ],
        "summary": "Get Report Status",
        "description": "Retrieve the status of a Tradeverifyd Report Request by id.",
        "operationId": "Get_Report_Status_reports__report_id__status_get",
        "parameters": [
          {
            "name": "report_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Report Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportStatusResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reports": {
      "post": {
        "tags": [
          "Reports"
        ],
        "summary": "Create Report Request",
        "description": "Creates a request for generating Tradeverifyd compliance reports. TASA reports require entity_id, CPR/CGR reports require shipment_id. TASA reports can optionally include hs_code.Currently only TASA reports are fully implemented.",
        "operationId": "Create_Report_Request_reports_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateReportRequest"
              },
              "examples": {
                "tasa_report": {
                  "summary": "TASA Report Request",
                  "description": "Tradeverifyd Advanced Supplier Assessment report for a specific entity. Provides comprehensive compliance scoring and risk analysis.",
                  "value": {
                    "report_type": "tasa",
                    "report_name": "ACME Corporation Supplier Assessment Q1 2024",
                    "entity_id": "507f1f77bcf86cd799439011",
                    "hs_code": "123456"
                  }
                },
                "cpr_report": {
                  "summary": "CPR Report Request",
                  "description": "Compliance Package Report for a specific shipment. Note: Currently not implemented (returns 501).",
                  "value": {
                    "report_type": "cpr",
                    "report_name": "Compliance Package - Shipment SH240315001",
                    "shipment_id": "987fcdeb-51a2-4c7f-8e3b-1234567890ab"
                  }
                },
                "cgr_report": {
                  "summary": "CGR Report Request",
                  "description": "Compliance Gap Report identifying areas for improvement. Note: Currently not implemented (returns 501).",
                  "value": {
                    "report_type": "cgr",
                    "report_name": "Compliance Gap Analysis - Electronics Import Q1 2024",
                    "shipment_id": "456fcdeb-51a2-4c7f-8e3b-0987654321ba"
                  }
                },
                "minimal_tasa": {
                  "summary": "Minimal TASA Request",
                  "description": "TASA report with auto-generated name (report_name will be set automatically)",
                  "value": {
                    "report_type": "tasa",
                    "entity_id": "507f1f77bcf86cd799439011"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Report request created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                },
                "examples": {
                  "tasa_success": {
                    "summary": "TASA Report Created",
                    "description": "Successful creation of a TASA (Tradeverifyd Advanced Supplier Assessment) report",
                    "value": {
                      "report_id": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_report_type": {
                    "summary": "Invalid Report Type",
                    "value": {
                      "detail": "Invalid report type"
                    }
                  },
                  "missing_entity_id": {
                    "summary": "Missing Entity ID for TASA",
                    "value": {
                      "detail": "Entity ID is required for TASA reports"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict - A matching report already exists",
            "content": {
              "application/json": {
                "examples": {
                  "duplicate_tasa_report": {
                    "summary": "Duplicate TASA Report",
                    "description": "A TASA report for this entity is already in progress or exists",
                    "value": {
                      "detail": "A report already exists for this request.",
                      "report_id": "123e4567-e89b-12d3-a456-426614174000",
                      "entity_id": "507f1f77bcf86cd799439011",
                      "report_type": "tasa",
                      "status": "processing"
                    }
                  },
                  "duplicate_cgr_report": {
                    "summary": "Duplicate CGR Report",
                    "description": "A CGR report for this fileset already exists",
                    "value": {
                      "detail": "A report already exists for this request.",
                      "report_id": "456e4567-e89b-12d3-a456-426614174111",
                      "report_type": "cgr",
                      "status": "complete"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reports/{report_id}": {
      "get": {
        "tags": [
          "Reports"
        ],
        "summary": "Get Report Details",
        "description": "Retrieve a Tradeverifyd Report Request Details by id.\n\nArgs:\n    report_id: UUID of the report.\n\nReturns:\n    ReportDetailResponse object:\n        id: UUID\n        requested_ts: datetime\n        completed_ts: Optional[datetime]\n        report_type: str\n        report_status: str\n        report_name: Optional[str]",
        "operationId": "Get_Report_Details_reports__report_id__get",
        "parameters": [
          {
            "name": "report_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Report Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Report details retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportDetailResponse"
                },
                "examples": {
                  "tasa_completed": {
                    "summary": "Completed TASA report",
                    "description": "Tradeverifyd Advanced Supplier Assessment report that has been completed",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "requested_ts": "2024-03-15T10:30:00Z",
                      "completed_ts": "2024-03-15T12:45:00Z",
                      "report_type": "tasa",
                      "report_status": "COMPLETED",
                      "report_name": "TASA Report - Apple Inc. Supplier Assessment"
                    }
                  },
                  "cpr_in_progress": {
                    "summary": "CPR report in progress",
                    "description": "Compliance Package Report currently being generated",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
                      "requested_ts": "2024-03-16T08:15:00Z",
                      "report_type": "cpr",
                      "report_status": "IN_PROGRESS",
                      "report_name": "CPR - Tesla Battery Supply Chain Compliance"
                    }
                  },
                  "cgr_failed": {
                    "summary": "Failed CGR report",
                    "description": "Compliance Gap Report that failed during generation",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d481",
                      "requested_ts": "2024-03-14T14:20:00Z",
                      "completed_ts": "2024-03-14T14:25:00Z",
                      "report_type": "cgr",
                      "report_status": "FAILED"
                    }
                  },
                  "tasa_pending": {
                    "summary": "Pending TASA report",
                    "description": "TASA report queued for processing",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d482",
                      "requested_ts": "2024-03-17T09:00:00Z",
                      "report_type": "tasa",
                      "report_status": "PENDING",
                      "report_name": "TASA - Boeing 737 Supplier Compliance Review"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Report not found",
            "content": {
              "application/json": {
                "examples": {
                  "not_found": {
                    "summary": "Report does not exist",
                    "value": {
                      "detail": "Report not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/reports/{report_id}/content": {
      "get": {
        "tags": [
          "Reports"
        ],
        "summary": "Get Report Contents",
        "description": "Retrieve the contents of a Tradeverifyd Report by report id.\n\nArgs:\n    \n\n    report_id: UUID of the report to retrieve content for.\n\n    report_supplement: Optional supplement name to retrieve. Currently only \"extended-graph\" is supported. Only available for CGR reports in JSON format.\n    If the report_supplement is provided, only the supplement is returned, otherwise the report is returned in the format specified by the accept header.\n\n    accept: Content format preference. Supported values: \"application/json\", \"application/pdf\". Defaults to \"application/json\".\n\n\nReturns:\n    \n\n    StreamingResponse: The report content as a streaming response with appropriate content type and filename headers.\n\nRaises:\n    \n\n    HTTPException: 404 if report not found, 403 if report not approved, 400 for invalid supplement requests.",
        "operationId": "Get_Report_Contents_reports__report_id__content_get",
        "parameters": [
          {
            "name": "report_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Report Id"
            }
          },
          {
            "name": "report_supplement",
            "in": "query",
            "required": false,
            "schema": {
              "default": "",
              "title": "Report Supplement",
              "type": "string",
              "nullable": true
            }
          },
          {
            "name": "accept",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "default": "application/json",
              "title": "Accept"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/TASAContentsResponse"
                    },
                    {
                      "$ref": "#/components/schemas/CGRContentsResponse"
                    },
                    {
                      "$ref": "#/components/schemas/CPRContentsResponse"
                    },
                    {
                      "$ref": "#/components/schemas/WSCContentsResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DSCContentsResponse"
                    }
                  ],
                  "title": "Response Get Report Contents Reports  Report Id  Content Get"
                }
              },
              "application/pdf": {}
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/flags/upload": {
      "post": {
        "tags": [
          "Flags"
        ],
        "summary": "Upload Flags",
        "description": "Upload flags for processing. Expected time to process and be available in the\nsystem is approximately 5-10 minutes.\n\nThis endpoint allows uploading flags for entities. Each flag must be associated with an entity\nand contain information about potential risks or issues.\n\n**This information is private to your organization only and will not be shared with any other organization.**\n\n**Required Fields:**\n- `entity_id`: Unique identifier for the entity associated with the flag\n- `flag_type`: The primary category of the flag (e.g., \"Sanctions & Restricted Entities Risk\",\n\"Worker & Consumer Safety Risk\", \"Environmental Violations Risk\")\n- `flag_subtype`: A more specific classification within the flag type (e.g.,\n\"Financial Crimes & Violations\", \"International Sanctions\", \"Terrorism Financing\")\n- `source_location`: The URL or location where the flag information was found\n(e.g., \"https://example.example/news/article\")\n- `description`: Detailed explanation of the flag and its significance\n\nNote: `flag_type` and `flag_subtype` must fall into one of the existing flag types defined in the system.\n\n**Optional Fields:**\n- `tags`: Single word identifier for categorizing flags by subcategories\n- `time_start`: Start date/time when the flag becomes valid\n- `time_end`: End date/time when the flag expires\n\n**Response:**\nReturns a summary of the processing results including the total number of flags submitted\nand how many were successfully inserted into the system.",
        "operationId": "upload_bulk_staged_flags_external_flags_upload_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "items": {
                  "$ref": "#/components/schemas/ExternalBulkFlagItem"
                },
                "type": "array",
                "title": "Bulk Flags"
              },
              "examples": {
                "ofac_sanctions_flag": {
                  "summary": "OFAC Sanctions Flag",
                  "description": "Flag indicating entity appears on OFAC sanctions list. Uses entity_id for identification.",
                  "value": [
                    {
                      "entity_id": "507f1f77bcf86cd799439011",
                      "flag_type": "Sanctions & Restricted Entities Risk",
                      "flag_subtype": "International Sanctions",
                      "description": "Entity appears on OFAC Specially Designated Nationals List for involvement in illicit activities",
                      "tags": "financial_crimes",
                      "source_location": "https://sanctionssearch.ofac.treas.example/Details.aspx?id=12345",
                      "time_start": "2024-01-15T00:00:00Z"
                    }
                  ]
                },
                "adverse_media_flag": {
                  "summary": "Adverse Media Flag",
                  "description": "Flag for negative media coverage. Uses entity name and jurisdiction for identification.",
                  "value": [
                    {
                      "entity_id": "497f1f77bef96cd799439012",
                      "flag_type": "Worker & Consumer Safety Risk",
                      "flag_subtype": "Workplace & Labor Violations",
                      "description": "Media reports indicate potential labor rights violations at manufacturing facilities",
                      "tags": "labor_violations",
                      "source_location": "https://news.example/reports/labor-violations-china-2024",
                      "time_start": "2024-08-01T10:30:00Z"
                    }
                  ]
                },
                "regulatory_compliance_flag": {
                  "summary": "Regulatory Compliance Flag",
                  "description": "Flag for regulatory violations with time-bound validity period.",
                  "value": [
                    {
                      "entity_id": "507f1f77bcf86cd799439012",
                      "flag_type": "Worker & Consumer Safety Risk",
                      "flag_subtype": "Workplace & Labor Violations",
                      "description": "Operating without required environmental compliance certifications",
                      "tags": "environmental",
                      "source_location": "https://epa.example/enforcement/case-567890",
                      "time_start": "2024-06-01T00:00:00Z",
                      "time_end": "2025-06-01T00:00:00Z"
                    }
                  ]
                },
                "multiple_flags_bulk": {
                  "summary": "Multiple Flags Upload",
                  "description": "Example of uploading multiple flags in a single request with different flag types and entity identification methods.",
                  "value": [
                    {
                      "entity_id": "507f1f77bcf86cd799439013",
                      "flag_type": "Sanctions & Restricted Entities Risk",
                      "flag_subtype": "Legal Violations",
                      "description": "Entity listed on UN Security Council sanctions list",
                      "tags": "terrorism",
                      "source_location": "https://www.un.example/securitycouncil/sanctions/1267/aq_list",
                      "time_start": "2024-03-01T00:00:00Z"
                    },
                    {
                      "entity_id": "492f1f66bcf86cd784439012",
                      "flag_type": "Sanctions & Restricted Entities Risk",
                      "flag_subtype": "Financial Crimes & Violations",
                      "description": "Reports of accounting irregularities and potential fraud",
                      "tags": "financial_fraud",
                      "source_location": "https://sec.example/news/press-release/2024-56",
                      "time_start": "2024-07-15T09:00:00Z"
                    }
                  ]
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Flags processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalBulkFlagResponse"
                },
                "examples": {
                  "successful_processing": {
                    "summary": "Successful flag processing",
                    "description": "All flags were successfully processed and inserted",
                    "value": {
                      "message": "Flags processed successfully",
                      "flag_count": 3,
                      "inserted_count": 3,
                      "status": "completed"
                    }
                  },
                  "partial_success": {
                    "summary": "Partial processing success",
                    "description": "Some flags were processed successfully, others failed validation",
                    "value": {
                      "message": "Flags processed successfully",
                      "flag_count": 5,
                      "inserted_count": 3,
                      "status": "completed"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Validation errors",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_payload": {
                    "summary": "Invalid flags payload",
                    "value": {
                      "detail": "Validation error: Invalid flags payload."
                    }
                  },
                  "payload_validation_failed": {
                    "summary": "Payload validation failed",
                    "value": {
                      "detail": "Flags payload failed validation"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Missing entity_id",
            "content": {
              "application/json": {
                "examples": {
                  "missing_entity_id": {
                    "summary": "Invalid upload",
                    "description": "entity_id is missing from the provided flag(s)",
                    "value": {
                      "detail": [
                        {
                          "type": "missing",
                          "loc": [
                            "body",
                            0,
                            "entity_id"
                          ],
                          "msg": "Field required",
                          "input": {
                            "flag_type": "Sanctions & Restricted Entities Risk",
                            "flag_subtype": "International Sanctions",
                            "description": "Entity appears on OFAC Specially Designated Nationals List for involvement in illicit activities",
                            "tags": "financial_crimes",
                            "source_location": "https://sanctionssearch.ofac.treas.example/Details.aspx?id=12345",
                            "time_start": "2024-01-15T00:00:00Z"
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flags/update/{flag_id}": {
      "put": {
        "tags": [
          "Flags"
        ],
        "summary": "Update a flag",
        "description": "Update an existing Flag.\nUsers can only update Flags that belong to their organization.\nThe provided information will override existing information. It is not a merge.\n\n**Required Fields**:\n- `flag_id`: ID for Flag undergoing update.\n- Flag information for update.\n\n**Returns**:\n- The Flag object representing the updated flag.\n\n**Example Usage**:\n- Requesting `PUT /v1/flags/update/{flag_id}` with a valid `flag_id` that belongs to the user's organization\n    will update the specified flag.",
        "operationId": "update_flag_flags_update__flag_id__put",
        "parameters": [
          {
            "name": "flag_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Flag Id"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FlagUpdateItem"
              },
              "examples": {
                "update_sanctions_flag": {
                  "summary": "Update OFAC sanctions flag",
                  "description": "Update an existing OFAC sanctions flag with additional context, new sources, and updated validity period.",
                  "value": {
                    "entity_jurisdiction": "US",
                    "description": "Updated OFAC sanctions flag with additional context from compliance review",
                    "tags": [
                      "sanctions",
                      "financial_crimes",
                      "OFAC"
                    ],
                    "source": [
                      "https://sanctionssearch.ofac.treas.example/Details.aspx?id=12345"
                    ],
                    "time_start": "2024-01-15T00:00:00Z",
                    "time_end": "2025-01-15T00:00:00Z",
                    "owner_email": "compliance@company.example",
                    "deleted": false
                  }
                },
                "update_adverse_media_flag": {
                  "summary": "Update adverse media flag",
                  "description": "Update an adverse media flag with new information, jurisdiction change, and expiration date.",
                  "value": {
                    "entity_jurisdiction": "CN",
                    "description": "Updated media reports regarding labor concerns with additional investigation results",
                    "tags": [
                      "labor_concerns",
                      "adverse_media"
                    ],
                    "source": [
                      "https://news.example/labor-investigation-update-2024"
                    ],
                    "time_start": "2024-08-01T14:20:00Z",
                    "time_end": "2025-02-01T00:00:00Z",
                    "owner_email": "risk@company.example",
                    "deleted": false
                  }
                },
                "mark_flag_deleted": {
                  "summary": "Mark flag as deleted",
                  "description": "Mark an existing flag as deleted with deletion metadata.",
                  "value": {
                    "deleted": true,
                    "deleted_at": "2024-08-26T15:30:00Z",
                    "deletion_source": "Manual review - flag no longer applicable"
                  }
                },
                "minimal_update": {
                  "summary": "Minimal flag update",
                  "description": "Update only the description field while keeping other values unchanged.",
                  "value": {
                    "description": "Updated flag description with latest compliance findings"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Flag successfully updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateFlagResponse"
                },
                "examples": {
                  "sanctions_flag_updated": {
                    "summary": "Updated OFAC sanctions flag",
                    "description": "Successfully updated OFAC sanctions flag with additional context and sources.",
                    "value": {
                      "id": "507f1f77bcf86cd799439023",
                      "entity_id": "507f1f77bcf86cd799439024",
                      "created_at": "2024-01-15T10:30:00Z",
                      "time_start": "2024-01-15T00:00:00Z",
                      "time_end": "2025-01-15T00:00:00Z",
                      "type": "507f1f77bcf86cd799439025",
                      "description": "Updated OFAC sanctions flag with additional context from compliance review",
                      "sources": [
                        {
                          "url": "https://sanctionssearch.ofac.treas.example/Details.aspx?id=12345",
                          "title": "News on OFAC Sanctions"
                        }
                      ]
                    }
                  },
                  "adverse_media_flag_updated": {
                    "summary": "Updated adverse media flag",
                    "description": "Updated adverse media flag with new jurisdiction and expiration date.",
                    "value": {
                      "id": "507f1f77bcf86cd799439026",
                      "entity_id": "507f1f77bcf86cd799439027",
                      "created_at": "2024-08-01T14:20:00Z",
                      "time_start": "2024-08-01T14:20:00Z",
                      "time_end": "2025-02-01T00:00:00Z",
                      "type": "507f1f77bcf86cd799439028",
                      "description": "Updated media reports regarding labor concerns with additional investigation results",
                      "sources": [
                        {
                          "url": "https://news.example/labor-investigation-update-2024",
                          "title": "Results of Labor Investigation 2024"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Flag not found",
            "content": {
              "application/json": {
                "examples": {
                  "flag_not_found": {
                    "summary": "Flag either doesn't exist or the user does not have permissions to update it.",
                    "value": {
                      "detail": "Flag does not exist or you do not have access."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/flags/types": {
      "get": {
        "tags": [
          "Flags"
        ],
        "summary": "Get Flags Types",
        "description": "This endpoint is designed to provide a list of all possible flags types and\nsubtypes.",
        "operationId": "get_flags_types_flags_types_get",
        "responses": {
          "200": {
            "description": "Example of a flag type returned by the Get Flags Types endpoint",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/FlagTypeResponse"
                  },
                  "type": "array",
                  "title": "Response Get Flags Types Flags Types Get"
                },
                "examples": {
                  "flag_type": {
                    "summary": "Example Flag Type",
                    "value": [
                      {
                        "id": "67db089a68f5abb001405784",
                        "flag_type_description": "Highlights entities mishandling, illegally disposing of, or improperly labeling toxic chemicals and hazardous materials.",
                        "flag_type": "Environmental Violations Risk",
                        "flag_subtype": "Chemical & Hazardous Substances Violation",
                        "flag_polarity": -1
                      }
                    ]
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flags": {
      "get": {
        "tags": [
          "Flags"
        ],
        "summary": "Get Flags",
        "description": "Retrieve flags related to a specific entity.\n\nThis endpoint is designed to provide a list of flags associated with an\nentity. Flags represent important markers or alerts related to the entity,\nsuch as compliance issues, risk indicators, or other significant\nannotations.\n\nFlags can be invalidated by external evidence, or no longer apply for time\nreasons to a specific entity.\n\n## Note:\n- `entity_id` MUST be provided.\n- If interested in viewing flagged affiliates, please use the `Get Entity Graph\nFlagged Relationships` endpoint at\n`/entities/{entity_id}/graph/flagged_relationships`",
        "operationId": "get_flags_flags_get",
        "parameters": [
          {
            "name": "entity_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The unique identifier of the entity for which flags are being requested. This parameter is required.",
              "title": "Entity Id"
            },
            "description": "The unique identifier of the entity for which flags are being requested. This parameter is required."
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved flags for the specified entity",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DisplayFlagResponse"
                  },
                  "title": "Response Get Flags Flags Get"
                },
                "examples": {
                  "entity_flags": {
                    "summary": "Entity flags",
                    "description": "Multiple flags for Example Contoso Inc.",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439011",
                        "entity_id": "507f1f77bcf86cd799439012",
                        "entity_name": "Example Contoso Inc.",
                        "entity_jurisdiction": "US",
                        "created_at": "2024-01-15T10:30:00Z",
                        "time_start": "2024-01-15T00:00:00Z",
                        "time_end": "2025-01-15T00:00:00Z",
                        "type": "507f1f77bcf86cd799439013",
                        "flag_type": "regulatory",
                        "flag_subtype": "export_compliance",
                        "description": "Export compliance review required for technology transfers to restricted jurisdictions",
                        "sources": [
                          {
                            "id": " 5d4964ad-81b6-41f8-9d56-bcdb30a08bfc ",
                            "url": "https://bis.doc.example/index.php/policy-guidance/entity-list",
                            "title": "Export Compliance Review 2024"
                          }
                        ]
                      },
                      {
                        "id": "507f1f77bcf86cd799439014",
                        "entity_id": "507f1f77bcf86cd799439015",
                        "entity_name": "ACME CORP.",
                        "entity_jurisdiction": "TW",
                        "created_at": "2024-08-01T14:20:00Z",
                        "time_start": "2024-08-01T14:20:00Z",
                        "type": "507f1f77bcf86cd799439016",
                        "flag_type": "adverse_media",
                        "flag_subtype": "labor_concerns",
                        "description": "Reports of worker safety violations and excessive overtime at manufacturing facilities",
                        "sources": [
                          {
                            "url": "https://news.example/acme-labor-violations-2024"
                          }
                        ]
                      }
                    ]
                  },
                  "sanctions_flags": {
                    "summary": "OFAC sanctions flags",
                    "description": "Multiple sanctions flags for entities appearing on various government watch lists with different severity levels.",
                    "value": [
                      {
                        "id": "507f1f77bcf86cd799439017",
                        "entity_id": "507f1f77bcf86cd799439018",
                        "entity_name": "Example Contoso Inc.",
                        "entity_jurisdiction": "RU",
                        "created_at": "2024-03-01T09:00:00Z",
                        "time_start": "2024-03-01T00:00:00Z",
                        "type": "507f1f77bcf86cd799439019",
                        "flag_type": "sanctions",
                        "flag_subtype": "OFAC",
                        "description": "Entity appears on OFAC Specially Designated Nationals List for involvement in activities contrary to US national security",
                        "sources": [
                          {
                            "url": "https://sanctionssearch.ofac.treas.example/Details.aspx?id=12345"
                          }
                        ]
                      },
                      {
                        "id": "507f1f77bcf86cd799439020",
                        "entity_id": "507f1f77bcf86cd799439021",
                        "entity_name": "ACME CORP.",
                        "entity_jurisdiction": "IR",
                        "created_at": "2024-06-15T11:45:00Z",
                        "time_start": "2024-06-15T11:45:00Z",
                        "time_end": "2025-06-15T11:45:00Z",
                        "type": "507f1f77bcf86cd799439022",
                        "flag_type": "sanctions",
                        "flag_subtype": "UN_Security_Council",
                        "description": "Listed on UN Security Council sanctions list for nuclear proliferation activities",
                        "sources": [
                          {
                            "url": "https://www.un.example/securitycouncil/sanctions/1737/materials"
                          }
                        ]
                      }
                    ]
                  },
                  "no_flags_found": {
                    "summary": "No flags found for entity",
                    "description": "Empty response when no flags are found for the specified entity.",
                    "value": []
                  }
                }
              }
            }
          },
          "404": {
            "description": "Entity not found",
            "content": {
              "application/json": {
                "examples": {
                  "entity_not_found": {
                    "summary": "Entity not found by id",
                    "value": {
                      "detail": "Entity not found."
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Content",
            "content": {
              "application/json": {
                "examples": {
                  "entity_id_missing": {
                    "summary": "Missing entity_id",
                    "value": {
                      "detail": [
                        {
                          "type": "missing",
                          "loc": [
                            "query",
                            "entity_id"
                          ],
                          "msg": "Field required",
                          "input": ""
                        }
                      ]
                    }
                  },
                  "invalid_entity_id": {
                    "summary": "Invalid entity_id",
                    "value": {
                      "detail": [
                        {
                          "type": "is_instance_of",
                          "loc": [
                            "query",
                            "entity_id",
                            "is-instance[ObjectId]"
                          ],
                          "msg": "Input should be an instance of ObjectId",
                          "input": "12345",
                          "ctx": {
                            "class": "ObjectId"
                          }
                        },
                        {
                          "type": "value_error",
                          "loc": [
                            "query",
                            "entity_id",
                            "chain[str,function-plain[validate()]]"
                          ],
                          "msg": "Value error, Invalid bson.ObjectId: 12345",
                          "input": "12345",
                          "ctx": {
                            "error": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/organizations/organizational-units": {
      "get": {
        "tags": [
          "Organizations"
        ],
        "summary": "Get Organizational Units",
        "description": "Get the organizational units available to the requesting user.",
        "operationId": "get_organizational_units_organizations_organizational_units_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array",
                  "title": "Response Get Organizational Units Organizations Organizational Units Get"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipments": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get Shipment List",
        "description": "Get a list of shipments.",
        "operationId": "get_shipments_shipments_get",
        "parameters": [
          {
            "name": "shipment_name",
            "in": "query",
            "required": false,
            "schema": {
              "default": [],
              "title": "Shipment Name",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "default": [],
              "title": "Status",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "default": 1,
              "title": "Page",
              "type": "integer",
              "nullable": true
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "default": 25,
              "title": "Page Size",
              "type": "integer",
              "nullable": true
            }
          },
          {
            "name": "sorting",
            "in": "query",
            "required": false,
            "schema": {
              "default": "",
              "title": "Sorting",
              "type": "string",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of shipments with pagination",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentListingResponse"
                },
                "examples": {
                  "multiple_shipments": {
                    "summary": "Multiple shipments across different industries",
                    "description": "Paginated list showing various shipment types and statuses across different organizational units",
                    "value": {
                      "shipments": [
                        {
                          "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                          "shipment_name": "Cellphone Components - Q1 2024",
                          "organization": "ACME_CORP",
                          "organizational_units": [
                            "Electronics Division",
                            "Mobile Devices"
                          ],
                          "status": "In Transit",
                          "active": true
                        },
                        {
                          "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
                          "shipment_name": "Battery Modules - Shanghai to Fremont",
                          "organization": "ACME_CORP",
                          "organizational_units": [
                            "Automotive Division"
                          ],
                          "status": "Complete",
                          "active": true
                        },
                        {
                          "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d481",
                          "shipment_name": "Medical Supplies - Emergency Procurement",
                          "organization": "ACME_CORP",
                          "organizational_units": [
                            "Healthcare Division"
                          ],
                          "status": "Detained",
                          "active": true
                        },
                        {
                          "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d482",
                          "shipment_name": "Aerospace Components",
                          "organization": "ACME_CORP",
                          "organizational_units": [
                            "Aerospace Division"
                          ],
                          "status": "Created",
                          "active": true
                        }
                      ],
                      "pagination": {
                        "current_page": 1,
                        "page_size": 10,
                        "total_pages": 3,
                        "total_records": 25
                      },
                      "filters": {
                        "shipment_name": [],
                        "status": []
                      },
                      "sorting": [
                        "shipment_name:asc"
                      ]
                    }
                  },
                  "filtered_shipments": {
                    "summary": "Filtered shipments by status",
                    "description": "Shipments filtered to show only those in transit",
                    "value": {
                      "shipments": [
                        {
                          "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d483",
                          "shipment_name": "Smartphone Supply Chain - Asia Pacific",
                          "organization": "ACME_CORP",
                          "organizational_units": [
                            "Electronics Division"
                          ],
                          "status": "In Transit",
                          "active": true
                        },
                        {
                          "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d484",
                          "shipment_name": "Vehicle Parts - Mexico to Detroit",
                          "organization": "ACME_CORP",
                          "organizational_units": [
                            "Automotive Division"
                          ],
                          "status": "In Transit",
                          "active": true
                        }
                      ],
                      "pagination": {
                        "current_page": 1,
                        "page_size": 10,
                        "total_pages": 1,
                        "total_records": 2
                      },
                      "filters": {
                        "shipment_name": [],
                        "status": [
                          "In Transit"
                        ]
                      },
                      "sorting": [
                        "departure_date:desc"
                      ]
                    }
                  },
                  "empty_results": {
                    "summary": "No matching shipments",
                    "description": "Query returned no matching shipments",
                    "value": {
                      "shipments": [],
                      "pagination": {
                        "current_page": 1,
                        "page_size": 10,
                        "total_pages": 0,
                        "total_records": 0
                      },
                      "filters": {
                        "shipment_name": [
                          "Non-existent Shipment"
                        ],
                        "status": []
                      },
                      "sorting": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request - invalid parameters",
            "content": {
              "application/json": {
                "examples": {
                  "no_organizational_units": {
                    "summary": "User lacks organizational units",
                    "value": {
                      "detail": "User does not have any organizational units"
                    }
                  },
                  "invalid_paging": {
                    "summary": "Invalid paging parameters",
                    "value": {
                      "detail": "Invalid Paging Parameters"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Shipments"
        ],
        "summary": "Create Shipment",
        "description": "Creates a new shipment. To update an existing shipment, use PUT /shipments/{shipment_id} instead. Supports multiple organizational units per shipment for flexible organization structure management. Auto-creates LEI and ITI credentials if organization has AUTO_CREATE_SHIPMENT_CREDENTIALS enabled.",
        "operationId": "create_shipment_shipments_post",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateShipmentRequest"
              },
              "examples": {
                "create_electronics_shipment": {
                  "summary": "Create New Electronics Shipment",
                  "description": "Create new shipment for cellphone components",
                  "value": {
                    "shipment_name": "2024-Q1-Phone-Components",
                    "origin": "Shenzhen, Guangdong, China",
                    "destination": "Cupertino, CA, USA",
                    "departure_date": "2024-03-01T08:00:00Z",
                    "arrival_date": "2024-03-15T16:30:00Z",
                    "status": "Created",
                    "active": true,
                    "organizational_units": [
                      "electronics",
                      "supply-chain"
                    ]
                  }
                },
                "create_detained_shipment": {
                  "summary": "Create Detained Shipment",
                  "description": "Create medical supplies shipment with detention ID",
                  "value": {
                    "shipment_name": "Med-2024-PPE-Emergency",
                    "origin": "Hamburg, Germany",
                    "destination": "New York, NY, USA",
                    "departure_date": "2024-03-05T06:00:00Z",
                    "arrival_date": "2024-03-20T12:00:00Z",
                    "status": "Detained",
                    "active": true,
                    "organizational_units": [
                      "medical",
                      "emergency"
                    ],
                    "detention_id": "CBP-DET-2024-001234"
                  }
                },
                "minimal_shipment": {
                  "summary": "Minimal Required Fields",
                  "description": "Shipment with only required fields",
                  "value": {
                    "shipment_name": "Basic-Shipment-2024",
                    "status": "Created",
                    "organizational_units": [
                      "default"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Shipment created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentDetailResponse"
                },
                "examples": {
                  "created_electronics_shipment": {
                    "summary": "Created Electronics Shipment",
                    "description": "New shipment created for smartphone components from China",
                    "value": {
                      "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "shipment_name": "2024-Q1-Phone-Components",
                      "organization": "phones-inc",
                      "organizational_unit": [
                        "electronics",
                        "supply-chain"
                      ],
                      "folder": "2024-Q1-Phone-Components",
                      "origin": "Shenzhen, Guangdong, China",
                      "destination": "Cupertino, CA, USA",
                      "departure_date": "2024-03-01T08:00:00Z",
                      "arrival_date": "2024-03-15T16:30:00Z",
                      "status": "Created",
                      "active": true
                    }
                  },
                  "created_medical_shipment": {
                    "summary": "Created Medical Shipment",
                    "description": "New medical supplies shipment created with detention status",
                    "value": {
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440000",
                      "shipment_name": "2024-PPE-Emergency",
                      "organization": "ppe-corp",
                      "organizational_unit": [
                        "medical",
                        "emergency"
                      ],
                      "detention_id": "CBP-DET-2024-001234",
                      "folder": "2024-PPE-Emergency",
                      "origin": "Hamburg, Germany",
                      "destination": "New York, NY, USA",
                      "departure_date": "2024-03-05T06:00:00Z",
                      "arrival_date": "2024-03-20T12:00:00Z",
                      "status": "Detained",
                      "active": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "duplicate_name": {
                    "summary": "Duplicate shipment name",
                    "value": {
                      "detail": "Shipment name already exists and no id was provided - Not unique"
                    }
                  },
                  "invalid_status": {
                    "summary": "Invalid shipment status",
                    "value": {
                      "detail": "Invalid shipment status"
                    }
                  },
                  "missing_org_units": {
                    "summary": "Missing organizational units",
                    "value": {
                      "detail": "Organizational units are required"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity - Invalid organizational unit",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_organizational_unit": {
                    "summary": "Invalid organizational unit",
                    "value": {
                      "detail": {
                        "error": "Invalid organizational_unit",
                        "message": "The organizational_unit 'ABC123' does not exist or you do not have permission to use it."
                      }
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "content": {
              "application/json": {
                "examples": {
                  "creation_error": {
                    "summary": "Shipment creation failed",
                    "value": {
                      "detail": "An error occurred creating the shipment"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipments/{shipment_id}": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get Shipment",
        "description": "Get a shipment by ID.",
        "operationId": "get_shipment_by_id_shipments__shipment_id__get",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Shipment Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Shipment details retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Get Shipment By Id Shipments  Shipment Id  Get",
                  "$ref": "#/components/schemas/ShipmentDetailResponse",
                  "nullable": true
                },
                "examples": {
                  "electronics_shipment": {
                    "summary": "Electronics shipment in transit",
                    "description": "Phone components shipment from China to USA",
                    "value": {
                      "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "shipment_name": "Smartphone Components - Q4 2024",
                      "organization": "ACME_CORP",
                      "organizational_unit": [
                        "Electronics Division",
                        "Mobile Devices"
                      ],
                      "folder": "electronics/smartphones",
                      "origin": "Shenzhen, China",
                      "destination": "Cupertino, CA, USA",
                      "departure_date": "2024-03-15T08:00:00Z",
                      "arrival_date": "2024-03-25T14:30:00Z",
                      "status": "In Transit",
                      "active": true
                    }
                  },
                  "detained_shipment": {
                    "summary": "Detained medical shipment",
                    "description": "Medical equipment shipment detained during customs inspection",
                    "value": {
                      "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
                      "shipment_name": "Medical Equipment - Emergency Supply",
                      "organization": "ACME_CORP",
                      "organizational_unit": [
                        "Healthcare Division"
                      ],
                      "detention_id": "DET-2024-0315-001",
                      "folder": "healthcare/medical_equipment",
                      "origin": "Frankfurt, Germany",
                      "destination": "New York, NY, USA",
                      "departure_date": "2024-03-10T10:00:00Z",
                      "status": "Detained",
                      "active": true
                    }
                  },
                  "completed_automotive": {
                    "summary": "Completed automotive shipment",
                    "description": "Electric vehicle battery modules successfully delivered",
                    "value": {
                      "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d481",
                      "shipment_name": "EV Battery Modules - Shanghai to Fremont",
                      "organization": "ACME_CORP",
                      "organizational_unit": [
                        "Automotive Division",
                        "EV Components"
                      ],
                      "folder": "automotive/ev/battery_modules",
                      "origin": "Shanghai, China",
                      "destination": "Fremont, CA, USA",
                      "departure_date": "2024-02-20T06:00:00Z",
                      "arrival_date": "2024-03-05T11:45:00Z",
                      "status": "Complete",
                      "active": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request - invalid parameters",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_request": {
                    "summary": "User lacks organizational units or invalid ID",
                    "value": {
                      "detail": "User does not have any organizational units or shipment ID is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Shipment not found",
            "content": {
              "application/json": {
                "examples": {
                  "not_found": {
                    "summary": "Shipment does not exist",
                    "value": {
                      "detail": "Shipment not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Shipments"
        ],
        "summary": "Update Shipment",
        "description": "Updates an existing shipment. The shipment ID is specified in the URL path. Supports multiple organizational units per shipment for flexible organization structure management.",
        "operationId": "update_shipment_shipments__shipment_id__put",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Shipment Id"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateShipmentRequest"
              },
              "examples": {
                "update_electronics_shipment": {
                  "summary": "Update Electronics Shipment",
                  "description": "Update vehicle battery shipment with new arrival date",
                  "value": {
                    "shipment_name": "2024-Model3-Batteries-Updated",
                    "origin": "Shanghai, China",
                    "destination": "Fremont, CA, USA",
                    "departure_date": "2024-02-20T10:00:00Z",
                    "arrival_date": "2024-03-12T16:45:00Z",
                    "status": "In Transit",
                    "active": true,
                    "organizational_units": [
                      "automotive",
                      "batteries"
                    ]
                  }
                },
                "update_medical_shipment": {
                  "summary": "Update Medical Shipment Status",
                  "description": "Update medical supplies shipment status to Complete",
                  "value": {
                    "shipment_name": "2024-PPE-Emergency",
                    "origin": "Hamburg, Germany",
                    "destination": "New York, NY, USA",
                    "departure_date": "2024-03-05T06:00:00Z",
                    "arrival_date": "2024-03-18T14:30:00Z",
                    "status": "Complete",
                    "active": true,
                    "organizational_units": [
                      "medical",
                      "emergency"
                    ]
                  }
                },
                "minimal_update": {
                  "summary": "Minimal Update Fields",
                  "description": "Update with only required fields",
                  "value": {
                    "shipment_name": "Updated-Shipment-2024",
                    "status": "In Transit",
                    "organizational_units": [
                      "default"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Shipment updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentDetailResponse"
                },
                "examples": {
                  "updated_electronics_shipment": {
                    "summary": "Updated Electronics Shipment",
                    "description": "Vehicle battery shipment updated with new arrival date",
                    "value": {
                      "shipment_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
                      "shipment_name": "2024-Model3-Batteries-Updated",
                      "organization": "acme-motors",
                      "organizational_unit": [
                        "automotive",
                        "batteries"
                      ],
                      "folder": "2024-Model3-Batteries",
                      "origin": "Shanghai, China",
                      "destination": "Fremont, CA, USA",
                      "departure_date": "2024-02-20T10:00:00Z",
                      "arrival_date": "2024-03-12T16:45:00Z",
                      "status": "In Transit",
                      "active": true
                    }
                  },
                  "updated_medical_shipment": {
                    "summary": "Updated Medical Shipment",
                    "description": "Medical supplies shipment status updated to Complete",
                    "value": {
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440000",
                      "shipment_name": "2024-PPE-Emergency",
                      "organization": "medical-corp",
                      "organizational_unit": [
                        "medical",
                        "emergency"
                      ],
                      "folder": "2024-PPE-Emergency",
                      "origin": "Hamburg, Germany",
                      "destination": "New York, NY, USA",
                      "departure_date": "2024-03-05T06:00:00Z",
                      "arrival_date": "2024-03-18T14:30:00Z",
                      "status": "Complete",
                      "active": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_org_units": {
                    "summary": "Invalid organizational units",
                    "value": {
                      "detail": "User does not have access to the specified organizational units"
                    }
                  },
                  "missing_org_units": {
                    "summary": "Missing organizational units",
                    "value": {
                      "detail": "Organizational units are required"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "examples": {
                  "shipment_not_found": {
                    "summary": "Shipment not found",
                    "value": {
                      "detail": "Shipment not found"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "content": {
              "application/json": {
                "examples": {
                  "update_error": {
                    "summary": "Shipment update failed",
                    "value": {
                      "detail": "An error occurred updating the shipment"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipment/{shipment_id}/sirs": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get supplier information requests",
        "description": "Get shipment supplier information requests",
        "operationId": "get_shipment_sirs_shipment__shipment_id__sirs_get",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Shipment Id"
            }
          },
          {
            "name": "supplier_name",
            "in": "query",
            "required": false,
            "schema": {
              "default": [],
              "title": "Supplier Name",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "supplier_jurisdiction",
            "in": "query",
            "required": false,
            "schema": {
              "default": [],
              "title": "Supplier Jurisdiction",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "tradeverifyd_score",
            "in": "query",
            "required": false,
            "schema": {
              "default": [],
              "title": "Tradeverifyd Score",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "default": [],
              "title": "Status",
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "default": 1,
              "title": "Page",
              "type": "integer",
              "nullable": true
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "default": 25,
              "title": "Page Size",
              "type": "integer",
              "nullable": true
            }
          },
          {
            "name": "sorting",
            "in": "query",
            "required": false,
            "schema": {
              "default": "",
              "title": "Sorting",
              "type": "string",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of supplier information requests for the shipment",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierInformationRequestListing"
                },
                "examples": {
                  "multiple_sirs": {
                    "summary": "Multiple SIRs with various statuses",
                    "description": "Comprehensive list of supplier information requests with different risk scores and statuses",
                    "value": {
                      "requests": [
                        {
                          "sir_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                          "supplier_name": "ACME Corp",
                          "supplier_jurisdiction": "TW",
                          "status": "Documents Received",
                          "tradeverifyd_score": 572.5
                        },
                        {
                          "sir_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
                          "supplier_name": "Electric Company",
                          "supplier_jurisdiction": "KR",
                          "status": "Documents Requested",
                          "tradeverifyd_score": 565.0
                        },
                        {
                          "sir_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
                          "supplier_name": "Manufacturing Group",
                          "supplier_jurisdiction": "TW",
                          "status": "Not Contacted",
                          "tradeverifyd_score": 558.3
                        },
                        {
                          "sir_id": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
                          "supplier_name": "Wonka Industries",
                          "supplier_jurisdiction": "KR",
                          "status": "Eliminated",
                          "tradeverifyd_score": 545.2
                        }
                      ],
                      "pagination": {
                        "current_page": 1,
                        "page_size": 20,
                        "total_pages": 1,
                        "total_records": 4
                      },
                      "sorting": [
                        "supplier_name:asc"
                      ],
                      "filters": {
                        "supplier_name": [],
                        "supplier_jurisdiction": [],
                        "status": [],
                        "tradeverifyd_score": []
                      }
                    }
                  },
                  "filtered_by_status": {
                    "summary": "SIRs filtered by status",
                    "description": "Only showing SIRs with 'Documents Requested' status",
                    "value": {
                      "requests": [
                        {
                          "sir_id": "550e8400-e29b-41d4-a716-446655440000",
                          "supplier_name": "ACME Corp.",
                          "supplier_jurisdiction": "CN",
                          "status": "Documents Requested",
                          "tradeverifyd_score": 578.9
                        },
                        {
                          "sir_id": "550e8400-e29b-41d4-a716-446655440001",
                          "supplier_name": "Technology Ltd.",
                          "supplier_jurisdiction": "CN",
                          "status": "Documents Requested",
                          "tradeverifyd_score": 582.1
                        }
                      ],
                      "pagination": {
                        "current_page": 1,
                        "page_size": 20,
                        "total_pages": 1,
                        "total_records": 2
                      },
                      "sorting": [
                        "tradeverifyd_score:desc"
                      ],
                      "filters": {
                        "supplier_name": [],
                        "supplier_jurisdiction": [],
                        "status": [
                          "Documents Requested"
                        ],
                        "tradeverifyd_score": []
                      }
                    }
                  },
                  "empty_results": {
                    "summary": "No SIRs found",
                    "description": "Empty result when no supplier information requests exist for the shipment",
                    "value": {
                      "requests": [],
                      "pagination": {
                        "current_page": 1,
                        "page_size": 20,
                        "total_pages": 0,
                        "total_records": 0
                      },
                      "sorting": [],
                      "filters": {
                        "supplier_name": [],
                        "supplier_jurisdiction": [],
                        "status": [],
                        "tradeverifyd_score": []
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "no_org_units": {
                    "summary": "No organizational units",
                    "value": {
                      "detail": "User does not have any organizational units"
                    }
                  },
                  "invalid_paging": {
                    "summary": "Invalid paging parameters",
                    "value": {
                      "detail": "Invalid Paging Parameters"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipment/sirs/{sir_id}": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get supplier information request",
        "description": "Get a shipment SIR by ID",
        "operationId": "get_shipment_sir_shipment_sirs__sir_id__get",
        "parameters": [
          {
            "name": "sir_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Sir Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Detailed supplier information request",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Get Shipment Sir Shipment Sirs  Sir Id  Get",
                  "$ref": "#/components/schemas/SupplierInformationRequestDetailResponse",
                  "nullable": true
                },
                "examples": {
                  "complete_sir": {
                    "summary": "Complete SIR with all details",
                    "description": "Fully populated supplier information request with parent company and reports",
                    "value": {
                      "sir_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "shipment_id": "123e4567-e89b-12d3-a456-426614174000",
                      "supplier_name": "ACME CORP.",
                      "supplier_jurisdiction": "US",
                      "supplier_parent_name": "Wile E. Coyote Industries",
                      "supplier_parent_jurisdiction": "TW",
                      "supplier_domain": "acme.com",
                      "supplier_address": "No. 1, Main Street Fairfield, New Jersey",
                      "status": "Documents Received",
                      "tradeverifyd_score": 572.5,
                      "supplier_hs_codes": "8471,8473,8517,8542",
                      "related_parts": "Cellphone displays, circuit boards, battery modules",
                      "product": "Consumer Electronics Components",
                      "timeframe_start": "2024-01-01",
                      "timeframe_stop": "2024-12-31",
                      "reports": [
                        "TASA_2024_Q1_ACME",
                        "CPR_2024_ACME"
                      ],
                      "entity_id": "507f1f77bcf86cd799439011"
                    }
                  },
                  "minimal_sir": {
                    "summary": "Minimal SIR - Not Contacted",
                    "description": "SIR with only required fields, supplier not yet contacted",
                    "value": {
                      "sir_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440000",
                      "supplier_name": "Electronics Co., Ltd.",
                      "supplier_jurisdiction": "KR",
                      "status": "Not Contacted"
                    }
                  },
                  "documents_requested": {
                    "summary": "SIR with Documents Requested",
                    "description": "Supplier contacted, awaiting documentation",
                    "value": {
                      "sir_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440001",
                      "supplier_name": "Company Limited",
                      "supplier_jurisdiction": "CN",
                      "supplier_parent_name": "Manufacturing Co",
                      "supplier_parent_jurisdiction": "CN",
                      "supplier_domain": "company.example",
                      "supplier_address": "No.3009, BYD Road, Pingshan, Shenzhen, 518118, P.R.China",
                      "status": "Documents Requested",
                      "tradeverifyd_score": 550,
                      "supplier_hs_codes": "8507,8708,8703",
                      "related_parts": "EV batteries, battery management systems",
                      "product": "Electric Vehicle Components",
                      "timeframe_start": "2024-03-01",
                      "timeframe_stop": "2024-09-30",
                      "entity_id": "507f191e810c19729de860ea"
                    }
                  },
                  "eliminated_supplier": {
                    "summary": "Eliminated Supplier",
                    "description": "Supplier eliminated from supply chain",
                    "value": {
                      "sir_id": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440002",
                      "supplier_name": "Technologies Co., Ltd.",
                      "supplier_jurisdiction": "CN",
                      "supplier_domain": "tech.example",
                      "supplier_address": "Huawei Base, Bantian, Longgang District, Shenzhen 518129, China",
                      "status": "Eliminated",
                      "tradeverifyd_score": 500,
                      "supplier_hs_codes": "8517,8471",
                      "related_parts": "5G network equipment",
                      "product": "Telecommunications Equipment",
                      "timeframe_start": "2024-01-01",
                      "timeframe_stop": "2024-01-31",
                      "reports": [
                        "RISK_ASSESSMENT_TECH_2024"
                      ],
                      "entity_id": "507f191e810c19729de860eb"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "examples": {
                  "not_found": {
                    "summary": "SIR not found",
                    "value": {
                      "detail": "Supplier Information Request not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipment/sirs/{sir_id}/suggested_contact_info": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get supplier point of contact",
        "description": "Look up suggested contact info for a SIR",
        "operationId": "get_shipment_sir_contact_info_shipment_sirs__sir_id__suggested_contact_info_get",
        "parameters": [
          {
            "name": "sir_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Sir Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Suggested contact information for the supplier",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Get Shipment Sir Contact Info Shipment Sirs  Sir Id  Suggested Contact Info Get",
                  "$ref": "#/components/schemas/SupplierInformationSuggestedContactResponse",
                  "nullable": true
                },
                "examples": {
                  "complete_contact": {
                    "summary": "Complete contact information",
                    "description": "Full contact details with address and multiple citations",
                    "value": {
                      "info_type": "Headquarters",
                      "name": "ACME CORP.",
                      "website": "https://www.acme.example",
                      "contactPhone": "+111-1-111-1111",
                      "address": {
                        "streetAddress": "No. 66, Zhongshan Road",
                        "addressLine2": "Building A, 5th Floor",
                        "city": "Tucheng District",
                        "stateOrProvince": "New Taipei City",
                        "postalCode": "236",
                        "country": "Taiwan"
                      },
                      "citations": [
                        {
                          "source": "Bloomberg Company Profile",
                          "url": "https://www.bloomberg.example/profile/company/2317:TT"
                        },
                        {
                          "source": "Official Company Website",
                          "url": "https://www.acme.example/en-us/contact"
                        }
                      ]
                    }
                  },
                  "minimal_contact": {
                    "summary": "Minimal contact information",
                    "description": "Basic contact details without address",
                    "value": {
                      "info_type": "Sales Office",
                      "name": "ACME CORP.",
                      "website": "https://www.acme.example/us/business",
                      "contactPhone": "+1-111-111-1111",
                      "citations": [
                        {
                          "source": "ACME Business Portal",
                          "url": "https://www.acme.example/us/business/contact"
                        }
                      ]
                    }
                  },
                  "regional_office": {
                    "summary": "Regional office contact",
                    "description": "Regional office with partial address information",
                    "value": {
                      "info_type": "Regional Office - ACME",
                      "name": "ACME CORP. - South",
                      "website": "https://www.acme.example",
                      "contactPhone": "+11-111-1111-1111",
                      "address": {
                        "streetAddress": "No.3009, Acme Road",
                        "city": "Fairfield",
                        "stateOrProvince": "New Jersey",
                        "postalCode": "07004",
                        "country": "United States"
                      },
                      "citations": [
                        {
                          "source": "ACME Corporate Directory",
                          "url": "https://www.acme.example/en/contact.html"
                        }
                      ]
                    }
                  },
                  "no_contact_found": {
                    "summary": "No contact information available",
                    "description": "Empty response when no contact info is found"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "examples": {
                  "sir_not_found": {
                    "summary": "SIR not found",
                    "value": {
                      "detail": "Supplier Information Request not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipment/sirs/{sir_id}/status": {
      "post": {
        "tags": [
          "Shipments"
        ],
        "summary": "Update supplier information request status",
        "description": "Update the status of a shipment SIR by ID",
        "operationId": "update_shipment_sir_status_shipment_sirs__sir_id__status_post",
        "parameters": [
          {
            "name": "sir_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Sir Id"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Body_update_shipment_sir_status_shipment_sirs__sir_id__status_post"
              },
              "examples": {
                "not_contacted": {
                  "summary": "Set status to Not Contacted",
                  "value": {
                    "status": "Not Contacted"
                  }
                },
                "documents_requested": {
                  "summary": "Set status to Documents Requested",
                  "value": {
                    "status": "Documents Requested"
                  }
                },
                "documents_received": {
                  "summary": "Set status to Documents Received",
                  "value": {
                    "status": "Documents Received"
                  }
                },
                "eliminated": {
                  "summary": "Set status to Eliminated",
                  "value": {
                    "status": "Eliminated"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully updated SIR status",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Update Shipment Sir Status Shipment Sirs  Sir Id  Status Post",
                  "$ref": "#/components/schemas/SupplierInformationRequestDetailResponse",
                  "nullable": true
                },
                "examples": {
                  "status_to_documents_requested": {
                    "summary": "Status updated to Documents Requested",
                    "description": "SIR status changed from Not Contacted to Documents Requested",
                    "value": {
                      "sir_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "shipment_id": "123e4567-e89b-12d3-a456-426614174000",
                      "supplier_name": "ACME CORP.",
                      "supplier_jurisdiction": "US",
                      "supplier_parent_name": "Wile E. Coyote, Ltd.",
                      "supplier_parent_jurisdiction": "US",
                      "supplier_domain": "acme.example",
                      "supplier_address": "No. 1, Main Street, Fairfield, New Jersey",
                      "status": "Documents Requested",
                      "tradeverifyd_score": 550,
                      "supplier_hs_codes": "8471,8473,8517,8542",
                      "related_parts": "Cellphone displays, circuit boards, battery modules",
                      "product": "Consumer Electronics Components",
                      "timeframe_start": "2024-01-01",
                      "timeframe_stop": "2024-12-31",
                      "entity_id": "507f1f77bcf86cd799439011"
                    }
                  },
                  "status_to_documents_received": {
                    "summary": "Status updated to Documents Received",
                    "description": "SIR status changed from Documents Requested to Documents Received",
                    "value": {
                      "sir_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440000",
                      "supplier_name": "ACME CORP.",
                      "supplier_jurisdiction": "US",
                      "supplier_parent_name": "Wile E. Coyote, Ltd.",
                      "supplier_parent_jurisdiction": "US",
                      "supplier_domain": "acme.example",
                      "supplier_address": "No. 1, Main Street, Fairfield, New Jersey",
                      "status": "Documents Received",
                      "tradeverifyd_score": 650,
                      "supplier_hs_codes": "8542,8473,8517",
                      "related_parts": "Memory chips, display panels, processors",
                      "product": "Semiconductor Components",
                      "timeframe_start": "2024-02-01",
                      "timeframe_stop": "2024-11-30",
                      "reports": [
                        "TASA_2024_Q2_ACME"
                      ],
                      "entity_id": "507f191e810c19729de860ea"
                    }
                  },
                  "status_to_eliminated": {
                    "summary": "Status updated to Eliminated",
                    "description": "SIR status changed to Eliminated due to high risk score",
                    "value": {
                      "sir_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440001",
                      "supplier_name": "Wile E. Coyote, Ltd.",
                      "supplier_jurisdiction": "US",
                      "supplier_domain": "wile.example",
                      "supplier_address": "1234 San Antonio St., Austin 78705, Texas",
                      "status": "Eliminated",
                      "tradeverifyd_score": 250,
                      "supplier_hs_codes": "8517,8471",
                      "related_parts": "5G network equipment",
                      "product": "Telecommunications Equipment",
                      "timeframe_start": "2024-01-01",
                      "timeframe_stop": "2024-01-31",
                      "reports": [
                        "RISK_ASSESSMENT_WILE_2024"
                      ],
                      "entity_id": "507f191e810c19729de860eb"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "invalid_status": {
                    "summary": "Invalid status value",
                    "value": {
                      "detail": "Invalid status value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "examples": {
                  "sir_not_found": {
                    "summary": "SIR not found",
                    "value": {
                      "detail": "Supplier Information Request not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipment/{shipment_id}/upload": {
      "post": {
        "tags": [
          "Shipments"
        ],
        "summary": "Upload a document to a shipment",
        "description": "Upload a single file to a shipment folder in cloud storage. Only single file uploads are supported. Files can be organized into subdirectories using the path parameter.",
        "operationId": "upload_shipment_file_shipment__shipment_id__upload_post",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Shipment Id"
            }
          },
          {
            "name": "path",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Path to upload the file to within the shipment folder for example 'Products/1234'",
              "title": "Path",
              "type": "string",
              "nullable": true
            },
            "description": "Path to upload the file to within the shipment folder for example 'Products/1234'"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/Body_upload_shipment_file_shipment__shipment_id__upload_post"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "File uploaded successfully",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Upload Shipment File Shipment  Shipment Id  Upload Post",
                  "$ref": "#/components/schemas/ShipmentUploadResponse",
                  "nullable": true
                },
                "examples": {
                  "pdf_invoice_upload": {
                    "summary": "PDF Invoice Upload",
                    "description": "Successfully uploaded commercial invoice PDF to shipment",
                    "value": {
                      "success": true,
                      "shipment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "url": "Not downloadable",
                      "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
                    }
                  },
                  "excel_packing_list": {
                    "summary": "Excel Packing List Upload",
                    "description": "Successfully uploaded packing list to Documents subfolder",
                    "value": {
                      "success": true,
                      "shipment_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
                      "url": "Not downloadable",
                      "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
                    }
                  },
                  "certificate_upload": {
                    "summary": "Certificate Upload",
                    "description": "Successfully uploaded certificate of origin to Certificates folder",
                    "value": {
                      "success": true,
                      "shipment_id": "550e8400-e29b-41d4-a716-446655440000",
                      "url": "Not downloadable",
                      "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "multiple_files": {
                    "summary": "Multiple files not supported",
                    "value": {
                      "detail": "Multiple file uploads are not supported."
                    }
                  },
                  "no_filename": {
                    "summary": "Missing filename",
                    "value": {
                      "detail": "No filename specified."
                    }
                  },
                  "invalid_session": {
                    "summary": "Invalid session",
                    "value": {
                      "detail": "Invalid session."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "examples": {
                  "no_organization": {
                    "summary": "No organization for user",
                    "value": {
                      "detail": "No organization for user."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "examples": {
                  "shipment_not_found": {
                    "summary": "Shipment not found",
                    "value": {
                      "detail": "Shipment not found."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipments/{shipment_id}/cbps": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get CBP Requests for Shipment",
        "description": "Get a list of CBP requests for a shipment.",
        "operationId": "get_cbp_requests_for_shipment_shipments__shipment_id__cbps_get",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Shipment Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CBPRequestListing"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/shipments/{shipment_id}/cbps/{vc_id}": {
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get CBP Requests for Shipment and VC",
        "description": "Get a list of CBP requests for a specific VC in a shipment.",
        "operationId": "get_cbp_requests_for_shipment_and_vc_shipments__shipment_id__cbps__vc_id__get",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Shipment Id"
            }
          },
          {
            "name": "vc_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Vc Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CBPRequestListing"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/file/upload": {
      "post": {
        "tags": [
          "Documents"
        ],
        "summary": "Upload a file",
        "description": "Uploads a file to a specific folder within your organization.",
        "operationId": "upload_file_file_upload_post",
        "parameters": [
          {
            "name": "path",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Path"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/Body_upload_file_file_upload_post"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "File uploaded successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileUploadResponse"
                },
                "examples": {
                  "successful_upload": {
                    "summary": "Successful file upload",
                    "description": "File was successfully uploaded to the specified path",
                    "value": {
                      "success": true,
                      "url": "https://storage.tradeverifyd.example/org123/documents/invoice-2024-001.pdf"
                    }
                  },
                  "upload_with_subdirectory": {
                    "summary": "Upload to subdirectory",
                    "description": "File uploaded to a nested directory structure",
                    "value": {
                      "success": true,
                      "url": "https://storage.tradeverifyd.example/org123/compliance/2024/certificate-of-origin.pdf"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Organization not found",
            "content": {
              "application/json": {
                "examples": {
                  "no_organization": {
                    "summary": "No organization for user",
                    "value": {
                      "detail": "No organization for user."
                    }
                  },
                  "organization_not_found": {
                    "summary": "Organization not found",
                    "value": {
                      "detail": "Organization not found."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/us_customs/submit_presentation": {
      "post": {
        "tags": [
          "US Customs"
        ],
        "summary": "Submit Verifiable Presentation",
        "description": "Submit a presentation to US Customs.\n\nRequest body:\n    credential_ids: A list of credential ids to submit to US Customs.\n\nReturns:\n    A response from submitting a presentation to US Customs.",
        "operationId": "submit_verifiable_presentation_us_customs_submit_presentation_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubmitPresentationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubmitPresentationResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/issue": {
      "post": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Issue credential",
        "description": "Issues W3C Traceability compliant verifiable credentials for trade documents. IntentToImport (ITI) credentials are restricted to one per shipment to prevent duplicates. All credentials are encoded in Base64 and stored with the associated shipment.",
        "operationId": "issue_vc_credentials_issue_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestIssueVerifiableCredential"
              },
              "examples": {
                "intent_to_import": {
                  "summary": "Intent to Import (ITI) Credential",
                  "description": "Full ITI credential for CBP submission with consignee, consignor, commodities, port of entry, vessel, and container details",
                  "value": {
                    "@context": [
                      "https://www.w3.org/2018/credentials/v1",
                      "https://w3id.org/traceability/v1"
                    ],
                    "type": [
                      "VerifiableCredential",
                      "IntentToImportCredential"
                    ],
                    "issuer": "urn:uuid:organization-123",
                    "shipment_id": "SHIP-2024-001234",
                    "credentialSubject": {
                      "id": "urn:uuid:shipment-2024-001234",
                      "consignee": {
                        "type": [
                          "Organization"
                        ],
                        "name": "ACME Corporation",
                        "address": {
                          "type": [
                            "PostalAddress"
                          ],
                          "streetAddress": "123 Main Street",
                          "addressLocality": "New York",
                          "addressRegion": "NY",
                          "postalCode": "10001",
                          "addressCountry": "US"
                        },
                        "identifier": {
                          "type": [
                            "Identifier"
                          ],
                          "identifierType": "EIN",
                          "identifierValue": "12-3456789"
                        }
                      },
                      "consignor": {
                        "type": [
                          "Organization"
                        ],
                        "name": "Global Exporters Inc",
                        "address": {
                          "type": [
                            "PostalAddress"
                          ],
                          "streetAddress": "456 Harbor Road",
                          "addressLocality": "Shanghai",
                          "addressRegion": "SH",
                          "postalCode": "200080",
                          "addressCountry": "CN"
                        },
                        "identifier": {
                          "type": [
                            "Identifier"
                          ],
                          "identifierType": "CompanyRegistration",
                          "identifierValue": "CN123456789"
                        }
                      },
                      "commodities": [
                        {
                          "type": [
                            "Commodity"
                          ],
                          "description": "Hot-rolled steel coils",
                          "commodityCode": "7208.51",
                          "commodityCodeType": "HTS",
                          "quantity": 100,
                          "quantityUnit": "MT",
                          "value": {
                            "type": [
                              "MonetaryAmount"
                            ],
                            "value": 50000,
                            "currency": "USD"
                          }
                        },
                        {
                          "type": [
                            "Commodity"
                          ],
                          "description": "Aluminum sheets",
                          "commodityCode": "7606.11",
                          "commodityCodeType": "HTS",
                          "quantity": 50,
                          "quantityUnit": "MT",
                          "value": {
                            "type": [
                              "MonetaryAmount"
                            ],
                            "value": 25000,
                            "currency": "USD"
                          }
                        }
                      ],
                      "portOfEntry": {
                        "type": [
                          "Place"
                        ],
                        "unLocode": "USLAX",
                        "name": "Port of Los Angeles"
                      },
                      "estimatedArrivalDate": "2024-03-15T00:00:00Z",
                      "vesselName": "COSCO Shipping Pacific",
                      "voyageNumber": "PAC2024-123",
                      "containerNumbers": [
                        "TCLU1234567",
                        "TCLU7654321",
                        "TCLU9876543"
                      ]
                    }
                  }
                },
                "bill_of_lading": {
                  "summary": "Bill of Lading Credential",
                  "description": "Digital Bill of Lading following W3C Traceability standards for ocean freight",
                  "value": {
                    "@context": [
                      "https://www.w3.org/2018/credentials/v1",
                      "https://w3id.org/traceability/v1"
                    ],
                    "type": [
                      "VerifiableCredential",
                      "BillOfLadingCredential"
                    ],
                    "issuer": "urn:uuid:organization-123",
                    "shipment_id": "SHIP-2024-005678",
                    "credentialSubject": {
                      "id": "urn:uuid:bol-2024-005678",
                      "billOfLadingNumber": "MAEU2024005678",
                      "carrier": {
                        "type": [
                          "Organization"
                        ],
                        "name": "Maersk Line",
                        "identifier": {
                          "type": [
                            "Identifier"
                          ],
                          "identifierType": "SCAC",
                          "identifierValue": "MAEU"
                        }
                      },
                      "shipper": {
                        "type": [
                          "Organization"
                        ],
                        "name": "European Exports GmbH",
                        "address": {
                          "type": [
                            "PostalAddress"
                          ],
                          "streetAddress": "789 Port Avenue",
                          "addressLocality": "Hamburg",
                          "postalCode": "20457",
                          "addressCountry": "DE"
                        }
                      },
                      "consignee": {
                        "type": [
                          "Organization"
                        ],
                        "name": "West Coast Imports LLC",
                        "address": {
                          "type": [
                            "PostalAddress"
                          ],
                          "streetAddress": "321 Ocean Boulevard",
                          "addressLocality": "Los Angeles",
                          "addressRegion": "CA",
                          "postalCode": "90012",
                          "addressCountry": "US"
                        }
                      },
                      "notifyParty": {
                        "type": [
                          "Organization"
                        ],
                        "name": "Logistics Solutions Inc",
                        "contactPoint": {
                          "type": [
                            "ContactPoint"
                          ],
                          "telephone": "+1-310-555-0100",
                          "email": "notify@logistics-solutions.example"
                        }
                      },
                      "portOfLoading": {
                        "type": [
                          "Place"
                        ],
                        "unLocode": "DEHAM",
                        "name": "Port of Hamburg"
                      },
                      "portOfDischarge": {
                        "type": [
                          "Place"
                        ],
                        "unLocode": "USLAX",
                        "name": "Port of Los Angeles"
                      },
                      "dateOfShipment": "2024-02-01T00:00:00Z",
                      "containers": [
                        {
                          "type": [
                            "Container"
                          ],
                          "containerNumber": "MSKU1234567",
                          "sealNumber": "SEAL123456",
                          "containerType": "40HC",
                          "packages": 500,
                          "grossWeight": {
                            "type": [
                              "QuantitativeValue"
                            ],
                            "value": 24000,
                            "unitCode": "KGM"
                          }
                        }
                      ],
                      "freightCharges": {
                        "type": [
                          "MonetaryAmount"
                        ],
                        "value": 3500,
                        "currency": "USD"
                      },
                      "freightPaymentTerms": "Prepaid"
                    }
                  }
                },
                "custom_credential": {
                  "summary": "Custom Trade Credential",
                  "description": "Generic trade document credential structure (e.g., Certificate of Origin)",
                  "value": {
                    "@context": [
                      "https://www.w3.org/2018/credentials/v1",
                      "https://w3id.org/traceability/v1"
                    ],
                    "type": [
                      "VerifiableCredential",
                      "CertificateOfOriginCredential"
                    ],
                    "issuer": "urn:uuid:organization-123",
                    "shipment_id": "SHIP-2024-009012",
                    "credentialSubject": {
                      "id": "urn:uuid:coo-2024-009012",
                      "certificateNumber": "COO-2024-009012",
                      "exporter": {
                        "type": [
                          "Organization"
                        ],
                        "name": "Manufacturing Co Ltd",
                        "address": {
                          "type": [
                            "PostalAddress"
                          ],
                          "streetAddress": "100 Industrial Park",
                          "addressLocality": "Seoul",
                          "postalCode": "04527",
                          "addressCountry": "KR"
                        }
                      },
                      "importer": {
                        "type": [
                          "Organization"
                        ],
                        "name": "Tech Imports Inc",
                        "address": {
                          "type": [
                            "PostalAddress"
                          ],
                          "streetAddress": "555 Tech Plaza",
                          "addressLocality": "San Francisco",
                          "addressRegion": "CA",
                          "postalCode": "94105",
                          "addressCountry": "US"
                        }
                      },
                      "goods": [
                        {
                          "type": [
                            "Product"
                          ],
                          "description": "Electronic components",
                          "harmonizedSystemCode": "8541.40",
                          "originCountry": "KR",
                          "quantity": {
                            "type": [
                              "QuantitativeValue"
                            ],
                            "value": 10000,
                            "unitCode": "EA"
                          }
                        }
                      ],
                      "dateOfIssuance": "2024-02-10T00:00:00Z",
                      "certificationBody": {
                        "type": [
                          "Organization"
                        ],
                        "name": "Korea Chamber of Commerce"
                      }
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successfully issued verifiable credential",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuedVerifiableCredentialResponse"
                },
                "examples": {
                  "iti_credential": {
                    "summary": "Intent to Import (ITI) Credential Response",
                    "description": "Response after successfully issuing an Intent to Import credential for CBP submission",
                    "value": {
                      "credential_id": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
                      "credential_media_type": "application/ld+json",
                      "credential_content": "eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vdzNpZC5vcmcvdHJhY2VhYmlsaXR5L3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJbnRlbnRUb0ltcG9ydENyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46dXVpZDpzaGlwbWVudC0yMDI0LTAwMTIzNCIsImNvbnNpZ25lZSI6eyJuYW1lIjoiQUNNRSBDB3Jwb3JhdGlvbiIsImFkZHJlc3MiOnsic3RyZWV0QWRkcmVzcyI6IjEyMyBNYWluIFN0cmVldCIsImFkZHJlc3NMb2NhbGl0eSI6Ik5ldyBZb3JrIiwiYWRkcmVzc1JlZ2lvbiI6Ik5ZIiwicG9zdGFsQ29kZSI6IjEwMDAxIiwiYWRkcmVzc0NvdW50cnkiOiJVUyJ9fSwiY29uc2lnbm9yIjp7Im5hbWUiOiJHbG9iYWwgRXhwb3J0ZXJzIEluYyIsImFkZHJlc3MiOnsic3RyZWV0QWRkcmVzcyI6IjQ1NiBIYXJib3IgUm9hZCIsImFkZHJlc3NMb2NhbGl0eSI6IlNoYW5naGFpIiwiYWRkcmVzc1JlZ2lvbiI6IlNIIiwicG9zdGFsQ29kZSI6IjIwMDA4MCIsImFkZHJlc3NDb3VudHJ5IjoiQ04ifX0sImNvbW1vZGl0aWVzIjpbeyJkZXNjcmlwdGlvbiI6IkhvdC1yb2xsZWQgc3RlZWwgY29pbHMiLCJjb21tb2RpdHlDb2RlIjoiNzIwOC41MSIsInF1YW50aXR5IjoxMDAsInF1YW50aXR5VW5pdCI6Ik1UIiwidmFsdWUiOjUwMDAwLCJjdXJyZW5jeSI6IlVTRCJ9XSwicG9ydE9mRW50cnkiOiJVU0xBWCIsImVzdGltYXRlZEFycml2YWxEYXRlIjoiMjAyNC0wMy0xNVQwMDowMDowMFoiLCJ2ZXNzZWxOYW1lIjoiQ09TQ08gU2hpcHBpbmcgUGFjaWZpYyIsImNvbnRhaW5lck51bWJlcnMiOlsiVENMVTEyMzQ1NjciLCJUQ0xVNzY1NDMyMSJdfSwiaXNzdWVyIjoidXJuOnV1aWQ6b3JnYW5pemF0aW9uLTEyMyIsImlkIjoidXJuOnV1aWQ6MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAwIiwiaXNzdWFuY2VEYXRlIjoiMjAyNC0wMi0xNVQxMDozMDowMFoifQ=="
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "missing_shipment": {
                    "summary": "Missing Shipment ID",
                    "value": {
                      "detail": "Shipment ID is required"
                    }
                  },
                  "duplicate_iti": {
                    "summary": "Duplicate ITI Credential",
                    "value": {
                      "detail": "IntentToImport credential already exists for shipment SHIP-2024-001234"
                    }
                  },
                  "invalid_structure": {
                    "summary": "Invalid Credential Structure",
                    "value": {
                      "detail": "Invalid credential structure: missing required field 'credentialSubject'"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/list": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "List credentials",
        "description": "List verifiable credentials for the organization.",
        "operationId": "get_organization_verifiable_credentials_credentials_list_get",
        "responses": {
          "200": {
            "description": "List of verifiable credentials for the organization",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/CredentialListItem"
                  },
                  "type": "array",
                  "title": "Response Get Organization Verifiable Credentials Credentials List Get"
                },
                "examples": {
                  "multiple_credentials": {
                    "summary": "Multiple verifiable credentials",
                    "description": "Organization with various types of verifiable credentials including ITI and Bill of Lading",
                    "value": [
                      {
                        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "media_type": "application/vc+jwt",
                        "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Z3hhMTIzNDU2Nzg5MCIsImlhdCI6MTcxMDQ5ODYwMCwiZXhwIjoxNzQyMDM0NjAwLCJuYmYiOjE3MTA0OTg2MDAsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUifX19.SIGNATURE_PLACEHOLDER",
                        "last_validation": {
                          "is_valid": true,
                          "is_verified": true,
                          "last_verified": "2024-03-15T10:30:00Z",
                          "credential_status": {
                            "status": "active"
                          },
                          "valid_from": "2024-03-15T00:00:00Z",
                          "valid_until": "2025-03-15T00:00:00Z"
                        }
                      },
                      {
                        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
                        "media_type": "application/vc+jwt",
                        "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6aW52b2ljZToxMjM0NTY3ODkwIiwiaWF0IjoxNzEwNDk4NjAwLCJleHAiOjE3NDIwMzQ2MDAsIm5iZiI6MTcxMDQ5ODYwMCwidmMiOnsiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiLCJodHRwczovL29yLXRyYWNlYWJpbGl0eS5vcmcvdjEiXSwidHlwZSI6WyJWZXJpZmlhYmxlQ3JlZGVudGlhbCIsIkJpbGxPZkxhZGluZ0NyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46aW90Omludm9pY2U6MTIzNDU2Nzg5MCIsInR5cGUiOiJCaWxsT2ZMYWRpbmciLCJzaGlwbWVudF9pZCI6IlNISVAtMjAyNC0wMDE1In19fQ.SIGNATURE_PLACEHOLDER",
                        "last_validation": {
                          "is_valid": true,
                          "is_verified": false,
                          "last_verified": "2024-03-14T15:20:00Z",
                          "credential_status": {
                            "status": "active"
                          },
                          "valid_from": "2024-03-14T00:00:00Z",
                          "valid_until": "2025-03-14T00:00:00Z"
                        }
                      },
                      {
                        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d481",
                        "media_type": "application/vc+jwt",
                        "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Y29vOjEyMzQ1Njc4OTAiLCJpYXQiOjE3MTA0OTg2MDAsImV4cCI6MTc0MjAzNDYwMCwibmJmIjoxNzEwNDk4NjAwLCJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vb3ItdHJhY2VhYmlsaXR5Lm9yZy92MSJdLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiQ2VydGlmaWNhdGVPZk9yaWdpbkNyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46aW90OmNvbzoxMjM0NTY3ODkwIiwidHlwZSI6IkNlcnRpZmljYXRlT2ZPcmlnaW4iLCJjb3VudHJ5X29mX29yaWdpbiI6IkNOIn19fQ.SIGNATURE_PLACEHOLDER"
                      }
                    ]
                  },
                  "single_credential": {
                    "summary": "Single credential",
                    "description": "Organization with only one verifiable credential",
                    "value": [
                      {
                        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d482",
                        "media_type": "application/vc+jwt",
                        "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGE5ODc2NTQzMjEiLCJ0eXBlIjoiSVRJIiwic2hpcG1lbnRfaWQiOiJTSElQLTIwMjQtMDAyMyJ9fX0.mF2qN9vX7rK8eP4wT1sH6jQ3bY8cV5zL9nR2gU3dA7f",
                        "last_validation": {
                          "is_valid": true,
                          "is_verified": true,
                          "last_verified": "2024-03-16T08:45:00Z",
                          "credential_status": {
                            "status": "active"
                          },
                          "valid_from": "2024-03-16T00:00:00Z",
                          "valid_until": "2025-03-16T00:00:00Z"
                        }
                      }
                    ]
                  },
                  "empty_list": {
                    "summary": "No credentials",
                    "description": "Organization with no verifiable credentials",
                    "value": []
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/list/shipment/{shipment_id}": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "List credentials by shipment",
        "description": "List verifiable credentials for a specific shipment.",
        "operationId": "get_shipment_verifiable_credentials_credentials_list_shipment__shipment_id__get",
        "parameters": [
          {
            "name": "shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The shipment ID to filter credentials by",
              "title": "Shipment Id"
            },
            "description": "The shipment ID to filter credentials by"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CredentialListItem"
                  },
                  "title": "Response Get Shipment Verifiable Credentials Credentials List Shipment  Shipment Id  Get"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/details/{verifiable_credential_id}": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Get credential details",
        "description": "Get detailed information about a specific verifiable credential for the organization",
        "operationId": "get_organization_verifiable_credential_details_credentials_details__verifiable_credential_id__get",
        "parameters": [
          {
            "name": "verifiable_credential_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Verifiable Credential Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Credential details retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Get Organization Verifiable Credential Details Credentials Details  Verifiable Credential Id  Get",
                  "$ref": "#/components/schemas/CredentialListItem",
                  "nullable": true
                },
                "examples": {
                  "iti_credential": {
                    "summary": "ITI Credential Details",
                    "description": "Intent To Import credential with complete validation information",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUiLCJjdXN0b21zX2VudHJ5X251bWJlciI6IkVOLTIwMjQtMDAwMTUiLCJpbXBvcnRlciI6eyJuYW1lIjoiVGVjaENvcnAgSW5jLiIsImFkZHJlc3MiOiIxMjMgTWFpbiBTdCwgTmV3IFlvcmssIE5ZIDI5OTAyIn0sInByb2R1Y3RzIjpbeyJkZXNjcmlwdGlvbiI6IkVsZWN0cm9uaWMgY29tcG9uZW50cyIsImhzX2NvZGUiOiI4NTQyLjMxIn1dfX19.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
                      "last_validation": {
                        "is_valid": true,
                        "is_verified": true,
                        "last_verified": "2024-03-15T10:30:00Z",
                        "credential_status": {
                          "status": "active"
                        },
                        "valid_from": "2024-03-15T00:00:00Z",
                        "valid_until": "2025-03-15T00:00:00Z"
                      }
                    }
                  },
                  "bill_of_lading": {
                    "summary": "Bill of Lading Credential",
                    "description": "Bill of Lading credential for international shipment with carrier verification",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJCaWxsT2ZMYWRpbmdDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDppbnZvaWNlOjEyMzQ1Njc4OTAiLCJ0eXBlIjoiQmlsbE9mTGFkaW5nIiwic2hpcG1lbnRfaWQiOiJTSElQLTIwMjQtMDAxNSIsImNhcnJpZXIiOiJNYWVyc2sgTGluZSIsImRlcGFydHVyZV9wb3J0IjoiUG9ydCBvZiBTaGFuZ2hhaSIsImFycml2YWxfcG9ydCI6IlBvcnQgb2YgTG9zIEFuZ2VsZXMifX19.vSR4hTM6vvQJHgKhJfmZQpF8fP-5u1RaP3qHxVpZ2g8",
                      "last_validation": {
                        "is_valid": true,
                        "is_verified": false,
                        "last_verified": "2024-03-14T15:20:00Z",
                        "credential_status": {
                          "status": "active"
                        },
                        "valid_from": "2024-03-14T00:00:00Z",
                        "valid_until": "2025-03-14T00:00:00Z"
                      }
                    }
                  },
                  "certificate_of_origin": {
                    "summary": "Certificate of Origin",
                    "description": "Certificate of Origin for goods manufactured in Korea with chamber attestation",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d481",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJDZXJ0aWZpY2F0ZU9mT3JpZ2luQ3JlZGVudGlhbCJdLCJjcmVkZW50aWFsU3ViamVjdCI6eyJpZCI6InVybjppb3Q6aW52b2ljZToxMjM0NTY3ODkwIiwidHlwZSI6IkNlcnRpZmljYXRlT2ZPcmlnaW4iLCJzaGlwbWVudF9pZCI6IlNISVAtMjAyNC0wMDE1IiwiY291bnRyeV9vZl9vcmlnaW4iOiJLUiIsIm1hbnVmYWN0dXJlciI6IlNhbXN1bmcgRWxlY3Ryb25pY3MiLCJhdHRlc3RhdGlvbiI6eyJpc3N1ZXIiOiJLb3JlYSBDaGFtYmVyIG9mIENvbW1lcmNlIiwiZGF0ZSI6IjIwMjQtMDMtMTQifX19.xZ8N6qV2rF4hDwP9cT7eM8sK1bJ5gXyU0wH3nLvE9pQ",
                      "last_validation": {
                        "is_valid": false,
                        "is_verified": true,
                        "last_verified": "2024-03-13T09:45:00Z",
                        "credential_status": {
                          "status": "expired"
                        },
                        "valid_from": "2024-03-13T00:00:00Z",
                        "valid_until": "2024-03-13T23:59:59Z"
                      }
                    }
                  },
                  "invalid_credential": {
                    "summary": "Invalid Credential",
                    "description": "Credential that failed validation due to signature issues",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d482",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Z3hhMTIzNDU2Nzg5MCIsImlhdCI6MTcxMDQ5ODYwMCwiZXhwIjoxNzQyMDM0NjAwLCJuYmYiOjE3MTA0OTg2MDAsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUifX19.INVALID_SIGNATURE",
                      "last_validation": {
                        "is_valid": false,
                        "is_verified": false,
                        "last_verified": "2024-03-12T14:30:00Z",
                        "credential_status": {
                          "status": "revoked"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Credential not found",
            "content": {
              "application/json": {
                "examples": {
                  "not_found": {
                    "summary": "Credential does not exist",
                    "value": {
                      "detail": "Credential not found."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/details/{verifiable_credential_id}/pdf": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Get credential formatted as PDF",
        "description": "Formatted PDF of a verifiable credential",
        "operationId": "get_organization_verifiable_credential_details_pdf_credentials_details__verifiable_credential_id__pdf_get",
        "parameters": [
          {
            "name": "verifiable_credential_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the verifiable credential to retrieve.",
              "title": "Verifiable Credential Id"
            },
            "description": "The ID of the verifiable credential to retrieve."
          }
        ],
        "responses": {
          "200": {
            "description": "PDF document",
            "content": {
              "application/pdf": {}
            }
          },
          "404": {
            "description": "Credential not found"
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/validation/{verifiable_credential_id}": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Validate credential",
        "description": "Verifies the digital siganture, validates the credential schema, checks the credential status and stores the result.",
        "operationId": "get_vc_validation_credentials_validation__verifiable_credential_id__get",
        "parameters": [
          {
            "name": "verifiable_credential_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "title": "Verifiable Credential Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Credential validation results",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CredentialListItem"
                },
                "examples": {
                  "valid_iti_credential": {
                    "summary": "Valid ITI credential with successful validation",
                    "description": "Intent To Import credential that passed all validation checks including signature verification, schema validation, and status checks",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Z3hhMTIzNDU2Nzg5MCIsImlhdCI6MTcxMDQ5ODYwMCwiZXhwIjoxNzQyMDM0NjAwLCJuYmYiOjE3MTA0OTg2MDAsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUifX19.SIGNATURE_PLACEHOLDER",
                      "last_validation": {
                        "is_valid": true,
                        "is_verified": true,
                        "last_verified": "2024-03-15T10:30:00Z",
                        "signature_valid": true,
                        "schema_valid": true,
                        "status_valid": true,
                        "valid_until": "2025-03-15T00:00:00Z"
                      }
                    }
                  },
                  "invalid_signature": {
                    "summary": "Invalid credential with signature failure",
                    "description": "Credential that failed digital signature verification during validation process",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d482",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Z3hhMTIzNDU2Nzg5MCIsImlhdCI6MTcxMDQ5ODYwMCwiZXhwIjoxNzQyMDM0NjAwLCJuYmYiOjE3MTA0OTg2MDAsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUifX19.INVALID_SIGNATURE",
                      "last_validation": {
                        "is_valid": false,
                        "is_verified": false,
                        "last_verified": "2024-03-12T14:30:00Z",
                        "signature_valid": false,
                        "schema_valid": true,
                        "status_valid": true,
                        "error_message": "Digital signature verification failed",
                        "valid_until": "2025-03-12T00:00:00Z"
                      }
                    }
                  },
                  "schema_validation_failed": {
                    "summary": "Schema validation failure",
                    "description": "Credential with valid signature but schema validation errors",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d483",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Y29vOjEyMzQ1Njc4OTAiLCJpYXQiOjE3MTA0OTg2MDAsImV4cCI6MTc0MjAzNDYwMCwibmJmIjoxNzEwNDk4NjAwLCJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vb3ItdHJhY2VhYmlsaXR5Lm9yZy92MSJdLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiSW52b2ljZUNyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46aW90OmNvbzoxMjM0NTY3ODkwIn19fQ.SIGNATURE_PLACEHOLDER",
                      "last_validation": {
                        "is_valid": false,
                        "is_verified": true,
                        "last_verified": "2024-03-13T09:45:00Z",
                        "signature_valid": true,
                        "schema_valid": false,
                        "status_valid": true,
                        "error_message": "Required field 'type' missing from credentialSubject",
                        "valid_until": "2025-03-13T00:00:00Z"
                      }
                    }
                  },
                  "no_validation_performed": {
                    "summary": "Credential not yet validated",
                    "description": "Credential exists but validation has not been performed yet",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d484",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6aW52b2ljZToxMjM0NTY3ODkwIiwiaWF0IjoxNzEwNDk4NjAwLCJleHAiOjE3NDIwMzQ2MDAsIm5iZiI6MTcxMDQ5ODYwMCwidmMiOnsiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiLCJodHRwczovL29yLXRyYWNlYWJpbGl0eS5vcmcvdjEiXSwidHlwZSI6WyJWZXJpZmlhYmxlQ3JlZGVudGlhbCIsIkJpbGxPZkxhZGluZ0NyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46aW90Omludm9pY2U6MTIzNDU2Nzg5MCIsInR5cGUiOiJCaWxsT2ZMYWRpbmciLCJzaGlwbWVudF9pZCI6IlNISVAtMjAyNC0wMDQ3In19fQ.SIGNATURE_PLACEHOLDER"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Credential not found",
            "content": {
              "application/json": {
                "examples": {
                  "credential_not_found": {
                    "summary": "Credential not found",
                    "value": {
                      "detail": "Verifiable credential not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/document/validation/{document_path}": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Validate document",
        "description": "Verifies the digital signature, validates the credential schema, checks the credential status and stores the result.",
        "operationId": "get_document_validation_credentials_document_validation__document_path__get",
        "parameters": [
          {
            "name": "document_path",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The path to the document to validate",
              "title": "Document Path"
            },
            "description": "The path to the document to validate"
          }
        ],
        "responses": {
          "200": {
            "description": "Document validation results",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CredentialListItem"
                },
                "examples": {
                  "pdf_bill_of_lading_valid": {
                    "summary": "Valid PDF Bill of Lading document",
                    "description": "PDF document containing a Bill of Lading that passed validation including digital signature verification and schema compliance",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d485",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6aW52b2ljZToxMjM0NTY3ODkwIiwiaWF0IjoxNzEwNDk4NjAwLCJleHAiOjE3NDIwMzQ2MDAsIm5iZiI6MTcxMDQ5ODYwMCwidmMiOnsiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiLCJodHRwczovL29yLXRyYWNlYWJpbGl0eS5vcmcvdjEiXSwidHlwZSI6WyJWZXJpZmlhYmxlQ3JlZGVudGlhbCIsIkJpbGxPZkxhZGluZ0NyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46aW90Omludm9pY2U6MTIzNDU2Nzg5MCIsInR5cGUiOiJCaWxsT2ZMYWRpbmciLCJzaGlwbWVudF9pZCI6IlNISVAtMjAyNC0wMDQ3In19fQ.SIGNATURE_PLACEHOLDER",
                      "last_validation": {
                        "is_valid": true,
                        "is_verified": true,
                        "last_verified": "2024-03-16T14:22:00Z",
                        "signature_valid": true,
                        "schema_valid": true,
                        "status_valid": true,
                        "document_format": "PDF",
                        "extracted_credential": true,
                        "valid_until": "2025-03-16T00:00:00Z"
                      }
                    }
                  },
                  "json_certificate_origin_valid": {
                    "summary": "Valid JSON Certificate of Origin",
                    "description": "JSON document with embedded Certificate of Origin credential that passed all validation checks",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d486",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Y29vOjEyMzQ1Njc4OTAiLCJpYXQiOjE3MTA0OTg2MDAsImV4cCI6MTc0MjAzNDYwMCwibmJmIjoxNzEwNDk4NjAwLCJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vb3ItdHJhY2VhYmlsaXR5Lm9yZy92MSJdLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiQ2VydGlmaWNhdGVPZk9yaWdpbkNyZWRlbnRpYWwiXSwiY3JlZGVudGlhbFN1YmplY3QiOnsiaWQiOiJ1cm46aW90OmNvbzoxMjM0NTY3ODkwIiwidHlwZSI6IkNlcnRpZmljYXRlT2ZPcmlnaW4iLCJjb3VudHJ5X29mX29yaWdpbiI6IkNOIn19fQ.SIGNATURE_PLACEHOLDER",
                      "last_validation": {
                        "is_valid": true,
                        "is_verified": true,
                        "last_verified": "2024-03-16T11:15:00Z",
                        "signature_valid": true,
                        "schema_valid": true,
                        "status_valid": true,
                        "document_format": "JSON",
                        "extracted_credential": true,
                        "valid_until": "2025-03-16T00:00:00Z"
                      }
                    }
                  },
                  "document_parse_failure": {
                    "summary": "Document parsing failed",
                    "description": "Document exists but credential extraction failed due to unsupported format or corrupted content",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d487",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Z3hhMTIzNDU2Nzg5MCIsImlhdCI6MTcxMDQ5ODYwMCwiZXhwIjoxNzQyMDM0NjAwLCJuYmYiOjE3MTA0OTg2MDAsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUifX19.SIGNATURE_PLACEHOLDER",
                      "last_validation": {
                        "is_valid": false,
                        "is_verified": false,
                        "last_verified": "2024-03-14T16:30:00Z",
                        "signature_valid": false,
                        "schema_valid": false,
                        "status_valid": false,
                        "document_format": "UNKNOWN",
                        "extracted_credential": false,
                        "error_message": "Failed to extract credential from document"
                      }
                    }
                  },
                  "xml_invoice_invalid_signature": {
                    "summary": "XML document with invalid signature",
                    "description": "XML invoice document where credential was extracted successfully but digital signature verification failed",
                    "value": {
                      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d488",
                      "media_type": "application/vc+jwt",
                      "content": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6a2V5OnpRMWMxZTZhMiIsInN1YiI6InVybjppb3Q6Z3hhMTIzNDU2Nzg5MCIsImlhdCI6MTcxMDQ5ODYwMCwiZXhwIjoxNzQyMDM0NjAwLCJuYmYiOjE3MTA0OTg2MDAsInZjIjp7IkBjb250ZXh0IjpbImh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwiaHR0cHM6Ly9vci10cmFjZWFiaWxpdHkub3JnL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJJVElDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImlkIjoidXJuOmlvdDpneGExMjM0NTY3ODkwIiwidHlwZSI6IklUSSIsInNoaXBtZW50X2lkIjoiU0hJUC0yMDI0LTAwMTUifX19.INVALID_SIGNATURE",
                      "last_validation": {
                        "is_valid": false,
                        "is_verified": false,
                        "last_verified": "2024-03-13T12:45:00Z",
                        "signature_valid": false,
                        "schema_valid": true,
                        "status_valid": true,
                        "document_format": "XML",
                        "extracted_credential": true,
                        "error_message": "Digital signature verification failed",
                        "valid_until": "2025-03-13T00:00:00Z"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Document not found",
            "content": {
              "application/json": {
                "examples": {
                  "document_not_found": {
                    "summary": "Document path not found",
                    "value": {
                      "detail": "Document not found at specified path"
                    }
                  },
                  "invalid_document_path": {
                    "summary": "Invalid document path format",
                    "value": {
                      "detail": "Invalid document path format"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/schemas": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Get schemas",
        "description": "Get all schemas",
        "operationId": "get_schemas_credentials_schemas_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/CredentialSchemaListItem"
                  },
                  "type": "array",
                  "title": "Response Get Schemas Credentials Schemas Get"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credentials/schemas/{schema_name}": {
      "get": {
        "tags": [
          "Verifiable Credentials"
        ],
        "summary": "Get schema by name",
        "description": "Get schema by name",
        "operationId": "get_schema_by_name_credentials_schemas__schema_name__get",
        "parameters": [
          {
            "name": "schema_name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The name of the schema to retrieve",
              "title": "Schema Name"
            },
            "description": "The name of the schema to retrieve"
          }
        ],
        "responses": {
          "200": {
            "description": "Credential schema definition",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CredentialSchema"
                },
                "examples": {
                  "iti_credential_schema": {
                    "summary": "Intent To Import (ITI) Credential Schema",
                    "description": "JSON Schema for ITI credentials submitted to US Customs for import trade documentation compliance",
                    "value": {
                      "$id": "https://app.tradeverifyd.example/templates/urn:tradeverifyd:template:iti-credential",
                      "title": "Intent To Import Credential Schema",
                      "description": "Schema for Intent To Import verifiable credentials containing trade documentation for US Customs submission",
                      "type": "object",
                      "properties": {
                        "@context": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "JSON-LD context for the credential"
                        },
                        "type": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Credential type array"
                        },
                        "issuer": {
                          "type": "string",
                          "description": "DID of the credential issuer"
                        },
                        "credentialSubject": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Subject identifier"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "ITI"
                              ]
                            },
                            "shipment_id": {
                              "type": "string",
                              "description": "Associated shipment ID"
                            },
                            "customs_entry_number": {
                              "type": "string",
                              "description": "CBP entry number"
                            },
                            "importer": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string"
                                },
                                "address": {
                                  "type": "string"
                                },
                                "ein": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "name",
                                "address"
                              ]
                            },
                            "products": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "description": {
                                    "type": "string"
                                  },
                                  "hs_code": {
                                    "type": "string"
                                  },
                                  "quantity": {
                                    "type": "number"
                                  },
                                  "value": {
                                    "type": "number"
                                  }
                                },
                                "required": [
                                  "description",
                                  "hs_code",
                                  "quantity",
                                  "value"
                                ]
                              }
                            }
                          },
                          "required": [
                            "id",
                            "type",
                            "shipment_id",
                            "importer",
                            "products"
                          ]
                        }
                      },
                      "additionalProperties": false,
                      "required": [
                        "@context",
                        "type",
                        "issuer",
                        "credentialSubject"
                      ],
                      "example": "Example ITI credential structure for electronics import"
                    }
                  },
                  "bill_of_lading_schema": {
                    "summary": "Bill of Lading Credential Schema",
                    "description": "JSON Schema for Bill of Lading credentials used in international shipping documentation",
                    "value": {
                      "$id": "https://app.tradeverifyd.example/templates/urn:tradeverifyd:template:bill-of-lading",
                      "title": "Bill of Lading Credential Schema",
                      "description": "Schema for Bill of Lading verifiable credentials for international shipping",
                      "type": "object",
                      "properties": {
                        "@context": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "JSON-LD context for the credential"
                        },
                        "type": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Credential type array"
                        },
                        "issuer": {
                          "type": "string",
                          "description": "DID of the credential issuer (typically carrier)"
                        },
                        "credentialSubject": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Subject identifier"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "BillOfLading"
                              ]
                            },
                            "shipment_id": {
                              "type": "string",
                              "description": "Associated shipment ID"
                            },
                            "bill_of_lading_number": {
                              "type": "string",
                              "description": "Unique B/L number"
                            },
                            "carrier": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string"
                                },
                                "scac": {
                                  "type": "string",
                                  "description": "Standard Carrier Alpha Code"
                                }
                              },
                              "required": [
                                "name",
                                "scac"
                              ]
                            },
                            "shipper": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string"
                                },
                                "address": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "name",
                                "address"
                              ]
                            },
                            "consignee": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string"
                                },
                                "address": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "name",
                                "address"
                              ]
                            },
                            "port_of_loading": {
                              "type": "string",
                              "description": "Origin port"
                            },
                            "port_of_discharge": {
                              "type": "string",
                              "description": "Destination port"
                            },
                            "vessel_name": {
                              "type": "string",
                              "description": "Ship name"
                            },
                            "voyage_number": {
                              "type": "string",
                              "description": "Voyage identifier"
                            }
                          },
                          "required": [
                            "id",
                            "type",
                            "shipment_id",
                            "bill_of_lading_number",
                            "carrier",
                            "shipper",
                            "consignee"
                          ]
                        }
                      },
                      "additionalProperties": false,
                      "required": [
                        "@context",
                        "type",
                        "issuer",
                        "credentialSubject"
                      ],
                      "example": "Example Bill of Lading credential for ocean freight"
                    }
                  },
                  "certificate_origin_schema": {
                    "summary": "Certificate of Origin Schema",
                    "description": "JSON Schema for Certificate of Origin credentials used to certify the country where goods were manufactured",
                    "value": {
                      "$id": "https://app.tradeverifyd.example/templates/urn:tradeverifyd:template:certificate-of-origin",
                      "title": "Certificate of Origin Schema",
                      "description": "Schema for Certificate of Origin verifiable credentials",
                      "type": "object",
                      "properties": {
                        "@context": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "JSON-LD context"
                        },
                        "type": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "Credential types"
                        },
                        "issuer": {
                          "type": "string",
                          "description": "DID of issuing chamber of commerce or authority"
                        },
                        "credentialSubject": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Subject identifier"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "CertificateOfOrigin"
                              ]
                            },
                            "shipment_id": {
                              "type": "string",
                              "description": "Associated shipment ID"
                            },
                            "country_of_origin": {
                              "type": "string",
                              "description": "ISO 3166-1 alpha-2 country code"
                            },
                            "manufacturer": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string"
                                },
                                "address": {
                                  "type": "string"
                                },
                                "registration_number": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "name",
                                "address"
                              ]
                            },
                            "goods": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "description": {
                                    "type": "string"
                                  },
                                  "hs_code": {
                                    "type": "string"
                                  },
                                  "quantity": {
                                    "type": "number"
                                  },
                                  "gross_weight": {
                                    "type": "number"
                                  }
                                },
                                "required": [
                                  "description",
                                  "hs_code",
                                  "quantity"
                                ]
                              }
                            },
                            "attestation": {
                              "type": "object",
                              "properties": {
                                "issuer": {
                                  "type": "string",
                                  "description": "Attesting authority"
                                },
                                "date": {
                                  "type": "string",
                                  "format": "date"
                                },
                                "certificate_number": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "issuer",
                                "date",
                                "certificate_number"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "type",
                            "shipment_id",
                            "country_of_origin",
                            "manufacturer",
                            "goods",
                            "attestation"
                          ]
                        }
                      },
                      "additionalProperties": false,
                      "required": [
                        "@context",
                        "type",
                        "issuer",
                        "credentialSubject"
                      ],
                      "example": "Example Certificate of Origin for manufactured goods"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Schema not found",
            "content": {
              "application/json": {
                "examples": {
                  "schema_not_found": {
                    "summary": "Schema not found",
                    "value": {
                      "detail": "Schema not found."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error - contact support",
            "content": {
              "application/json": {
                "examples": {
                  "internal_error": {
                    "summary": "Internal server error",
                    "value": {
                      "detail": "Internal server error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/v1/openapi.json": {
      "get": {
        "tags": [
          "System"
        ],
        "summary": "OpenAPI JSON schema",
        "description": "Provides auto-generated OpenAPI JSON schema",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AbridgedGraph": {
        "properties": {
          "entrypoint": {
            "$ref": "#/components/schemas/AbridgedGraphEntity",
            "nullable": true
          },
          "entities": {
            "items": {
              "$ref": "#/components/schemas/AbridgedGraphEntity"
            },
            "type": "array",
            "title": "Entities"
          },
          "relationships": {
            "items": {
              "$ref": "#/components/schemas/AbridgedRelationship"
            },
            "type": "array",
            "title": "Relationships"
          },
          "page": {
            "type": "integer",
            "title": "Page",
            "default": 0
          },
          "page_size": {
            "type": "integer",
            "title": "Page Size",
            "default": 0
          },
          "records": {
            "type": "integer",
            "title": "Records",
            "default": 0
          },
          "total_records": {
            "title": "Total Records",
            "type": "integer",
            "nullable": true
          },
          "total_pages": {
            "title": "Total Pages",
            "type": "integer",
            "nullable": true
          },
          "entity_graph_counts": {
            "title": "Entity Graph Counts",
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "entities",
          "relationships"
        ],
        "title": "AbridgedGraph",
        "description": "Abridged graph response shape\nentry is the root of the graph"
      },
      "AbridgedGraphEntity": {
        "properties": {
          "_id": {
            "type": "string",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "jurisdiction": {
            "type": "string",
            "title": "Jurisdiction"
          },
          "mesur_type": {
            "type": "string",
            "enum": [
              "Company",
              "Facility",
              "Farm"
            ],
            "title": "Mesur Type",
            "default": "Company"
          },
          "flags": {
            "title": "Flags",
            "items": {
              "$ref": "#/components/schemas/Flag"
            },
            "type": "array",
            "nullable": true
          },
          "risk_events": {
            "title": "Risk Events",
            "items": {
              "$ref": "#/components/schemas/BaseRiskEvent"
            },
            "type": "array",
            "nullable": true
          },
          "graph_relative_risk_score": {
            "title": "Graph Relative Risk Score",
            "type": "integer",
            "nullable": true
          },
          "tradeverifyd_risk_score": {
            "title": "Tradeverifyd Risk Score",
            "type": "integer",
            "nullable": true
          },
          "coordinates": {
            "items": {
              "$ref": "#/components/schemas/Coordinate"
            },
            "type": "array",
            "title": "Coordinates",
            "default": []
          },
          "addresses": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Addresses",
            "default": []
          },
          "aliases": {
            "title": "Aliases",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "ids": {
            "title": "Ids",
            "items": {
              "$ref": "#/components/schemas/mesur_data_access__tradeverifyd__datamodels__common__Identifier"
            },
            "type": "array",
            "nullable": true
          },
          "upstream_depth": {
            "type": "integer",
            "title": "Upstream Depth",
            "default": -1
          },
          "downstream_depth": {
            "type": "integer",
            "title": "Downstream Depth",
            "default": -1
          },
          "depth": {
            "title": "Depth",
            "description": "Shortest distance from graph query entrypoint. This field will only\nreturn the UPSTREAM distance. If this Entity does not participate in the\nupstream graph of the entrypoint Entity for the graph, 'depth' will be\nNone.",
            "readOnly": true,
            "type": "integer",
            "nullable": true
          },
          "downstream_distance": {
            "title": "Downstream Distance",
            "description": "Shortest available distance from entrypoint Entity to this Entity if\ntraversing from this Entity to the entrypoint. This field will only\nreturn the DOWNSTREAM distance.  If this Entity does not participate in\nthe downstream graph of the entrypoint Entity for the graph,\n'downstream_distance' will be None.",
            "readOnly": true,
            "type": "integer",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "_id",
          "name",
          "jurisdiction",
          "depth",
          "downstream_distance"
        ],
        "title": "AbridgedGraphEntity",
        "description": "Minimum Entity data needed by Tradeverifyd Portal graphs"
      },
      "AbridgedRelationship": {
        "properties": {
          "_id": {
            "type": "string",
            "title": "Id",
            "default": "None"
          },
          "type": {
            "type": "string",
            "enum": [
              "DIRECTLY_CONSOLIDATES",
              "FEEDS_FROM",
              "FINANCES",
              "FUND_MANAGES",
              "IN_COLLABORATIVE_VENTURE_WITH",
              "IS_AFFILIATE_OF",
              "IS_AN_AGENT_OF",
              "IS_A_VENDOR_OF",
              "IS_BUSINESS_PARTNER_OF",
              "IS_MAJORITY_SHAREHOLDER_OF",
              "IS_MANUFACTURER_OF",
              "IS_MERGED_WITH",
              "IS_PARTNER_IN_JOINT_VENTURE",
              "IS_SUBISIDIARY_OF",
              "IS_SUPPLIER_OF",
              "IS_LIKELY_SUPPLIER_OF",
              "IS_THE_HOLDING_COMPANY_OF",
              "IS_THE_PARENT_COMPANY_OF",
              "IS_THE_TRADE_UNION_FOR",
              "IS_TRADEMARK_OF",
              "IS_TRAINING_PARTNER_OF",
              "OPERATES_INTERNATIONAL_BRANCH",
              "OWNS_COLLABORATIVE_VENTURE",
              "OWNS_FUND",
              "SHIPS_GOODS_TO",
              "SHIPS_VIA",
              "ULTIMATELY_CONSOLIDATES",
              "IS_OTHERWISE_LINKED_TO",
              "RELATED_TO"
            ],
            "title": "Type"
          },
          "relation_to": {
            "type": "string",
            "title": "Relation To"
          },
          "relation_from": {
            "type": "string",
            "title": "Relation From"
          },
          "normalized_products": {
            "title": "Normalized Products",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "modified": {
            "type": "string",
            "format": "date-time",
            "title": "Modified"
          },
          "source": {
            "title": "Source",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "exclusion_id": {
            "title": "Exclusion Id",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "type",
          "relation_to",
          "relation_from",
          "modified"
        ],
        "title": "AbridgedRelationship",
        "description": "Minimum EntityRelationship data needed by Tradeverifyd Portal graphs"
      },
      "Address": {
        "properties": {
          "address": {
            "type": "string",
            "title": "Address"
          },
          "problematic": {
            "type": "boolean",
            "title": "Problematic",
            "default": false
          },
          "problem_region": {
            "title": "Problem Region",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "address"
        ],
        "title": "Address",
        "description": "Information about an Entity's Address."
      },
      "BaseRiskEvent": {
        "properties": {
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "modified": {
            "type": "string",
            "format": "date-time",
            "title": "Modified"
          },
          "_id": {
            "type": "string",
            "title": "Id",
            "default": "None"
          },
          "title": {
            "type": "string",
            "minLength": 1,
            "title": "Title"
          },
          "summary": {
            "type": "string",
            "minLength": 1,
            "title": "Summary"
          },
          "sources": {
            "items": {
              "$ref": "#/components/schemas/RiskEventSource"
            },
            "type": "array",
            "minItems": 1,
            "title": "Sources"
          },
          "expires": {
            "type": "string",
            "format": "date-time",
            "title": "Expires"
          },
          "type": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "earthquake",
                  "hurricane",
                  "tsunami",
                  "flood",
                  "tornado",
                  "cyclone",
                  "volcanic_eruption",
                  "wildfire",
                  "drought",
                  "landslide",
                  "blizzard",
                  "ice_storm",
                  "heatwave",
                  "sandstorm",
                  "pandemic",
                  "insect_infestation"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "economic_sanction",
                  "trade_war",
                  "political_unrest",
                  "embargo",
                  "military_conflict",
                  "terrorist_attack"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "shipping_delay",
                  "port_congestion",
                  "transportation_strike",
                  "fuel_shortage",
                  "infrastructure_failure"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "raw_material_scarcity",
                  "component_shortage",
                  "semiconductor_shortage",
                  "crop_disease"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "strike",
                  "labor_shortage",
                  "skilled_labor_shortage",
                  "workforce_demographic_problem",
                  "forced_labor",
                  "child_labor"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "inflation",
                  "recession",
                  "economic_downturn",
                  "currency_fluctuation",
                  "interest_rate_change",
                  "stock_market_volatility"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "environmental_regulation",
                  "trade_regulation",
                  "labor_law",
                  "safety_regulation",
                  "compliance_standard"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "cyber_attack",
                  "data_breach",
                  "system_failure",
                  "technology_obsolete",
                  "software_bug"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "oil_price_increase",
                  "renewable_energy_outage",
                  "energy_rationing",
                  "nuclear_energy_incident"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "climate_change",
                  "biodiversity_loss",
                  "pollution",
                  "sustainable_resource_management"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "consumer_trend_shift",
                  "demand_surge",
                  "demand_slump",
                  "new_market_entrant"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "healthcare_system_overload"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "other"
                ]
              }
            ],
            "title": "Type"
          },
          "start_date": {
            "title": "Start Date",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "end_date": {
            "title": "End Date",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "last_propagation": {
            "title": "Last Propagation",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "last_notification": {
            "title": "Last Notification",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "hidden": {
            "type": "boolean",
            "title": "Hidden",
            "default": false
          },
          "review_status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "denied",
              "semi-approved"
            ],
            "title": "Review Status",
            "default": "pending"
          },
          "extraction_metadata": {
            "$ref": "#/components/schemas/ExtractionMetadata",
            "nullable": true
          },
          "force_expired": {
            "type": "boolean",
            "title": "Force Expired",
            "default": false
          },
          "original_expiry": {
            "title": "Original Expiry",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "article_type": {
            "$ref": "#/components/schemas/EventArticleType",
            "nullable": true
          },
          "article_impact": {
            "title": "Article Impact",
            "type": "integer",
            "nullable": true
          },
          "article_impact_type": {
            "title": "Article Impact Type",
            "type": "integer",
            "nullable": true
          },
          "article_impact_reasoning": {
            "title": "Article Impact Reasoning",
            "type": "string",
            "nullable": true
          },
          "affected_geographic_locations": {
            "title": "Affected Geographic Locations",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "proposed_type": {
            "title": "Proposed Type",
            "type": "string",
            "nullable": true
          },
          "countries": {
            "title": "Countries",
            "items": {
              "type": "string"
            },
            "type": "array",
            "minItems": 1,
            "nullable": true
          },
          "cities": {
            "title": "Cities",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "type": "array",
            "nullable": true
          },
          "regions": {
            "title": "Regions",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "type": "array",
            "nullable": true
          },
          "subscription_ids": {
            "title": "Subscription Ids",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "title",
          "summary",
          "sources",
          "expires",
          "type",
          "start_date",
          "end_date",
          "last_propagation",
          "last_notification"
        ],
        "title": "BaseRiskEvent",
        "description": "Represents an Event which happens in the real world that is likely to\ndisrupt economic activity for affected entities.\n\nAttributes:\n    id: Database id of the record, corresponds to MongoDB '_id'.\n\n    title: The title or a brief description of the event. This should\n    capture the essence of what the event is about.\n\n    summary: A more detailed summary or description of the event. This\n    provides additional context and information about the event.\n\n    sources: References that report and/or describe the event.\n\n    expires: Time after which the RiskEvent is no longer 'in-effect'.\n\n    type: Identifies the type of the event. The event type is the main\n    driver of event processing, e.g. when it expires, how it propagates to\n    entities, etc.\n\n    start_date: Time the event began\n\n    end_date: Time the event ended\n\n    last_propagation: Last time this event propagated to entities. Will be\n    'None' if it has never been propagated.\n\n    last_notification: Last time notifications for this event were\n    published. Will be 'None' if no notifications have been generated.\n\n    hidden: A 'hidden' RiskEvent has been un-propagated from all Entities so\n    that it is no longer affecting any scores, and should not be displayed\n    to any users. This field is temporary and will be displaced by\n    'review_status' once accompanying features for 'review_status' are\n    complete.\n\n    review_status: New RiskEvents are created in a 'pending' state. Pending\n    RiskEvents are invisible to end users, and have no impact on Entity\n    scores or other calculations. On human review, a RiskEvent may be\n    either 'approved' or 'denied'. If the RiskEvent is approved, it is\n    propagated to affected Entities, where it will impact Entity risk\n    scoring and other calculations. If denied, a corresponding\n    'RiskEventFeedback' record exists that explains why the RiskEvent is\n    irrelevant or inappropriate. RiskEvents are allowed to transition\n    between 'approved' and 'denied' any number of times, though such\n    transitions should be rare.\n\n    extraction_metadata: LLM vendor, model, and schema used to extract Risk\n    Event information from input text. This information can be used to\n    compare the performance of different prompts and models.\n\n    force_expired: If True, the expiration time set at creation has been\n    manually overridden to 'force' the record to expire.\n\n    original_expiry: If exists and is non-null, contains the expiration time\n    from before the document was force-expired."
      },
      "Body_update_shipment_sir_status_shipment_sirs__sir_id__status_post": {
        "properties": {
          "status": {
            "$ref": "#/components/schemas/SupplierInformationRequestStatus"
          }
        },
        "type": "object",
        "required": [
          "status"
        ],
        "title": "Body_update_shipment_sir_status_shipment_sirs__sir_id__status_post"
      },
      "Body_upload_file_file_upload_post": {
        "properties": {
          "file": {
            "type": "string",
            "format": "binary",
            "title": "File"
          }
        },
        "type": "object",
        "required": [
          "file"
        ],
        "title": "Body_upload_file_file_upload_post"
      },
      "Body_upload_shipment_file_shipment__shipment_id__upload_post": {
        "properties": {
          "file": {
            "items": {
              "type": "string",
              "format": "binary"
            },
            "type": "array",
            "title": "File",
            "description": "Only single file uploads are allowed"
          }
        },
        "type": "object",
        "required": [
          "file"
        ],
        "title": "Body_upload_shipment_file_shipment__shipment_id__upload_post"
      },
      "CBPRequestListing": {
        "properties": {
          "requests": {
            "items": {
              "$ref": "#/components/schemas/app__schemas__shipments__CBPRequest"
            },
            "type": "array",
            "title": "Requests",
            "description": "A listing of CBP Requests"
          }
        },
        "type": "object",
        "required": [
          "requests"
        ],
        "title": "CBPRequestListing",
        "description": "List of CBP Requests (shared schema for both public and internal APIs)"
      },
      "CGRContentsResponse": {
        "properties": {
          "report_type": {
            "type": "string",
            "title": "Report Type",
            "description": "The type of report requested."
          },
          "report_id": {
            "type": "string",
            "format": "uuid",
            "title": "Report Id",
            "description": "Unique ID (uuid) of the report."
          },
          "products": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Products",
            "description": "List of products included in the report."
          },
          "companies": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Companies",
            "description": "List of companies included in the report."
          },
          "supplier_information_requests": {
            "items": {},
            "type": "array",
            "title": "Supplier Information Requests",
            "default": "Supplier information requests involved in the report."
          },
          "hs_code_map": {
            "additionalProperties": true,
            "type": "object",
            "title": "Hs Code Map",
            "default": "A mapping of HS codes in the report to their descriptions."
          },
          "ranked_supplier_contexts": {
            "items": {},
            "type": "array",
            "title": "Ranked Supplier Contexts",
            "description": "A sorted list of supplier information requests with the context that feeds into the ranking algorithm."
          },
          "entity_research_summary": {
            "additionalProperties": true,
            "type": "object",
            "title": "Entity Research Summary",
            "default": "A brief summary of the entity research involved in this report."
          }
        },
        "type": "object",
        "required": [
          "report_type",
          "report_id",
          "products",
          "companies",
          "ranked_supplier_contexts"
        ],
        "title": "CGRContentsResponse",
        "description": "Contents response for a CGR (DPR) report"
      },
      "CPRContentsResponse": {
        "properties": {
          "report_type": {
            "type": "string",
            "title": "Report Type",
            "description": "The type of report requested."
          },
          "report_id": {
            "type": "string",
            "format": "uuid",
            "title": "Report Id",
            "description": "Unique ID (uuid) of the report."
          },
          "summary": {
            "type": "string",
            "title": "Summary",
            "description": "Brief summary of the report."
          },
          "products": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Products",
            "description": "List of products included in the report."
          },
          "companies": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Companies",
            "description": "List of companies included in the report."
          },
          "flags": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Flags",
            "description": "List of flags included in the report."
          },
          "areas_of_concern": {
            "additionalProperties": true,
            "type": "object",
            "title": "Areas Of Concern",
            "description": "Regions or entities the report raises as concerning."
          },
          "relationships": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Relationships",
            "description": "List of relationships between entities for the given report."
          },
          "entities": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Entities",
            "description": "List of entities involved in the report."
          },
          "supplier_information_requests": {
            "items": {},
            "type": "array",
            "title": "Supplier Information Requests",
            "default": "Supplier information requests involved in the report."
          },
          "entity_research_summary": {
            "additionalProperties": true,
            "type": "object",
            "title": "Entity Research Summary",
            "default": "A brief summary of the entity research involved in this report."
          }
        },
        "type": "object",
        "required": [
          "report_type",
          "report_id",
          "summary",
          "products",
          "companies",
          "flags",
          "areas_of_concern",
          "relationships",
          "entities"
        ],
        "title": "CPRContentsResponse",
        "description": "Contents response for a CPR (DRR) report"
      },
      "Coordinate": {
        "properties": {
          "lat": {
            "type": "number",
            "title": "Lat"
          },
          "lng": {
            "type": "number",
            "title": "Lng"
          },
          "type": {
            "type": "string",
            "enum": [
              "headquarters",
              "legal"
            ],
            "title": "Type"
          }
        },
        "type": "object",
        "required": [
          "lat",
          "lng",
          "type"
        ],
        "title": "Coordinate",
        "description": "Latitude and longitude associated with an Entity"
      },
      "CreateReportRequest": {
        "properties": {
          "report_type": {
            "type": "string",
            "enum": [
              "tasa",
              "cgr",
              "cpr"
            ],
            "title": "Report Type"
          },
          "report_name": {
            "title": "Report Name",
            "type": "string",
            "maxLength": 255,
            "nullable": true
          },
          "shipment_id": {
            "title": "Shipment Id",
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "entity_id": {
            "title": "Entity Id",
            "type": "string",
            "nullable": true
          },
          "hs_code": {
            "title": "Hs Code",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "report_type"
        ],
        "title": "CreateReportRequest",
        "description": "Create Report Request"
      },
      "CreateReportResponse": {
        "properties": {
          "report_id": {
            "type": "string",
            "format": "uuid",
            "title": "Report Id"
          }
        },
        "type": "object",
        "required": [
          "report_id"
        ],
        "title": "CreateReportResponse",
        "description": "Create Report Response"
      },
      "CreateShipmentRequest": {
        "properties": {
          "shipment_id": {
            "title": "Shipment Id",
            "description": "ID of shipment. Only supplied for updating existing shipments.",
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "shipment_name": {
            "type": "string",
            "title": "Shipment Name",
            "description": "Name of the shipment."
          },
          "origin": {
            "title": "Origin",
            "description": "Location of the shipment's origin.",
            "type": "string",
            "nullable": true
          },
          "destination": {
            "title": "Destination",
            "description": "Location of the shipment's destination.",
            "type": "string",
            "nullable": true
          },
          "departure_date": {
            "title": "Departure Date",
            "description": "Date of the shipment's departure.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "arrival_date": {
            "title": "Arrival Date",
            "description": "Date of the shipment's arrival.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/ShipmentStatus"
          },
          "active": {
            "type": "boolean",
            "title": "Active",
            "description": "Boolean signifying if the shipment is active or inactive.",
            "default": true
          },
          "organizational_units": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Organizational Units",
            "description": "Subunit(s) of the organization."
          },
          "detention_id": {
            "title": "Detention Id",
            "description": "Database ID of the detention for the shipment, if applicable.",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "shipment_name",
          "status",
          "organizational_units"
        ],
        "title": "CreateShipmentRequest",
        "description": "Request model for creating a shipment."
      },
      "CredentialListItem": {
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id",
            "description": "Identifier for the verifiable credential"
          },
          "media_type": {
            "type": "string",
            "title": "Media Type",
            "description": "Media type of the verifiable credential"
          },
          "content": {
            "type": "string",
            "title": "Content",
            "description": "The verifiable credential"
          },
          "last_validation": {
            "title": "Last Validation",
            "description": "The last validation result of the verifiable credential",
            "additionalProperties": true,
            "type": "object",
            "nullable": true
          },
          "source_file_id": {
            "title": "Source File Id",
            "description": "UUID of the source document from which this credential was generated, null for manually issued credentials",
            "type": "string",
            "format": "uuid",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "media_type",
          "content",
          "last_validation",
          "source_file_id"
        ],
        "title": "CredentialListItem",
        "description": "Credential list item"
      },
      "CredentialSchema": {
        "properties": {
          "$id": {
            "type": "string",
            "title": "$Id",
            "description": "The unique identifier for the schema"
          },
          "title": {
            "type": "string",
            "title": "Title",
            "description": "The title of the schema"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Description of the schema"
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "The type of the schema",
            "default": "object"
          },
          "properties": {
            "additionalProperties": true,
            "type": "object",
            "title": "Properties",
            "description": "The properties of the schema"
          },
          "additionalProperties": {
            "type": "boolean",
            "title": "Additionalproperties",
            "description": "Whether additional properties are allowed",
            "default": false
          },
          "required": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Required",
            "description": "List of required properties"
          },
          "example": {
            "title": "Example",
            "description": "Example of the schema",
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": true,
        "type": "object",
        "required": [
          "$id",
          "title",
          "description",
          "properties",
          "required"
        ],
        "title": "CredentialSchema",
        "description": "Credential schema for defining the structure of verifiable credentials."
      },
      "CredentialSchemaListItem": {
        "properties": {
          "schema_id": {
            "type": "string",
            "title": "Schema Id",
            "description": "The unique identifier for the schema"
          },
          "title": {
            "type": "string",
            "title": "Title",
            "description": "The title of the schema"
          },
          "schema_name": {
            "type": "string",
            "title": "Schema Name",
            "description": "The name of the schema, used to get the schema details"
          }
        },
        "type": "object",
        "required": [
          "schema_id",
          "title",
          "schema_name"
        ],
        "title": "CredentialSchemaListItem",
        "description": "Credential schema list item with just the schema id and title"
      },
      "DSCContentsResponse": {
        "properties": {
          "report_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ],
            "title": "Report Id",
            "description": "Unique ID (uuid) of the report."
          },
          "report_type": {
            "type": "string",
            "const": "dsc",
            "title": "Report Type",
            "description": "The type of report requested."
          },
          "subscription_id": {
            "type": "string",
            "title": "Subscription Id",
            "description": "ID of the subscription in the report."
          },
          "subscription_name": {
            "type": "string",
            "title": "Subscription Name",
            "description": "Name of the subscription i nthe report."
          },
          "summary": {
            "type": "string",
            "title": "Summary",
            "description": "Brief summary of the report."
          },
          "summary_bullets": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Summary Bullets",
            "description": "Key points from the report's summary."
          },
          "risk_events": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Risk Events",
            "description": "Risk events included in the report."
          },
          "supply_graph": {
            "$ref": "#/components/schemas/AbridgedGraph"
          },
          "top_risk_suppliers": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Top Risk Suppliers",
            "description": "A list of the top risk suppliers in the report."
          }
        },
        "type": "object",
        "required": [
          "report_id",
          "report_type",
          "subscription_id",
          "subscription_name",
          "summary",
          "summary_bullets",
          "risk_events",
          "supply_graph",
          "top_risk_suppliers"
        ],
        "title": "DSCContentsResponse",
        "description": "Contents response for a DSC report"
      },
      "DataStatus": {
        "properties": {
          "state": {
            "type": "string",
            "enum": [
              "invalid",
              "suspected",
              "confirmed"
            ],
            "title": "State",
            "description": "The level of confirmation for the data provided in the flag record.",
            "default": "suspected"
          },
          "confidence": {
            "title": "Confidence",
            "description": "Level of confidence in the information contained in the flag record.",
            "type": "string",
            "enum": [
              "almost no chance",
              "very unlikely",
              "unlikely",
              "roughly even chance",
              "likely",
              "very likely",
              "almost certain"
            ],
            "nullable": true
          },
          "sources": {
            "title": "Sources",
            "description": "A list of sources supporting the state and confidence level.",
            "items": {
              "$ref": "#/components/schemas/Source"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "title": "DataStatus",
        "description": "Supoorts enhancing a class with status information.\n\nAttributes:\n    state: the state value: invalid, suspected, or confirmed. Defaults to\n    suspected.\n    confidence: the level of confidence in the state: almost no chance, very unlikely,\n    unlikely, roughly even chance, likely, very likely, almost certain.\n    sources: a list of sources supporting the state and confidence level."
      },
      "DepthInfo": {
        "properties": {
          "depth": {
            "type": "integer",
            "title": "Depth",
            "description": "The depth of the flag in the relationship."
          },
          "direction": {
            "type": "string",
            "enum": [
              "upstream",
              "downstream",
              "entry"
            ],
            "title": "Direction",
            "description": "The direction of the flag in the relationship."
          }
        },
        "type": "object",
        "required": [
          "depth",
          "direction"
        ],
        "title": "DepthInfo",
        "description": "Represents depth information for recursive flag retrieval, indicating if the relationship is upstream or downstream."
      },
      "DisplayFlagResponse": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Flag Identifier",
            "description": "Unique identifier for the flag, useful for reference and tracking."
          },
          "entity_id": {
            "type": "string",
            "title": "Entity Id",
            "description": "ID of the Entity that this Flag is associated with"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Flag Timestamp",
            "description": "Timestamp indicating when the flag was created or recorded."
          },
          "time_start": {
            "title": "Flag Start Time",
            "description": "Beginning time when the flag becomes relevant or active.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "time_end": {
            "title": "Flag End Time",
            "description": "Ending time after which the flag is no longer considered relevant.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "type": {
            "type": "string",
            "title": "Flag Type",
            "description": "Describes the _id of corresponding flag type in Mongo."
          },
          "description": {
            "title": "Flag Description",
            "description": "Optional field for describing the flag's purpose and significance.",
            "type": "string",
            "maxLength": 4096,
            "nullable": true
          },
          "sources": {
            "title": "Flag Sources",
            "description": "Optional list of sources or references that provide information or evidence related to the flag.",
            "items": {
              "$ref": "#/components/schemas/Source"
            },
            "type": "array",
            "nullable": true
          },
          "status": {
            "title": "Status",
            "description": "The status of the flag, with a confidence level and source data.",
            "$ref": "#/components/schemas/DataStatus",
            "nullable": true
          },
          "entity_name": {
            "title": "Entity Name",
            "description": "The name of the entity associated with the flag.",
            "type": "string",
            "nullable": true
          },
          "entity_jurisdiction": {
            "title": "Entity Jurisdiction",
            "description": "The jurisdiction of the entity associated with the flag.",
            "type": "string",
            "nullable": true
          },
          "flag_type": {
            "title": "Flag Type",
            "description": "The human-readable type of the flag.",
            "type": "string",
            "nullable": true
          },
          "flag_subtype": {
            "title": "Flag Subtype",
            "description": "The human-readable subtype of the flag.",
            "type": "string",
            "nullable": true
          },
          "flag_polarity": {
            "title": "Flag Polarity",
            "description": "Indicates whether a flag is positive or negative. A flag is positive if the entity it is associated with has been certified by an authoritative body to be in compliance with an accepted standard. It is negative if the associated entity participates in or is associated with a sanctioned, illegal, or otherwise undesirable activity.",
            "type": "integer",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "entity_id",
          "created_at",
          "type"
        ],
        "title": "DisplayFlagResponse",
        "description": "Response model for flag display information.\n\nExtends the internal flag model to provide comprehensive flag details\nincluding entity context and relationship depth information."
      },
      "EntityGraphCounts": {
        "properties": {
          "depth": {
            "type": "integer",
            "title": "The depth of the graph traversal",
            "default": 3
          },
          "value": {
            "type": "integer",
            "title": "The total number of relationships in the graph",
            "default": 0
          },
          "flagged_count": {
            "type": "integer",
            "title": "Flagged Count",
            "description": "Flagged upstream entities count",
            "default": 0
          },
          "last_updated": {
            "type": "string",
            "format": "date-time",
            "title": "The last time the graph counts were updated",
            "default": "2026-04-08T14:12:49.131967Z"
          }
        },
        "type": "object",
        "title": "EntityGraphCounts"
      },
      "EntityHsCodes": {
        "properties": {
          "incoming": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Incoming",
            "description": "HS codes for products received by this entity"
          },
          "outgoing": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Outgoing",
            "description": "HS codes for products shipped by this entity"
          }
        },
        "type": "object",
        "title": "EntityHsCodes",
        "description": "HS codes organized by trade direction for an Entity"
      },
      "EntitySearchResult": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The Mesur Entity Id."
          },
          "name": {
            "type": "string",
            "title": "Name",
            "description": "Entity name"
          },
          "aliases": {
            "title": "Aliases",
            "description": "Alternative names and aliases",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "jurisdiction": {
            "title": "Jurisdiction",
            "description": "The country the entity is associated with.",
            "type": "string",
            "nullable": true
          },
          "addresses": {
            "title": "Addresses",
            "description": "Entity addresses.",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "flagged": {
            "type": "boolean",
            "title": "Flagged",
            "description": "Whether or not the Entity has active Flags."
          },
          "has_positive_flags": {
            "type": "boolean",
            "title": "Has Positive Flags",
            "description": "Whether the Entity has any positive/compliant flags.",
            "default": false
          },
          "has_negative_flags": {
            "type": "boolean",
            "title": "Has Negative Flags",
            "description": "Whether the Entity has any negative/risk flags.",
            "default": false
          },
          "description": {
            "title": "Entity Description",
            "description": "Detailed information about the entity's purpose, background, or role.",
            "type": "string",
            "maxLength": 4096,
            "nullable": true
          },
          "primary_role": {
            "title": "Primary Role",
            "description": "The primary role of the entity (e.g., supplier, grower)",
            "type": "string",
            "nullable": true
          },
          "url": {
            "title": "Entity URL",
            "description": "The official website or online resource associated with the entity.",
            "type": "string",
            "nullable": true
          },
          "extended_data": {
            "title": "Extended Data",
            "description": "Additional data points about the entity, including status and links to documents",
            "additionalProperties": true,
            "type": "object",
            "nullable": true
          },
          "auto_research": {
            "title": "Research Entity",
            "description": "Flag indicating if the entity should be researched automatically.",
            "type": "boolean",
            "nullable": true
          },
          "monitor": {
            "title": "Monitor Entity",
            "description": "Flag indicating if the entity should be continuously monitored for updates or changes.",
            "type": "boolean",
            "nullable": true
          },
          "callback_url": {
            "title": "Callback URL",
            "description": "Registered URL to call when Entity activiy occurs",
            "type": "string",
            "nullable": true
          },
          "references": {
            "title": "Entity References",
            "description": "flag, relationships, other references to this entity",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__search_models__EntityReferences",
            "nullable": true
          },
          "count_inferred_relationships": {
            "title": "Inferred Relationships Count",
            "description": "The number of inferred relationships in the graph.  Will not be present if the graph counts have not been calculated yet.",
            "$ref": "#/components/schemas/EntityGraphCounts",
            "nullable": true
          },
          "external_ids": {
            "title": "External Identifiers",
            "description": "An optional list of external identifiers for an Entity.",
            "items": {
              "$ref": "#/components/schemas/ExternalEnttiyId"
            },
            "type": "array",
            "nullable": true
          },
          "modified_date": {
            "title": "Modified Date",
            "description": "Last time entity record was modified (timezone-aware UTC)",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "hs_codes": {
            "title": "HS Codes",
            "description": "Harmonized System codes for products traded by this entity, organized by direction",
            "$ref": "#/components/schemas/HsCodes",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "aliases",
          "jurisdiction",
          "addresses",
          "flagged"
        ],
        "title": "EntitySearchResult",
        "description": "Single Entity search result"
      },
      "EntityVerificationDetails": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "jurisdiction": {
            "type": "string",
            "title": "Jurisdiction"
          },
          "addresses": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Addresses"
          },
          "text_summary": {
            "type": "string",
            "title": "Text Summary"
          },
          "problematic_entities": {
            "items": {
              "$ref": "#/components/schemas/ProblematicEntity"
            },
            "type": "array",
            "title": "Problematic Entities",
            "default": []
          },
          "tradeverifyd_score": {
            "type": "number",
            "title": "Tradeverifyd Score",
            "default": 0.0
          },
          "total_entity_ct": {
            "type": "integer",
            "title": "Total Entity Ct",
            "default": 0
          },
          "identifiers": {
            "items": {
              "$ref": "#/components/schemas/mesur_data_access__tradeverifyd__datamodels__common__Identifier"
            },
            "type": "array",
            "title": "Identifiers",
            "default": []
          },
          "incoming_products": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Incoming Products",
            "default": []
          },
          "outgoing_products": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Outgoing Products",
            "default": []
          },
          "top_supplier_connections": {
            "items": {
              "$ref": "#/components/schemas/TopSupplierConnection"
            },
            "type": "array",
            "title": "Top Supplier Connections",
            "default": []
          },
          "top_customer_connections": {
            "items": {
              "$ref": "#/components/schemas/TopSupplierConnection"
            },
            "type": "array",
            "title": "Top Customer Connections",
            "default": []
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "jurisdiction",
          "addresses",
          "text_summary"
        ],
        "title": "EntityVerificationDetails",
        "description": "Summary of verification details for an Entity."
      },
      "EventArticleType": {
        "type": "string",
        "enum": [
          "disruptive_event",
          "important_information",
          "educational_article",
          "report",
          "other"
        ],
        "title": "EventArticleType",
        "description": "Enum of event article types."
      },
      "ExternalBulkFlagItem": {
        "properties": {
          "entity_id": {
            "type": "string",
            "title": "Entity Id",
            "description": "ID of the associated staged entity"
          },
          "flag_type": {
            "type": "string",
            "title": "Flag Type",
            "description": "Type of flag"
          },
          "flag_subtype": {
            "type": "string",
            "title": "Flag Subtype",
            "description": "Subtype of flag"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Detailed description of the flag"
          },
          "tags": {
            "title": "Tags",
            "description": "Single word identifier for flag by subcategories",
            "type": "string",
            "nullable": true
          },
          "source_location": {
            "type": "string",
            "title": "Source Location",
            "description": "Source of Flag Information such as a URL"
          },
          "time_start": {
            "title": "Time Start",
            "description": "Start time of the flag's validity",
            "type": "string",
            "nullable": true
          },
          "time_end": {
            "title": "Time End",
            "description": "End time of the flag's validity",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "entity_id",
          "flag_type",
          "flag_subtype",
          "description",
          "source_location"
        ],
        "title": "ExternalBulkFlagItem",
        "description": "Individual flag item for bulk flag API"
      },
      "ExternalBulkFlagResponse": {
        "properties": {
          "message": {
            "type": "string",
            "title": "Message",
            "description": "Status message"
          },
          "flag_count": {
            "type": "integer",
            "title": "Flag Count",
            "description": "Total number of flags in the request"
          },
          "inserted_count": {
            "type": "integer",
            "title": "Inserted Count",
            "description": "Number of flags successfully inserted"
          },
          "status": {
            "type": "string",
            "title": "Status",
            "description": "Processing status"
          }
        },
        "type": "object",
        "required": [
          "message",
          "flag_count",
          "inserted_count",
          "status"
        ],
        "title": "ExternalBulkFlagResponse",
        "description": "Response model for external bulk flag operations."
      },
      "ExternalEntityId": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The external identifier value"
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "The type of the identifier (e.g. lei, us_fein)"
          },
          "source": {
            "type": "string",
            "title": "Source",
            "description": "The source of the identifier"
          }
        },
        "type": "object",
        "required": [
          "id",
          "type",
          "source"
        ],
        "title": "ExternalEntityId",
        "description": "External identifier for an Entity"
      },
      "ExternalEnttiyId": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The External Id"
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "The type of the identifier"
          },
          "source": {
            "type": "string",
            "title": "Source",
            "description": "The source of the identifieer"
          }
        },
        "type": "object",
        "required": [
          "id",
          "type",
          "source"
        ],
        "title": "ExternalEnttiyId",
        "description": "Class for information about external Entity Identifiers"
      },
      "ExtractionMetadata": {
        "properties": {
          "model_vendor": {
            "type": "string",
            "minLength": 1,
            "title": "Model Vendor"
          },
          "model_id": {
            "type": "string",
            "minLength": 1,
            "title": "Model Id"
          },
          "extraction_schema_name": {
            "type": "string",
            "minLength": 1,
            "title": "Extraction Schema Name"
          },
          "extraction_schema_version": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Extraction Schema Version"
          }
        },
        "type": "object",
        "required": [
          "model_vendor",
          "model_id",
          "extraction_schema_name",
          "extraction_schema_version"
        ],
        "title": "ExtractionMetadata",
        "description": "Metadata describing models, techniques, schemas, etc. that were used to\nextract the Risk Event from plain text, and/or make decisions about the\nrelevance of the extracted content.\n\nAttributes:\n    model_vendor: Name of LLM vendor (e.g. Anthropic, OpenAI) used to extract Risk Event information\n\n    model_id: Specific LLM model id (e.g. \"claude-haiku-4-5\")\n\n    extraction_schema_name: Name of Pydantic ExtractionSchema class that\n    provided the JSON schema for Risk Event extraction.\n\n    extraction_schema_version: Version of Pydantic ExtractionSchema class\n    that provided the JSON schema for RiskEvent extraction. During\n    extraction, LLM decision-making is mainly guided by instructions\n    provided in the 'description' of each ExctractionSchema attribute. When\n    these instructions change, 'extraction_schema_version' is incremented to\n    track the change."
      },
      "Facet": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "event_type",
              "event_country"
            ],
            "title": "Type",
            "description": "Facet type."
          },
          "value": {
            "type": "string",
            "minLength": 1,
            "title": "Value",
            "description": "Distinct facet value."
          },
          "count": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Count",
            "description": "Number of records in the entire (non-paginated) result set matching the distinct facet value."
          }
        },
        "type": "object",
        "required": [
          "type",
          "value",
          "count"
        ],
        "title": "Facet",
        "description": "Number of result values matching a distinct value for a given facet."
      },
      "FileUploadResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "url": {
            "type": "string",
            "title": "Url"
          }
        },
        "type": "object",
        "required": [
          "success",
          "url"
        ],
        "title": "FileUploadResponse",
        "description": "Response model for file upload operations."
      },
      "Flag": {
        "properties": {
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "modified": {
            "type": "string",
            "format": "date-time",
            "title": "Modified"
          },
          "batch": {
            "title": "Batch",
            "type": "string",
            "nullable": true
          },
          "_id": {
            "type": "string",
            "title": "Id",
            "default": "None"
          },
          "schema_version": {
            "type": "integer",
            "title": "Schema Version",
            "default": 1
          },
          "entity_id": {
            "type": "string",
            "title": "Entity Id"
          },
          "type": {
            "type": "string",
            "title": "Type"
          },
          "tags": {
            "title": "Tags",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "source": {
            "title": "Source",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "entity_jurisdiction": {
            "title": "Entity Jurisdiction",
            "type": "string",
            "nullable": true
          },
          "customer_managed": {
            "type": "boolean",
            "title": "Customer Managed",
            "default": false
          },
          "owner_email": {
            "title": "Owner Email",
            "type": "string",
            "nullable": true
          },
          "organization": {
            "title": "Organization",
            "type": "string",
            "nullable": true
          },
          "deleted": {
            "type": "boolean",
            "title": "Deleted",
            "default": false
          },
          "deleted_at": {
            "title": "Deleted At",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "deletion_source": {
            "title": "Deletion Source",
            "type": "string",
            "nullable": true
          },
          "confidence": {
            "title": "Confidence",
            "type": "integer",
            "nullable": true
          },
          "time_start": {
            "title": "Time Start",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "time_end": {
            "title": "Time End",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "description": {
            "title": "Description",
            "type": "string",
            "nullable": true
          },
          "score": {
            "type": "number",
            "title": "Score",
            "default": 0.5
          },
          "decay_factor": {
            "title": "Decay Factor",
            "default": 1.0,
            "type": "number",
            "nullable": true
          },
          "decay_version": {
            "type": "integer",
            "title": "Decay Version",
            "default": 1
          },
          "penalties": {
            "title": "Penalties",
            "items": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "type": "array",
            "nullable": true
          },
          "url_sources": {
            "title": "Url Sources",
            "description": "Members of 'source' field that are also well-formed URLs. If Flag.source\nhas 1 or more entries, but none are valid URLs, the value of this\ncomputed field will be None.",
            "readOnly": true,
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          }
        },
        "additionalProperties": true,
        "type": "object",
        "required": [
          "entity_id",
          "type",
          "url_sources"
        ],
        "title": "Flag",
        "description": "Represents a flag associated with a particular entity.\n\nA flag is positive if, for example, the entity it is associated with has\nbeen certified by an authoritative body to be in compliance with an accepted\nstandard. It is negative if the associated entity participates in or is\nassociated with a sanctioned, illegal, or otherwise undesirable activity.\n\nAttributes:\n    id: Database id of the record, corresponds to mongodb '_id'.\n\n    entity_id: Database id of the entity the flag is applied to, corresponds\n    to target entity '_id' in mongodb.\n\n    schema_version: Document schema.\n\n    type: Details about the nature of the flag. This may be the name of the\n    relevant certification or sanction, e.g. 'RSPO Certified' or 'ITAR\n    Debarred (DTC) - State Department', or a more general category, e.g.\n    'forced labor'. This should be an ObjectIdField stored in the 'flag_types'\n    collection - optionally a string allowed here for validation when the ObjectId\n    field needs to be looked up and displayed in the portal.\n\n    tags: A list of semi-arbitrary strings that provides additional\n    classifications or detail on the nature of the flag type. An example of\n    this might be a flag with type \"Forced Labor Risk\" with subtype\n    \"Operating in Uyghur Region\", \"Sourcing directly from Uyghur Region\", or\n    \"Accepted labor transfers outside Uyghur Region\".\n\n    source: List of ONE url to a page containing information that is\n    relevant to the flag, or the entity it applies to. For user-uploaded\n    flags, this field will be None.\n\n    entity_jurisdiction: ISO country code of the entity that the flag\n    applies to, if the jurisdiction is known.\n\n    customer_managed: This field is true if a customer has created this flag\n    directly, otherwise, it is false. A customer-managed flag MUST NOT be\n    visible outside of the organization of the user who created it.\n\n    owner_email: The email address of the user who created the\n    customer-managed flag. If 'customer_managed' is false, this field MUST\n    be None.\n\n    organization: The globally-unique name of the organization to which a\n    customer-managed flag belongs, which is currently the same as the\n    organization to which the flag's creator belongs. If 'customer_managed'\n    if false, this field MUST be None.\n\n    is_positive: A derived field not present on the underlying record. This\n    field controls whether the flag is displayed to users as a 'positive' or\n    'negative' flag.\n\n    deleted: Whether or not the flag is currently in-force.\n\n    deleted_at: If the flag is no longer in force for any reason, this field\n    is the time the flag ceased to be applicable to the target entity.\n\n    deletion_source: If 'deleted_at' is not null, this field explains why\n    the flag is no longer in effect. It may be a URL to a web source\n    offering further explanation.\n\n    confidence: For flag records generated by bots, this field indicates the\n    strength of our belief that the decision to assign a flag is correct.\n    100 is the most confident, 0 is the least. If a flag was not generated\n    by a bot, this field must be None.\n\n    time_start: Time at which flag took effect. Currently, this field is\n    only set on Flags uploaded via Earthstream API.\n\n    time_end: Time after which flag is no longer in effect. Currently, this\n    field is only set on Flags uploaded via Earthstream API.\n\n    description: Plain-text description for the flag. Currently, this field\n    is only set on Flags uploaded via Earthstream API.\n\n    # TODO: TV-10497 Remove this field, as the default is set to 0.5, which is being nullified\n    # in GraphEntity.entity_score. This might be important for risk events, but not for Flags.\n    score: The score of the flag.\n\n    decay_factor: The amount by which a flag decays, which is re-calculated daily according to\n    the flag's decay strategy and the flag's age. This gets factored into an entity's score\n    through the TradeverifydScoringService later on, through the regulatory flag strategy. The\n    decay_factor should always be a float between 0 and 1, but for soft deleted flags, it will\n    be set to 1.0 as to not impact the entity's score.\n\n    decay_version: The version of the decay strategy used to calculate the decay_factor.\n\n    penalties: A optional list of dictionaries, each containing the following keys:\n    - penalty_agency: The agency that issued the penalty\n    - penalty_usd: The amount of the penalty in USD\n    - penalty_date: The date of the penalty"
      },
      "FlagTypeResponse": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "Unique identifier for the flag type."
          },
          "flag_type_description": {
            "type": "string",
            "title": "Flag Type Description",
            "description": "Brief description of the flag's meaning."
          },
          "flag_type": {
            "type": "string",
            "title": "Flag Type",
            "description": "Primary type of the flag."
          },
          "flag_subtype": {
            "type": "string",
            "title": "Flag Subtype",
            "description": "Subtype of the flag."
          },
          "flag_polarity": {
            "type": "integer",
            "title": "Flag Polarity",
            "description": "Positive (+1) indicates compliance/certification, negative (-1) indicates violations/sanctions."
          }
        },
        "type": "object",
        "required": [
          "id",
          "flag_type_description",
          "flag_type",
          "flag_subtype",
          "flag_polarity"
        ],
        "title": "FlagTypeResponse",
        "description": "Response model for flag types without the score field.\n\nAttributes:\n\n    id: ID of the flag type.\n    flag_type_description: Description of the flag type.\n    flag_type: Type of the flag.\n    flag_subtype: Subtype of the flag.\n    flag_polarity: Polarity of the flag."
      },
      "FlagUpdateItem": {
        "properties": {
          "entity_jurisdiction": {
            "title": "Entity Jurisdiction",
            "description": "Jurisdiction of the entity",
            "type": "string",
            "nullable": true
          },
          "description": {
            "title": "Description",
            "description": "Detailed description of the flag",
            "type": "string",
            "nullable": true
          },
          "tags": {
            "title": "Tags",
            "description": "Single word identifier for flag by subcategories",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "source": {
            "title": "Source",
            "description": "Source of Flag Information such as a URL",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "time_start": {
            "title": "Time Start",
            "description": "Start time of the flag's validity",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "time_end": {
            "title": "Time End",
            "description": "End time of flag's validity",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "owner_email": {
            "title": "Owner Email",
            "description": "Email of flag owner",
            "type": "string",
            "nullable": true
          },
          "deleted": {
            "type": "boolean",
            "title": "Deleted",
            "description": "Boolean marking deleted flags",
            "default": false
          },
          "deleted_at": {
            "title": "Deleted At",
            "description": "Time flag was deleted",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "deletion_source": {
            "title": "Deletion Source",
            "description": "Source of deletion",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "title": "FlagUpdateItem",
        "description": "Individual flag item for update flag endpoint.\nAttributes listed here represent those that users can update."
      },
      "FlaggedRelationshipsResponse": {
        "properties": {
          "entities": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Entities",
            "description": "List of entities referenced in the paths",
            "example": [
              {
                "aliases": [
                  "Company A Inc."
                ],
                "id": "645a550a992fba23b295e4e9",
                "ids": [],
                "location": {
                  "HeadquartersAddress": {
                    "addressLines": [
                      "NO.36 EAST OF NORTH 3 ROAD"
                    ],
                    "addressNumber": "36",
                    "city": "City A",
                    "coordinates": {
                      "latitude": 0.0,
                      "longitude": 0.0
                    },
                    "country": "Country A",
                    "language": "en",
                    "region": "Region A"
                  },
                  "LegalAddress": {
                    "addressLines": [
                      "NO.36 EAST OF NORTH 3 ROAD"
                    ],
                    "addressNumber": "36",
                    "city": "City A",
                    "coordinates": {
                      "latitude": 0.0,
                      "longitude": 0.0
                    },
                    "country": "Country A",
                    "language": "en",
                    "region": "Region A"
                  }
                },
                "modified": "2025-09-12T00:00:00Z",
                "name": "Company A",
                "uuid": "bceaa087-7532-46b0-bc5d-b57d1a0573b7"
              }
            ]
          },
          "relationships": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Relationships",
            "description": "List of relationships referenced in the paths",
            "example": [
              {
                "hs_codes": [],
                "id": "64ac2a7172c173ba6f5aac89",
                "modified": "2025-09-12T00:00:00Z",
                "relation_from": "64ac25c672c173ba6f399722",
                "relation_to": "64ac25c872c173ba6f415635",
                "source": [
                  "https://search.gleif.org/#/record/AAAAAAAAAAAAAAAAAAAA/",
                  "https://search.gleif.org/#/record/BBBBBBBBBBBBBBBBBBBB/"
                ],
                "type": "DIRECTLY_CONSOLIDATES"
              }
            ]
          },
          "flags": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Flags",
            "description": "List of flags referenced in the paths",
            "example": [
              {
                "entity_id": "66b5aca01091cc1ae224b0dd",
                "flag_polarity": 1,
                "flag_subtype": "Forced Labor Risk",
                "flag_type": "Compliant",
                "id": "67ffefdc070a88cf066349fa",
                "modified": "2025-09-12T00:00:00Z",
                "source": [
                  "https://modernslaveryregister.gov.au/statements/"
                ],
                "tags": [
                  "COMPLIANT - Australia Modern Slavery Act 2018"
                ]
              }
            ]
          },
          "pagination": {
            "description": "Pagination information for the response",
            "example": {
              "current_page": 1,
              "page_size": 50,
              "total_pages": 1,
              "total_records": 1
            },
            "$ref": "#/components/schemas/app__api__internal__schemas__reports__Pagination",
            "nullable": true
          },
          "filters": {
            "title": "Filters",
            "additionalProperties": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "type": "object",
            "nullable": true
          },
          "sorting": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Sorting"
          }
        },
        "type": "object",
        "required": [
          "entities",
          "relationships",
          "flags"
        ],
        "title": "FlaggedRelationshipsResponse",
        "description": "Response model for flagged paths data.\n\nContains paths to flagged entities along with all related entities,\nrelationships, and flags. All ObjectIds are serialized as strings\nfor JSON compatibility."
      },
      "GetEntityResponse": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "Unique Entity identifier."
          },
          "name": {
            "type": "string",
            "title": "Name",
            "description": "The formal or recognized name of the entity."
          },
          "description": {
            "title": "Description",
            "description": "Detailed information about the entity's purpose, background, or role.",
            "type": "string",
            "nullable": true
          },
          "primary_role": {
            "title": "Primary Role",
            "description": "The primary role of the entity (e.g., supplier, grower)",
            "type": "string",
            "nullable": true
          },
          "aliases": {
            "title": "Aliases",
            "description": "Alternative names and aliases",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "url": {
            "title": "Url",
            "description": "The official website or online resource associated with the entity.",
            "type": "string",
            "nullable": true
          },
          "jurisdiction": {
            "type": "string",
            "title": "Entity Jurisdiction",
            "description": "ISO 3166 country code of the country where the entity operates or is governed."
          },
          "addresses": {
            "title": "Addresses",
            "description": "The physical or registered addresses of the entity.",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "monitor": {
            "type": "boolean",
            "title": "Monitor Entity",
            "description": "If 'true', system events impacting this Entity or any Entity in its supply chain (as defined by the parameters set in Entity.subscription) will generate Notifications. Notifications can be viewed and acknowledged at /notifications endpoints.",
            "default": false
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "description": "Time record was created."
          },
          "modified": {
            "type": "string",
            "format": "date-time",
            "title": "Modified",
            "description": "Last time record was modified."
          },
          "region": {
            "title": "Region",
            "description": "Region code for the Enttiy",
            "type": "string",
            "nullable": true
          },
          "affiliated_jurisdiction": {
            "title": "Affiliated Jurisdiction",
            "description": "Supplemental jurisdction information. For example, some Entities may be associate with super-governmental bodies like the United Nations.",
            "type": "string",
            "nullable": true
          },
          "tradeverifyd_score": {
            "title": "Tradeverifyd Score",
            "description": "Entity's Tradeverifyd score. Entities with higher risk for supply chain or compliance issues will have a lower Tradeverifyd score.",
            "type": "integer",
            "nullable": true
          },
          "references": {
            "title": "Entity References",
            "description": "Summary counts of flags, relationships, and other references associated with this entity. Not specific to query.",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__entity_dto__EntityReferences",
            "nullable": true
          },
          "count_inferred_relationships": {
            "title": "Inferred Relationships Count",
            "description": "The number of inferred relationships in the graph.  Will not be present if the graph counts have not been calculated yet.",
            "$ref": "#/components/schemas/EntityGraphCounts",
            "nullable": true
          },
          "flagged": {
            "type": "boolean",
            "title": "Flagged",
            "description": "Whether the Entity has active Flags visible to the requesting organization.",
            "default": false
          },
          "has_positive_flags": {
            "type": "boolean",
            "title": "Has Positive Flags",
            "description": "Whether the Entity has any positive/compliant flags.",
            "default": false
          },
          "has_negative_flags": {
            "type": "boolean",
            "title": "Has Negative Flags",
            "description": "Whether the Entity has any negative/risk flags.",
            "default": false
          },
          "external_ids": {
            "title": "External Ids",
            "description": "External identifiers for the Entity.",
            "items": {
              "$ref": "#/components/schemas/ExternalEntityId"
            },
            "type": "array",
            "nullable": true
          },
          "hs_codes": {
            "description": "Harmonized System codes for products traded by this entity, organized by direction.",
            "$ref": "#/components/schemas/EntityHsCodes",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "jurisdiction",
          "created_at",
          "modified"
        ],
        "title": "GetEntityResponse",
        "description": "Response model for entities.\n\n Attributes:\n\n    id: Unique entity identifier.\n\n    name: Entity name.\n\n    description: Detailed information about the entity, covering its purpose,\n    background, or role.\n\n    primary_role: The primary role an entity plays.\n\n    aliases: Additional aliases that are associated with the entity.\n\n    url: The official website or a relevant online resource associated with the\n    entity.\n\n    jurisdiction: The country the entity is associated with.\n\n    addresses: The physical or registered addresses of the entity.\n\n    monitor: A boolean indicating if this entity's events will generate notifications.\n\n    created_at: Time the entity record was created.\n\n    modified: Time the record was last modified.\n\n    region: Entity's region code.\n\n    affiliated_jurisdiction: Supplemental jurisdiction information.\n\n    tradeverifyd_score: Computed Tradeverifyd score for the entity.\n\n    references: Summary counts of direct entity relationships and flags.\n\n    count_inferred_relationships: Optional value for number of inferred relationships in the entity graph, if already calculated."
      },
      "GetRiskEventsResponse": {
        "properties": {
          "facets": {
            "items": {
              "$ref": "#/components/schemas/Facet"
            },
            "type": "array",
            "title": "Facets",
            "description": "Per-facet metadata."
          },
          "page_results": {
            "items": {
              "$ref": "#/components/schemas/RiskEvent"
            },
            "type": "array",
            "title": "Page Results",
            "description": "1 page of queried Risk Event records."
          },
          "current_page": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Current Page",
            "description": "Current page."
          },
          "total_results": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Total Results",
            "description": "Total number of records that matched the query."
          }
        },
        "type": "object",
        "required": [
          "facets",
          "page_results",
          "current_page",
          "total_results"
        ],
        "title": "GetRiskEventsResponse",
        "description": "Response payload for GET RiskEvents query"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "HsCodes": {
        "properties": {
          "incoming": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Incoming",
            "description": "HS codes for products received by this entity"
          },
          "outgoing": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Outgoing",
            "description": "HS codes for products shipped by this entity"
          }
        },
        "type": "object",
        "title": "HsCodes",
        "description": "HS codes organized by direction (incoming/outgoing shipments)"
      },
      "IssuedVerifiableCredentialResponse": {
        "properties": {
          "credential_id": {
            "type": "string",
            "title": "Credential Id",
            "description": "The id of the issued verifiable credential"
          },
          "credential_media_type": {
            "type": "string",
            "title": "Credential Media Type",
            "description": "The media type of the issued verifiable credential"
          },
          "credential_content": {
            "type": "string",
            "format": "binary",
            "title": "Credential Content",
            "description": "The content of the issued verifiable credential"
          }
        },
        "type": "object",
        "required": [
          "credential_id",
          "credential_media_type",
          "credential_content"
        ],
        "title": "IssuedVerifiableCredentialResponse",
        "description": "Issued verifiable credential response"
      },
      "ProblematicEntity": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "flags": {
            "items": {
              "$ref": "#/components/schemas/VerificationFlag"
            },
            "type": "array",
            "title": "Flags",
            "default": []
          },
          "addresses": {
            "items": {
              "$ref": "#/components/schemas/Address"
            },
            "type": "array",
            "title": "Addresses",
            "default": []
          },
          "jurisdiction": {
            "type": "string",
            "title": "Jurisdiction"
          },
          "depth": {
            "type": "integer",
            "title": "Depth"
          },
          "tvpra_risks": {
            "items": {
              "$ref": "#/components/schemas/TVPRARisk"
            },
            "type": "array",
            "title": "Tvpra Risks",
            "default": []
          },
          "has_excessive_addresses": {
            "type": "boolean",
            "title": "Has Excessive Addresses",
            "default": false
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "jurisdiction",
          "depth"
        ],
        "title": "ProblematicEntity",
        "description": "An Entity identified as problematic during verification."
      },
      "PublicAbridgedGraph": {
        "properties": {
          "entrypoint": {
            "$ref": "#/components/schemas/PublicEntity",
            "nullable": true
          },
          "entities": {
            "items": {
              "$ref": "#/components/schemas/PublicEntity"
            },
            "type": "array",
            "title": "Entities"
          },
          "relationships": {
            "items": {
              "$ref": "#/components/schemas/PublicRelationship"
            },
            "type": "array",
            "title": "Relationships"
          },
          "page": {
            "type": "integer",
            "title": "Page",
            "default": 0
          },
          "page_size": {
            "type": "integer",
            "title": "Page Size",
            "default": 0
          },
          "records": {
            "type": "integer",
            "title": "Records",
            "default": 0
          },
          "total_records": {
            "title": "Total Records",
            "type": "integer",
            "nullable": true
          },
          "total_pages": {
            "title": "Total Pages",
            "type": "integer",
            "nullable": true
          },
          "entity_graph_counts": {
            "title": "Entity Graph Counts",
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "entities",
          "relationships"
        ],
        "title": "PublicAbridgedGraph",
        "description": "Public abridged graph response model"
      },
      "PublicEntity": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "jurisdiction": {
            "type": "string",
            "title": "Jurisdiction"
          },
          "flags": {
            "title": "Flags",
            "items": {
              "$ref": "#/components/schemas/PublicFlag"
            },
            "type": "array",
            "nullable": true
          },
          "coordinates": {
            "items": {
              "$ref": "#/components/schemas/Coordinate"
            },
            "type": "array",
            "title": "Coordinates",
            "default": []
          },
          "addresses": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Addresses",
            "default": []
          },
          "aliases": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Aliases",
            "default": []
          },
          "ids": {
            "items": {
              "$ref": "#/components/schemas/app__schemas__metadata__Identifier"
            },
            "type": "array",
            "title": "Ids",
            "default": []
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "jurisdiction"
        ],
        "title": "PublicEntity",
        "description": "Public entity response model - only exposes what consumers need"
      },
      "PublicFlag": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id"
          },
          "entity_id": {
            "type": "string",
            "title": "Entity Id"
          },
          "entity_jurisdiction": {
            "title": "Entity Jurisdiction",
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "title": "Type"
          },
          "subtype": {
            "type": "string",
            "title": "Subtype"
          },
          "flag_polarity": {
            "title": "Flag Polarity",
            "type": "integer",
            "nullable": true
          },
          "modified": {
            "type": "string",
            "format": "date-time",
            "title": "Modified"
          },
          "source": {
            "title": "Source",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "description": {
            "title": "Description",
            "type": "string",
            "nullable": true
          },
          "tags": {
            "title": "Tags",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "entity_id",
          "type",
          "subtype",
          "modified"
        ],
        "title": "PublicFlag",
        "description": "Public flag response model - only exposes what consumers need"
      },
      "PublicRelationship": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id"
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "Describes the relationship between subject and object."
          },
          "target": {
            "type": "string",
            "title": "Target",
            "description": "Entity at the destination of the relationship."
          },
          "source": {
            "type": "string",
            "title": "Source",
            "description": "Entity at the origin of the relationship."
          },
          "hs_codes": {
            "title": "Hs Codes",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "modified": {
            "type": "string",
            "format": "date-time",
            "title": "Modified"
          },
          "sources": {
            "title": "Sources",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "aliases": {
            "title": "Aliases",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "type",
          "target",
          "source",
          "modified"
        ],
        "title": "PublicRelationship",
        "description": "Public relationship response model - only exposes what consumers need"
      },
      "RelationshipTypeCategoriesResponse": {
        "properties": {
          "categories": {
            "items": {
              "$ref": "#/components/schemas/RelationshipTypeCategory"
            },
            "type": "array",
            "title": "Categories"
          }
        },
        "type": "object",
        "required": [
          "categories"
        ],
        "title": "RelationshipTypeCategoriesResponse",
        "description": "Response model for relationship type categories endpoint.\n\nAttributes:\n    categories: List of relationship type categories."
      },
      "RelationshipTypeCategory": {
        "properties": {
          "name": {
            "type": "string",
            "title": "Name",
            "description": "The category name"
          },
          "display_name": {
            "type": "string",
            "title": "Display Name",
            "description": "Human-readable name for the category"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Description of what this category represents"
          },
          "relationship_count": {
            "type": "integer",
            "title": "Relationship Count",
            "description": "Number of relationship types in this category"
          },
          "types": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Types",
            "description": "List of relationship type names in this category"
          }
        },
        "type": "object",
        "required": [
          "name",
          "display_name",
          "description",
          "relationship_count",
          "types"
        ],
        "title": "RelationshipTypeCategory",
        "description": "Response model for relationship type categories.\n\nAttributes:\n    name: The category name (e.g., ownership, supply_chain).\n    display_name: Human-readable name for the category.\n    description: Description of what this category represents.\n    relationship_count: Number of relationship types in this category.\n    types: List of relationship type names in this category."
      },
      "RelationshipTypeDetailResponse": {
        "properties": {
          "type": {
            "type": "string",
            "title": "Type",
            "description": "The type of relationship"
          },
          "display_name": {
            "type": "string",
            "title": "Display Name",
            "description": "Human-readable name for the relationship type"
          },
          "category": {
            "type": "string",
            "title": "Category",
            "description": "The category this relationship belongs to"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Description of what this relationship type means"
          },
          "bidirectional": {
            "type": "boolean",
            "title": "Bidirectional",
            "description": "Whether this relationship type is bidirectional"
          }
        },
        "type": "object",
        "required": [
          "type",
          "display_name",
          "category",
          "description",
          "bidirectional"
        ],
        "title": "RelationshipTypeDetailResponse",
        "description": "Enhanced response model for relationship types with additional metadata.\n\nAttributes:\n    type: The type of relationship (e.g., IS_SUPPLIER_OF, DIRECTLY_CONSOLIDATES).\n    display_name: Human-readable name for the relationship type.\n    category: The category this relationship belongs to (e.g., supply_chain, ownership).\n    description: A description of what this relationship type means.\n    bidirectional: Whether this relationship type is bidirectional."
      },
      "RelationshipTypeResponse": {
        "properties": {
          "relationship_type": {
            "type": "string",
            "title": "Relationship Type",
            "description": "The type of relationship"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Description of what this relationship type means"
          }
        },
        "type": "object",
        "required": [
          "relationship_type",
          "description"
        ],
        "title": "RelationshipTypeResponse",
        "description": "Response model for relationship types.\n\nAttributes:\n    relationship_type: The type of relationship (e.g., IS_SUPPLIER_OF, IS_OTHERWISE_LINKED_TO).\n    description: A description of what this relationship type means."
      },
      "ReportDetailResponse": {
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
          },
          "requested_ts": {
            "type": "string",
            "format": "date-time",
            "title": "Requested Ts"
          },
          "completed_ts": {
            "title": "Completed Ts",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "report_type": {
            "type": "string",
            "title": "Report Type"
          },
          "report_status": {
            "type": "string",
            "title": "Report Status"
          },
          "report_name": {
            "title": "Report Name",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "requested_ts",
          "completed_ts",
          "report_type",
          "report_status",
          "report_name"
        ],
        "title": "ReportDetailResponse",
        "description": "Report Detail Response"
      },
      "ReportStatusResponse": {
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
          },
          "status": {
            "type": "string",
            "title": "Status"
          }
        },
        "type": "object",
        "required": [
          "id",
          "status"
        ],
        "title": "ReportStatusResponse",
        "description": "Report Status Response"
      },
      "RequestIssueVerifiableCredential": {
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "nullable": true
          },
          "type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            ],
            "title": "Type"
          },
          "issuer": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "additionalProperties": true,
                "type": "object"
              }
            ],
            "title": "Issuer"
          },
          "validFrom": {
            "title": "Validfrom",
            "type": "string",
            "nullable": true
          },
          "validUntil": {
            "title": "Validuntil",
            "type": "string",
            "nullable": true
          },
          "credentialSubject": {
            "additionalProperties": true,
            "type": "object",
            "title": "Credentialsubject"
          },
          "proof": {
            "title": "Proof",
            "additionalProperties": true,
            "type": "object",
            "nullable": true
          },
          "credentialStatus": {
            "title": "Credentialstatus",
            "additionalProperties": true,
            "type": "object",
            "nullable": true
          },
          "credentialSchema": {
            "title": "Credentialschema",
            "additionalProperties": true,
            "type": "object",
            "nullable": true
          },
          "context": {
            "items": {
              "type": "string",
              "minLength": 1,
              "format": "uri"
            },
            "type": "array",
            "title": "Context"
          },
          "shipment_id": {
            "title": "Shipment Id",
            "description": "The shipment id of the shipment",
            "type": "string",
            "nullable": true
          },
          "folder_name": {
            "title": "Folder Name",
            "description": "The folder name of the folder within the shipment",
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": true,
        "type": "object",
        "required": [
          "type",
          "issuer",
          "credentialSubject",
          "shipment_id",
          "folder_name"
        ],
        "title": "RequestIssueVerifiableCredential",
        "description": "User supplied verifiable credential claimset\nThis model is updated / modified by the server before issuance\nBe careful trusting user supplied data"
      },
      "RiskEvent": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "Unique identifier for the Risk Event."
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp",
            "description": "Date and time when the Risk Event was detected"
          },
          "last_modified": {
            "type": "string",
            "format": "date-time",
            "title": "Last Modified",
            "description": "Last time Risk Event record was modified"
          },
          "countries": {
            "title": "Countries",
            "description": "Countries impacted by the Risk Event",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "time_start": {
            "title": "Time Start",
            "description": "Start time of the event.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "time_end": {
            "title": "Time End",
            "description": "End time of the event.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "title": {
            "type": "string",
            "title": "Title",
            "description": "Brief, descriptive title of the Risk Event."
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Detailed description of the Risk Event."
          },
          "sources": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Sources",
            "description": "Web resources that reference or describe the Risk Event."
          },
          "type": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "earthquake",
                  "hurricane",
                  "tsunami",
                  "flood",
                  "tornado",
                  "cyclone",
                  "volcanic_eruption",
                  "wildfire",
                  "drought",
                  "landslide",
                  "blizzard",
                  "ice_storm",
                  "heatwave",
                  "sandstorm",
                  "pandemic",
                  "insect_infestation"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "economic_sanction",
                  "trade_war",
                  "political_unrest",
                  "embargo",
                  "military_conflict",
                  "terrorist_attack"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "shipping_delay",
                  "port_congestion",
                  "transportation_strike",
                  "fuel_shortage",
                  "infrastructure_failure"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "raw_material_scarcity",
                  "component_shortage",
                  "semiconductor_shortage",
                  "crop_disease"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "strike",
                  "labor_shortage",
                  "skilled_labor_shortage",
                  "workforce_demographic_problem",
                  "forced_labor",
                  "child_labor"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "inflation",
                  "recession",
                  "economic_downturn",
                  "currency_fluctuation",
                  "interest_rate_change",
                  "stock_market_volatility"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "environmental_regulation",
                  "trade_regulation",
                  "labor_law",
                  "safety_regulation",
                  "compliance_standard"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "cyber_attack",
                  "data_breach",
                  "system_failure",
                  "technology_obsolete",
                  "software_bug"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "oil_price_increase",
                  "renewable_energy_outage",
                  "energy_rationing",
                  "nuclear_energy_incident"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "climate_change",
                  "biodiversity_loss",
                  "pollution",
                  "sustainable_resource_management"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "consumer_trend_shift",
                  "demand_surge",
                  "demand_slump",
                  "new_market_entrant"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "healthcare_system_overload"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "other"
                ]
              }
            ],
            "title": "Type",
            "description": "Type of the event"
          }
        },
        "type": "object",
        "required": [
          "id",
          "timestamp",
          "last_modified",
          "countries",
          "time_start",
          "time_end",
          "title",
          "description",
          "sources",
          "type"
        ],
        "title": "RiskEvent",
        "description": "Represents an event, encapsulating key information for tracking or\nmonitoring purposes within various applications.\n\nAttributes:\n\n    id:  Database identifier.\n\n    timestamp: Time the event occurred or was recorded.\n\n    last_modified: Last time Risk Event record was modified.\n\n    countries: A list of countries impacted by the Risk Event.\n\n    time_start: Start time of the event, marking the beginning of its\n    occurrence.\n\n    time_end: End time of the event, indicating when it concluded.\n\n    title: Brief, descriptive title of the event.\n\n    description: Summary of the RiskEvent.\n\n    sources: Web URLs that reference or describe the event.\n\n    type: The type of Risk Event."
      },
      "RiskEventSource": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "webpage"
            ],
            "title": "Type",
            "default": "webpage"
          },
          "url": {
            "type": "string",
            "minLength": 1,
            "title": "Url"
          },
          "publication_date": {
            "title": "Publication Date",
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "url"
        ],
        "title": "RiskEventSource",
        "description": "Reference to a webpage (usually a journalistic article) that reports and/or\ndescribes the RiskEvent.\n\nRiskEvents gleaned from (e.g.) uploaded text documents have a different\nsource type than RiskEvents found in web articles.\n\nAttributes:\n    type: The kind of source.\n\n    url: Web address of the source.\n\n    publication_date: Optional date when the source was published."
      },
      "RiskEvents": {
        "properties": {
          "total": {
            "type": "integer",
            "title": "The number of risk events found on an entity.",
            "default": 0
          }
        },
        "type": "object",
        "title": "RiskEvents"
      },
      "ShipmentDetailResponse": {
        "properties": {
          "shipment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shipment Id",
            "description": "Identifier for the shipment."
          },
          "shipment_name": {
            "type": "string",
            "title": "Shipment Name",
            "description": "Name of the shipment"
          },
          "organization": {
            "type": "string",
            "title": "Organization",
            "description": "Organization to which the shipment belongs."
          },
          "organizational_unit": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Organizational Unit",
            "description": "Subunit(s) of the organization."
          },
          "detention_id": {
            "title": "Detention Id",
            "description": "Identifier of the detention for the shipment, if applicable.",
            "type": "string",
            "nullable": true
          },
          "folder": {
            "type": "string",
            "title": "Folder",
            "description": "Folder location for the shipment."
          },
          "origin": {
            "title": "Origin",
            "description": "Location of the shipment's origin.",
            "type": "string",
            "nullable": true
          },
          "destination": {
            "title": "Destination",
            "description": "Location of the shipment's destination.",
            "type": "string",
            "nullable": true
          },
          "departure_date": {
            "title": "Departure Date",
            "description": "Date of the shipment's departure.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "arrival_date": {
            "title": "Arrival Date",
            "description": "Date of the shipment's arrival.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/ShipmentStatus"
          },
          "active": {
            "type": "boolean",
            "title": "Active",
            "description": "Boolean signifying if the shipment is active or inactive.",
            "default": true
          },
          "created": {
            "title": "Created",
            "description": "Date when the shipment record was created.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "last_modified": {
            "title": "Last Modified",
            "description": "Date when the shipment record was last modified.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "shipment_id",
          "shipment_name",
          "organization",
          "organizational_unit",
          "folder",
          "status"
        ],
        "title": "ShipmentDetailResponse",
        "description": "Response model for a shipment response."
      },
      "ShipmentListingResponse": {
        "properties": {
          "shipments": {
            "items": {
              "$ref": "#/components/schemas/ShipmentResponse"
            },
            "type": "array",
            "title": "Shipments",
            "description": "List of shipments that belong to user's organization and match search parameters."
          },
          "pagination": {
            "description": "Details of the API's paginated response.",
            "$ref": "#/components/schemas/earthstream_services__services__shipment__common__models__Pagination",
            "nullable": true
          },
          "filters": {
            "title": "Filters",
            "description": "Details of the API's filters, if applicable.",
            "additionalProperties": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "type": "object",
            "nullable": true
          },
          "sorting": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Sorting",
            "description": "Describes sorting method for the response, if applicable."
          }
        },
        "type": "object",
        "required": [
          "shipments",
          "pagination",
          "filters",
          "sorting"
        ],
        "title": "ShipmentListingResponse",
        "description": "Response model for a list of shipments"
      },
      "ShipmentResponse": {
        "properties": {
          "shipment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shipment Id",
            "description": "Shipment identifier."
          },
          "shipment_name": {
            "type": "string",
            "title": "Shipment Name",
            "description": "Name of shipment."
          },
          "organization": {
            "type": "string",
            "title": "Organization",
            "description": "Organization to which the shipment belongs."
          },
          "organizational_units": {
            "title": "Organizational Units",
            "description": "Optional field for subunits of the organization.",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/ShipmentStatus"
          },
          "active": {
            "type": "boolean",
            "title": "Active",
            "description": "Boolean signifying if the shipment is active or inactive."
          },
          "created": {
            "title": "Created",
            "description": "Date when the shipment record was created.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "last_modified": {
            "title": "Last Modified",
            "description": "Date when the shipment record was last modified.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "shipment_id",
          "shipment_name",
          "organization",
          "organizational_units",
          "status",
          "active"
        ],
        "title": "ShipmentResponse",
        "description": "Response model for a shipment."
      },
      "ShipmentStatus": {
        "type": "string",
        "enum": [
          "Created",
          "In Transit",
          "Detained",
          "Complete"
        ],
        "title": "ShipmentStatus",
        "description": "Enum for shipment status."
      },
      "ShipmentUploadResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success",
            "description": "Boolean indicating if file upload was successful."
          },
          "shipment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shipment Id",
            "description": "Identifier for shipment."
          },
          "url": {
            "type": "string",
            "title": "Url",
            "description": "URL for file, if applicable."
          },
          "file_id": {
            "title": "File Id",
            "description": "Unique identifier for file.",
            "type": "string",
            "format": "uuid",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "success",
          "shipment_id",
          "url"
        ],
        "title": "ShipmentUploadResponse",
        "description": "Response for a shipment upload."
      },
      "Source": {
        "properties": {
          "id": {
            "title": "Source Identifier",
            "description": "Unique identifier for the source.",
            "type": "string",
            "maxLength": 128,
            "nullable": true
          },
          "url": {
            "title": "Source URL",
            "description": "Web address where the source is located.",
            "type": "string",
            "nullable": true
          },
          "title": {
            "title": "Source Title",
            "description": "Title of the web resource.",
            "type": "string",
            "maxLength": 512,
            "nullable": true
          },
          "full_text": {
            "title": "Source Full Text",
            "description": "Complete textual content of the resource.",
            "type": "string",
            "maxLength": 10000,
            "nullable": true
          },
          "signature": {
            "title": "Source Signature",
            "description": "Digital signature associated with the source for verification purposes.",
            "additionalProperties": {
              "type": "string"
            },
            "type": "object",
            "nullable": true
          },
          "translations": {
            "title": "Translations",
            "description": "Any translations made of the source text",
            "items": {
              "$ref": "#/components/schemas/Translation"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "url"
        ],
        "title": "Source",
        "description": "Represents a web-based resource or document, providing key identification\nand content details.\n\nAttributes:\n    id: A unique identifier for the source, useful in tracking\n        or referencing.\n    url: The web address where the source can be accessed,\n        providing direct linkage.\n    title: The title of the web resource, summarizing its content\n        or purpose.\n    full_text: The complete textual content of the resource,\n        useful for analysis or reference.\n    signature: A digital signature associated with the source,\n        serving as a means of verification or authenticity.\n    translations: Any translations of the source\n\nNote:\n    This model is adaptable for inclusion of additional metadata\n    fields to enrich the description and context of the source."
      },
      "SubmitPresentationRequest": {
        "properties": {
          "shipment_id": {
            "type": "string",
            "title": "Shipment ID",
            "description": "The shipment ID from tradeverifyd"
          },
          "credential_ids": {
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "type": "array",
            "title": "Credential IDs",
            "description": "The IDs of the verifiable credentials to submit"
          }
        },
        "type": "object",
        "required": [
          "shipment_id",
          "credential_ids"
        ],
        "title": "SubmitPresentationRequest",
        "description": "A request to submit a presentation to US Customs"
      },
      "SubmitPresentationResponse": {
        "properties": {
          "response_code": {
            "type": "integer",
            "title": "Response Code",
            "description": "The response code from the US Customs API"
          },
          "message": {
            "type": "string",
            "title": "Response Message",
            "description": "A message from the US Customs API"
          },
          "cbp_request": {
            "title": "CBP Request",
            "description": "The saved CBP Request record",
            "$ref": "#/components/schemas/earthstream_services__services__us_customs__schemas__us_customs__CBPRequest",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "response_code",
          "message"
        ],
        "title": "SubmitPresentationResponse",
        "description": "A response from submitting a presentation to US Customs"
      },
      "SuggestedContactAddress": {
        "properties": {
          "streetAddress": {
            "title": "Streetaddress",
            "description": "Street address for the suggested supplier contact.",
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "title": "Addressline2",
            "description": "Continued address for the suggested supplier contact.",
            "type": "string",
            "nullable": true
          },
          "city": {
            "title": "City",
            "description": "City for the suggested supplier contact.",
            "type": "string",
            "nullable": true
          },
          "stateOrProvince": {
            "title": "Stateorprovince",
            "description": "State or providence for the suggested supplier contact.",
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "title": "Postalcode",
            "description": "Postal code for the suggested supplier contact.",
            "type": "string",
            "nullable": true
          },
          "country": {
            "title": "Country",
            "description": "Country for the suggested supplier contact.",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "title": "SuggestedContactAddress",
        "description": "Response model for a street address of a suggested supplier contact"
      },
      "SuggestedContactCitation": {
        "properties": {
          "source": {
            "title": "Source",
            "description": "Name of the suggested supplier contact reference.",
            "type": "string",
            "nullable": true
          },
          "url": {
            "title": "Url",
            "description": "URL for the suggested supplier contact reference.",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "title": "SuggestedContactCitation",
        "description": "Citation information for suggested supplier contact references."
      },
      "SupplierInformationRequestDetailResponse": {
        "properties": {
          "sir_id": {
            "type": "string",
            "format": "uuid",
            "title": "Sir Id",
            "description": "Database ID of supplier information request record."
          },
          "shipment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shipment Id",
            "description": "ID of shipment."
          },
          "supplier_name": {
            "type": "string",
            "title": "Supplier Name",
            "description": "Name of the supplier."
          },
          "supplier_jurisdiction": {
            "type": "string",
            "title": "Supplier Jurisdiction",
            "description": "Jurisdiction of the supplier."
          },
          "supplier_parent_name": {
            "title": "Supplier Parent Name",
            "description": "Name of the supplier parent.",
            "type": "string",
            "nullable": true
          },
          "supplier_parent_jurisdiction": {
            "title": "Supplier Parent Jurisdiction",
            "description": "Jurisdiction of the supplier parent.",
            "type": "string",
            "nullable": true
          },
          "supplier_domain": {
            "title": "Supplier Domain",
            "description": "URL domain of the supplier.",
            "type": "string",
            "nullable": true
          },
          "supplier_address": {
            "title": "Supplier Address",
            "description": "Address of the supplier.",
            "type": "string",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/SupplierInformationRequestStatus"
          },
          "tradeverifyd_score": {
            "title": "Tradeverifyd Score",
            "description": "Tradeverifyd Score associated with the supplier.",
            "type": "number",
            "nullable": true
          },
          "supplier_hs_codes": {
            "title": "Supplier Hs Codes",
            "description": "List of HS codes associated with the supplier.",
            "type": "string",
            "nullable": true
          },
          "related_parts": {
            "title": "Related Parts",
            "description": "Brief description of the parts related to the SIR.",
            "type": "string",
            "nullable": true
          },
          "product": {
            "title": "Product",
            "description": "Product associated with the SIR.",
            "type": "string",
            "nullable": true
          },
          "timeframe_start": {
            "title": "Timeframe Start",
            "description": "Start date of the SIR.",
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "timeframe_stop": {
            "title": "Timeframe Stop",
            "description": "End date of the SIR.",
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "reports": {
            "title": "Reports",
            "description": "Reports associated with the SIR.",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "entity_id": {
            "title": "Entity Id",
            "description": "ID of the entity associated with the SIR.",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "sir_id",
          "shipment_id",
          "supplier_name",
          "supplier_jurisdiction",
          "status"
        ],
        "title": "SupplierInformationRequestDetailResponse",
        "description": "Supplier information request detail response."
      },
      "SupplierInformationRequestFilter": {
        "properties": {
          "supplier_name": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Supplier Name",
            "description": "Supplier name(s) used to filter responses."
          },
          "supplier_jurisdiction": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Supplier Jurisdiction",
            "description": "Supplier jurisdiction(s) used to filter responses."
          },
          "status": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Status",
            "description": "Status used to filter responses."
          },
          "tradeverifyd_score": {
            "items": {},
            "type": "array",
            "title": "Tradeverifyd Score",
            "description": "Tradeverifyd Score used to filter responses."
          }
        },
        "type": "object",
        "required": [
          "supplier_name",
          "supplier_jurisdiction",
          "status",
          "tradeverifyd_score"
        ],
        "title": "SupplierInformationRequestFilter",
        "description": "Wrapper for SIR filters"
      },
      "SupplierInformationRequestListing": {
        "properties": {
          "requests": {
            "items": {
              "$ref": "#/components/schemas/SupplierInformationRequestResponse"
            },
            "type": "array",
            "title": "Requests",
            "description": "List of supplier information requests."
          },
          "pagination": {
            "description": "Details of the API's paginated response.",
            "$ref": "#/components/schemas/earthstream_services__services__shipment__common__models__Pagination",
            "nullable": true
          },
          "sorting": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Sorting",
            "description": "Describes sorting method for the response, if applicable."
          },
          "filters": {
            "description": "Details of the API's filters, if applicable.",
            "$ref": "#/components/schemas/SupplierInformationRequestFilter",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "requests",
          "pagination",
          "sorting",
          "filters"
        ],
        "title": "SupplierInformationRequestListing",
        "description": "Wrapper for SIR responses"
      },
      "SupplierInformationRequestResponse": {
        "properties": {
          "sir_id": {
            "type": "string",
            "format": "uuid",
            "title": "Sir Id",
            "description": "Identifier of supplier information request record."
          },
          "supplier_name": {
            "type": "string",
            "title": "Supplier Name",
            "description": "Name of the supplier."
          },
          "supplier_jurisdiction": {
            "type": "string",
            "title": "Supplier Jurisdiction",
            "description": "Jurisdiction of the supplier."
          },
          "status": {
            "$ref": "#/components/schemas/SupplierInformationRequestStatus"
          },
          "tradeverifyd_score": {
            "title": "Tradeverifyd Score",
            "description": "Tradeverifyd Score associated with the supplier.",
            "type": "number",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "sir_id",
          "supplier_name",
          "supplier_jurisdiction",
          "status"
        ],
        "title": "SupplierInformationRequestResponse",
        "description": "Response model for a supplier information request."
      },
      "SupplierInformationRequestStatus": {
        "type": "string",
        "enum": [
          "Not Contacted",
          "Documents Requested",
          "Documents Received",
          "Eliminated"
        ],
        "title": "SupplierInformationRequestStatus",
        "description": "Enum for supplier information request status."
      },
      "SupplierInformationSuggestedContactResponse": {
        "properties": {
          "info_type": {
            "title": "Info Type",
            "description": "Describes the type of contact information found.",
            "type": "string",
            "nullable": true
          },
          "name": {
            "title": "Name",
            "description": "Name of the supplier.",
            "type": "string",
            "nullable": true
          },
          "website": {
            "title": "Website",
            "description": "The supplier's website.",
            "type": "string",
            "nullable": true
          },
          "contactPhone": {
            "title": "Contactphone",
            "description": "The contact phone number for the supplier.",
            "type": "string",
            "nullable": true
          },
          "address": {
            "$ref": "#/components/schemas/SuggestedContactAddress",
            "nullable": true
          },
          "citations": {
            "title": "Citations",
            "description": "References for the suggested supplier contacts.",
            "default": [],
            "items": {
              "$ref": "#/components/schemas/SuggestedContactCitation"
            },
            "type": "array",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "address"
        ],
        "title": "SupplierInformationSuggestedContactResponse",
        "description": "Response model for suggested contact information for a supplier"
      },
      "TASAContentsResponse": {
        "properties": {
          "importer_name": {
            "type": "string",
            "title": "Importer Name",
            "description": "The party requesting the report. This entity may be the importer of record but could also be another customer or stakeholder seeking visibility into the supplier."
          },
          "entity_id": {
            "type": "string",
            "title": "Entity Id",
            "description": "The unique database identifier for the entity for which the report was run."
          },
          "entity_identifiers": {
            "items": {
              "$ref": "#/components/schemas/ExternalEnttiyId"
            },
            "type": "array",
            "title": "Entity Identifiers",
            "description": "List of known external IDs for the entity."
          },
          "entity_name": {
            "type": "string",
            "title": "Entity Name",
            "description": "The name of the entity for which the report was run."
          },
          "summary": {
            "type": "string",
            "title": "Summary",
            "description": "Brief summary of the report."
          },
          "supplier_names": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Supplier Names",
            "description": "List of the names of suppliers in the report."
          },
          "shipment_description": {
            "type": "string",
            "title": "Shipment Description",
            "description": "Brief description of the shipment."
          },
          "score": {
            "type": "integer",
            "title": "Score",
            "description": "Tradeverifyd Score assigned to the entity in the report."
          },
          "regulations_checked": {
            "type": "string",
            "title": "Regulations Checked",
            "description": "The regulations checked in the report."
          },
          "flagged_entities": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Flagged Entities",
            "description": "List of entities that appear in the report and contain positive or negative flags."
          },
          "relationships": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Relationships",
            "description": "List of relationships between entities for the given report."
          },
          "entities": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Entities",
            "description": "List of entities involved in the report."
          },
          "report_id": {
            "type": "string",
            "format": "uuid",
            "title": "Report Id",
            "description": "Unique ID (uuid) of the report."
          }
        },
        "type": "object",
        "required": [
          "importer_name",
          "entity_id",
          "entity_identifiers",
          "entity_name",
          "summary",
          "supplier_names",
          "shipment_description",
          "score",
          "regulations_checked",
          "flagged_entities",
          "relationships",
          "entities",
          "report_id"
        ],
        "title": "TASAContentsResponse",
        "description": "Contents response for a TASA (SVR) report"
      },
      "TVPRARisk": {
        "properties": {
          "risk_type": {
            "type": "string",
            "title": "Risk Type"
          },
          "suspect_hs_codes": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Suspect Hs Codes"
          }
        },
        "type": "object",
        "required": [
          "risk_type",
          "suspect_hs_codes"
        ],
        "title": "TVPRARisk",
        "description": "Information about high-risk goods."
      },
      "TopSupplierConnection": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "jurisdiction": {
            "type": "string",
            "title": "Jurisdiction"
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "jurisdiction"
        ],
        "title": "TopSupplierConnection",
        "description": "Top supplier connection"
      },
      "Translation": {
        "properties": {
          "translated_text": {
            "type": "string",
            "title": "Translated Text",
            "description": "The full translated text"
          },
          "source_lang": {
            "type": "string",
            "maxLength": 2,
            "title": "Source Language",
            "description": "The ISO 639 code for the language of the source text"
          },
          "result_lang": {
            "type": "string",
            "maxLength": 2,
            "title": "Result Language",
            "description": "The ISO 639 code for the language to which the source text has been translated"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "title": "Translation Time",
            "description": "The date and time the translation was made"
          },
          "model": {
            "title": "Model",
            "description": "The model used to perform the translation",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "translated_text",
          "source_lang",
          "result_lang",
          "timestamp"
        ],
        "title": "Translation",
        "description": "Represents a translation of a text.\n\nAttributes:\n    translated_text: the full text of the translation.\n    source_lang: the language of the source text.\n    result_lang: the language of the resulting translation.\n    timestamp: the date and time the translation was made.\n    model: the model used to perfom the translation."
      },
      "UpdateFlagResponse": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Flag Identifier",
            "description": "Unique identifier for the flag."
          },
          "entity_id": {
            "type": "string",
            "title": "Entity Id",
            "description": "ID of the Entity that this Flag is associated with"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Flag Timestamp",
            "description": "Timestamp indicating when the flag was created or recorded."
          },
          "time_start": {
            "title": "Flag Start Time",
            "description": "Beginning time when the flag becomes relevant or active.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "time_end": {
            "title": "Flag End Time",
            "description": "Ending time after which the flag is no longer considered relevant.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "type": {
            "type": "string",
            "title": "Flag Type",
            "description": "Describes the _id of corresponding flag type in Mongo."
          },
          "description": {
            "title": "Flag Description",
            "description": "Optional field for describing the flag's purpose and significance.",
            "type": "string",
            "maxLength": 4096,
            "nullable": true
          },
          "sources": {
            "title": "Flag Sources",
            "description": "Optional list of sources or references that provide information or evidence related to the flag.",
            "items": {
              "$ref": "#/components/schemas/Source"
            },
            "type": "array",
            "nullable": true
          },
          "status": {
            "title": "Status",
            "description": "The status of the flag, with a confidence level and source data.",
            "$ref": "#/components/schemas/DataStatus",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "entity_id",
          "created_at",
          "type"
        ],
        "title": "UpdateFlagResponse",
        "description": "Response model for updated flags"
      },
      "UpdateShipmentRequest": {
        "properties": {
          "shipment_name": {
            "type": "string",
            "title": "Shipment Name",
            "description": "Name of shipment."
          },
          "origin": {
            "title": "Origin",
            "description": "Location of the shipment's origin.",
            "type": "string",
            "nullable": true
          },
          "destination": {
            "title": "Destination",
            "description": "Location of the shipment's destination.",
            "type": "string",
            "nullable": true
          },
          "departure_date": {
            "title": "Departure Date",
            "description": "Date of the shipment's departure.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "arrival_date": {
            "title": "Arrival Date",
            "description": "Date of the shipment's arrival.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/ShipmentStatus"
          },
          "active": {
            "type": "boolean",
            "title": "Active",
            "description": "Boolean signifying if the shipment is active or inactive.",
            "default": true
          },
          "organizational_units": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Organizational Units",
            "description": "Subunit(s) of the organization."
          },
          "detention_id": {
            "title": "Detention Id",
            "description": "Databaes ID of the detention for the shipment, if applicable.",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "shipment_name",
          "status",
          "organizational_units"
        ],
        "title": "UpdateShipmentRequest",
        "description": "Model for updating a shipment."
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "VerificationFlag": {
        "properties": {
          "sources": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Sources",
            "default": []
          },
          "type": {
            "type": "string",
            "title": "Type"
          },
          "subtype": {
            "type": "string",
            "title": "Subtype"
          },
          "flag_polarity": {
            "title": "Flag Polarity",
            "type": "integer",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "type",
          "subtype"
        ],
        "title": "VerificationFlag",
        "description": "Information about a Flag."
      },
      "WSCContentsResponse": {
        "properties": {
          "report_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ],
            "title": "Report Id",
            "description": "Unique ID (uuid) of the report."
          },
          "report_type": {
            "type": "string",
            "const": "wsc",
            "title": "Report Type",
            "description": "The type of report requested."
          },
          "summary": {
            "type": "string",
            "title": "Summary",
            "description": "Brief summary of the report."
          },
          "summary_bullets": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Summary Bullets",
            "description": "Key points from the report's summary."
          },
          "risk_events": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Risk Events",
            "description": "Risk events included in the report."
          },
          "supply_chains": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array",
            "title": "Supply Chains",
            "description": "Supply chains included in the report."
          }
        },
        "type": "object",
        "required": [
          "report_id",
          "report_type",
          "summary",
          "summary_bullets",
          "risk_events",
          "supply_chains"
        ],
        "title": "WSCContentsResponse",
        "description": "Contents response for a WSC report"
      },
      "app__api__internal__schemas__reports__Pagination": {
        "properties": {
          "current_page": {
            "type": "integer",
            "title": "Current Page"
          },
          "page_size": {
            "type": "integer",
            "title": "Page Size"
          },
          "total_pages": {
            "type": "integer",
            "title": "Total Pages"
          },
          "total_records": {
            "type": "integer",
            "title": "Total Records"
          }
        },
        "type": "object",
        "required": [
          "current_page",
          "page_size",
          "total_pages",
          "total_records"
        ],
        "title": "Pagination",
        "description": "Using to return paging information to the client\ncurrent_page: the current page of data\ntotal_pages: the total number of pages\ntotal_records: the number of records found\npage_size: the current page size"
      },
      "app__schemas__metadata__Identifier": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Identifier",
            "description": "An identifer, e.g., a GTIN or CIN"
          },
          "active": {
            "type": "boolean",
            "title": "Active Status",
            "description": "A boolean field indicating if the object is active. Setting this to False acts as a soft delete.",
            "default": true
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "title": "Date Added",
            "description": "The date and time when the object was added."
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "The type of identifier, e.g., a GTIN or CIN"
          },
          "source": {
            "title": "Source",
            "description": "A URL that can be dereferenced to provide more information about the id",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "type"
        ],
        "title": "Identifier",
        "description": "Represents an identifier that can be used for an entity, along with the\nidentifier type and a source URL.\n\nAttributes:\n    id: the value of the identifier.\n    type: the type of the identifier.\n    url: a URL source for the identifier."
      },
      "app__schemas__shipments__CBPRequest": {
        "properties": {
          "id": {
            "title": "Id",
            "description": "The identifier for the CBP Request",
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "created": {
            "title": "Created",
            "description": "The timestamp of when the CBP was created",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "last_modified": {
            "title": "Last Modified",
            "description": "The timestamp of the last modification to the CBP",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "shipment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shipment Id",
            "description": "The ID of the Shipment to which the CBP belongs"
          },
          "vc_ids": {
            "title": "Vc Ids",
            "description": "A list of related VC ids",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "presentation": {
            "title": "Presentation",
            "description": "The raw data of the Presentation submitted to CBP.",
            "type": "string",
            "nullable": true
          },
          "presentation_id": {
            "title": "Presentation Id",
            "description": "The CBP may be related to a presentation",
            "type": "string",
            "nullable": true
          },
          "submitted_date": {
            "type": "string",
            "format": "date-time",
            "title": "Submitted Date",
            "description": "The timestamp of when the request was submitted to CBP"
          },
          "cbp_response_code": {
            "title": "Cbp Response Code",
            "description": "The response code, if any, from CBP",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "created",
          "last_modified",
          "shipment_id",
          "vc_ids",
          "presentation",
          "presentation_id",
          "submitted_date",
          "cbp_response_code"
        ],
        "title": "CBPRequest",
        "description": "CBP Request information (shared schema for both public and internal APIs)"
      },
      "earthstream_services__services__entity__common__entity_dto__EntityReferences": {
        "properties": {
          "flags": {
            "title": "Information about flags found for an entity",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__search_models__Flags",
            "nullable": true
          },
          "relationships": {
            "title": "Information about relationships for an entity",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__entity_dto__Relationships",
            "nullable": true
          }
        },
        "type": "object",
        "title": "EntityReferences"
      },
      "earthstream_services__services__entity__common__entity_dto__RelationshipCount": {
        "properties": {
          "count": {
            "type": "integer",
            "title": "The number of relationships found on an entity.",
            "default": 0
          }
        },
        "type": "object",
        "title": "RelationshipCount"
      },
      "earthstream_services__services__entity__common__entity_dto__Relationships": {
        "properties": {
          "total": {
            "type": "integer",
            "title": "The number of relationships the entity is linked with",
            "default": 0
          },
          "from_relationships": {
            "title": "\n            The relationships where the given entity is on the 'from' side.\n            These relationships are considered 'outbound' from the entity.\n        ",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__entity_dto__RelationshipCount",
            "nullable": true
          },
          "to_relationships": {
            "title": "\n            The relationships where the given entity is on the 'to' side.\n            These relationships are considered 'inbound' to the entity.\n        ",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__entity_dto__RelationshipCount",
            "nullable": true
          }
        },
        "type": "object",
        "title": "Relationships"
      },
      "earthstream_services__services__entity__common__search_models__EntityReferences": {
        "properties": {
          "flags": {
            "title": "Information about flags found for an entity",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__search_models__Flags",
            "nullable": true
          },
          "relationships": {
            "title": "Information about relationships for an entity",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__search_models__Relationships",
            "nullable": true
          },
          "risk_events": {
            "title": "Information about risk events for an entity",
            "$ref": "#/components/schemas/RiskEvents",
            "nullable": true
          }
        },
        "type": "object",
        "title": "EntityReferences"
      },
      "earthstream_services__services__entity__common__search_models__Flags": {
        "properties": {
          "total": {
            "type": "integer",
            "title": "The number of flags found on an entity.",
            "default": 0
          }
        },
        "type": "object",
        "title": "Flags"
      },
      "earthstream_services__services__entity__common__search_models__Relationships": {
        "properties": {
          "total": {
            "type": "integer",
            "title": "The number of relationships the entity is linked with",
            "default": 0
          },
          "from_relationships": {
            "title": "The relationships where the given entity in on the from side",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__entity_dto__RelationshipCount",
            "nullable": true
          },
          "to_relationships": {
            "title": "The relationships where the given entity in on the to side",
            "$ref": "#/components/schemas/earthstream_services__services__entity__common__entity_dto__RelationshipCount",
            "nullable": true
          }
        },
        "type": "object",
        "title": "Relationships"
      },
      "earthstream_services__services__shipment__common__models__Pagination": {
        "properties": {
          "current_page": {
            "type": "integer",
            "title": "Current Page",
            "description": "Current page of results."
          },
          "page_size": {
            "type": "integer",
            "title": "Page Size",
            "description": "Number of shipments on current page."
          },
          "total_pages": {
            "type": "integer",
            "title": "Total Pages",
            "description": "Total number of pages in API response."
          },
          "total_records": {
            "type": "integer",
            "title": "Total Records",
            "description": "Total number of records in API response."
          }
        },
        "type": "object",
        "required": [
          "current_page",
          "page_size",
          "total_pages",
          "total_records"
        ],
        "title": "Pagination",
        "description": "Using to return paging information to the client.\n\ncurrent_page: the current page of data\n\ntotal_pages: the total number of pages\n\ntotal_records: the number of records found\n\npage_size: the current page size"
      },
      "earthstream_services__services__us_customs__schemas__us_customs__CBPRequest": {
        "properties": {
          "id": {
            "title": "CBP Request ID",
            "description": "The identifier for the CBP Request",
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "created": {
            "title": "Creation Timestamp",
            "description": "The timestamp of when the CBP was created",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "last_modified": {
            "title": "Last Modified Timestamp",
            "description": "The timestamp of the last modification to the CBP",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "shipment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shipment ID",
            "description": "The ID of the Shipment to which the CBP belongs"
          },
          "vc_ids": {
            "title": "Verifiable Credential IDs",
            "description": "A list of related VC ids",
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true
          },
          "presentation": {
            "title": "Presentation Data",
            "description": "The raw data of the Presentation submitted to CBP",
            "type": "string",
            "nullable": true
          },
          "presentation_id": {
            "title": "Presentation ID",
            "description": "The CBP may be related to a presentation",
            "type": "string",
            "nullable": true
          },
          "user_email": {
            "type": "string",
            "title": "User Email",
            "description": "The user who initiated the CBP"
          },
          "submitted_date": {
            "type": "string",
            "format": "date-time",
            "title": "Submission Date",
            "description": "The timestamp of the when the request was submitted to CBP"
          },
          "cbp_response_code": {
            "title": "CBP Response Code",
            "description": "The response code, if any, from CBP",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "id",
          "created",
          "last_modified",
          "shipment_id",
          "vc_ids",
          "presentation",
          "presentation_id",
          "user_email",
          "submitted_date",
          "cbp_response_code"
        ],
        "title": "CBPRequest",
        "description": "The object type for a CBP Request"
      },
      "mesur_data_access__tradeverifyd__datamodels__common__Identifier": {
        "properties": {
          "type": {
            "type": "string",
            "title": "Type"
          },
          "source": {
            "type": "string",
            "title": "Source"
          },
          "id": {
            "type": "string",
            "title": "Id"
          }
        },
        "type": "object",
        "required": [
          "type",
          "source",
          "id"
        ],
        "title": "Identifier",
        "description": "External ID for an entity"
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "ocp-apim-subscription-key"
      }
    }
  },
  "tags": [
    {
      "name": "Entity",
      "description": "Operations involving entities. Entities encompass a range of organizations and individuals, primarily focusing on companies. This section provides functionalities to manage and interact with information about various entities, including their details, activities, and roles in the supply chain."
    },
    {
      "name": "Relationships",
      "description": "Relationships between entities"
    },
    {
      "name": "Flags",
      "description": "Flags impacting an entity"
    },
    {
      "name": "Risk Events",
      "description": "Manage and retrieve events related to entities. This includes real-time updates on critical incidents like supply chain disruptions, compliance issues, or significant changes affecting entities. Stay informed about vital events that could impact your business operations and decision-making processes."
    },
    {
      "name": "Documents",
      "description": "Operations involving documents"
    },
    {
      "name": "Shipments",
      "description": "Operations involving shipments"
    },
    {
      "name": "Reports",
      "description": "Access detailed Tradeverifyd reports. These comprehensive reports offer an in-depth analysis of suppliers, complete with compliance scoring to highlight potential trade-related issues. Utilize these reports for thorough assessments of supplier reliability, compliance status, and overall performance in the supply chain."
    },
    {
      "name": "Verifiable Credentials",
      "description": "Operations involving verifiable credentials"
    },
    {
      "name": "System",
      "description": "System operations and monitoring"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}