{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/v1/attribute":{"post":{"operationId":"attributes_postAttribute","summary":"Post Attribute","description":"Adds a new attribute to an entity in the project","tags":["attributes"],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/attributes_AttributeResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/attributes_AddAttribute"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/attribute/{attributeId}":{"patch":{"operationId":"attributes_patchAttribute","summary":"Patch Attribute","description":"<Warning>This endpoint is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> Updates an existing Attribute","tags":["attributes"],"parameters":[{"name":"attributeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/attributes_AttributeResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/attributes_UpdateAttribute"}}}},"security":[{"OAuthScheme":[]}]},"delete":{"operationId":"attributes_deleteAttribute","summary":"Delete Attribute","description":"<Warning>This endpoint is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> Delete an existing Attribute","tags":["attributes"],"parameters":[{"name":"attributeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/attributes_AttributeResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/oauth/token":{"post":{"operationId":"auth_getToken","summary":"Get Token","description":"Hit the auth endpoint to get a bearer token","tags":["auth"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth_AuthResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"audience":{"type":"string","enum":["sayari.com"]},"grant_type":{"type":"string","enum":["client_credentials"]}},"required":["client_id","client_secret","audience","grant_type"]}}}}}},"/v1/entity/{id}":{"get":{"operationId":"entity_getEntity","summary":"Get Entity","description":"<Note>To retrieve a L1 Due Dilligence PDF Report. Include 'Accept: application/pdf' in request headers.</Note> Retrieve an entity profile from the database based on the entity ID. This endpoint returns the full profile, entity_summary returns the same payload minus relationships.","tags":["entity"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the entity","required":true,"schema":{"type":"string"}},{"name":"attributes.additional_information.next","in":"query","description":"The pagination token for the next page of attribute `additional_information`.","required":false,"schema":{"type":"string"}},{"name":"attributes.additional_information.prev","in":"query","description":"The pagination token for the previous page of attribute `additional_information`.","required":false,"schema":{"type":"string"}},{"name":"attributes.additional_information.limit","in":"query","description":"Limit total values returned for attribute `additional_information`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.address.next","in":"query","description":"The pagination token for the next page of attribute `address`.","required":false,"schema":{"type":"string"}},{"name":"attributes.address.prev","in":"query","description":"The pagination token for the previous page of attribute `address`.","required":false,"schema":{"type":"string"}},{"name":"attributes.address.limit","in":"query","description":"Limit total values returned for attribute `address`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.business_purpose.next","in":"query","description":"The pagination token for the next page of attribute `business_purpose`.","required":false,"schema":{"type":"string"}},{"name":"attributes.business_purpose.prev","in":"query","description":"The pagination token for the previous page of attribute `business_purpose`.","required":false,"schema":{"type":"string"}},{"name":"attributes.business_purpose.limit","in":"query","description":"Limit total values returned for attribute `business_purpose`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.company_type.next","in":"query","description":"The pagination token for the next page of attribute `company_type`.","required":false,"schema":{"type":"string"}},{"name":"attributes.company_type.prev","in":"query","description":"The pagination token for the previous page of attribute `company_type`.","required":false,"schema":{"type":"string"}},{"name":"attributes.company_type.limit","in":"query","description":"Limit total values returned for attribute `company_type`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.country.next","in":"query","description":"The pagination token for the next page of attribute `country`.","required":false,"schema":{"type":"string"}},{"name":"attributes.country.prev","in":"query","description":"The pagination token for the previous page of attribute `country`.","required":false,"schema":{"type":"string"}},{"name":"attributes.country.limit","in":"query","description":"Limit total values returned for attribute `country`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.identifier.next","in":"query","description":"The pagination token for the next page of attribute `identifier`.","required":false,"schema":{"type":"string"}},{"name":"attributes.identifier.prev","in":"query","description":"The pagination token for the previous page of attribute `identifier`.","required":false,"schema":{"type":"string"}},{"name":"attributes.identifier.limit","in":"query","description":"Limit total values returned for attribute `identifier`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.name.next","in":"query","description":"The pagination token for the next page of attribute `name`.","required":false,"schema":{"type":"string"}},{"name":"attributes.name.prev","in":"query","description":"The pagination token for the previous page of attribute `name`.","required":false,"schema":{"type":"string"}},{"name":"attributes.name.limit","in":"query","description":"Limit total values returned for attribute `name`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"attributes.status.next","in":"query","description":"The pagination token for the next page of attribute `status`.","required":false,"schema":{"type":"string"}},{"name":"attributes.status.prev","in":"query","description":"The pagination token for the previous page of attribute `status`.","required":false,"schema":{"type":"string"}},{"name":"attributes.status.limit","in":"query","description":"Limit total values returned for attribute `status`. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"relationships.next","in":"query","description":"The pagination token for the next page of relationship results","required":false,"schema":{"type":"string"}},{"name":"relationships.prev","in":"query","description":"The pagination token for the previous page of relationship results","required":false,"schema":{"type":"string"}},{"name":"relationships.limit","in":"query","description":"Limit total relationship values. Defaults to 50.","required":false,"schema":{"type":"integer"}},{"name":"relationships.type","in":"query","description":"Filter relationships to [relationship type](/sayari-library/ontology/relationships), e.g. director_of or has_shareholder","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},{"name":"relationships.sort","in":"query","description":"Sorts relationships by As Of date or Shareholder percentage, e.g. date or -shares","required":false,"schema":{"type":"string"}},{"name":"relationships.startDate","in":"query","description":"Filters relationships to after a date","required":false,"schema":{"type":"string","format":"date"}},{"name":"relationships.endDate","in":"query","description":"Filters relationships to before a date","required":false,"schema":{"type":"string","format":"date"}},{"name":"relationships.minShares","in":"query","description":"Filters relationships to greater than or equal to a Shareholder percentage","required":false,"schema":{"type":"integer"}},{"name":"relationships.country","in":"query","description":"Filters relationships to a list of [countries](/sayari-library/ontology/enumerated-types#country)","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"relationships.arrivalCountry","in":"query","description":"Filters shipment relationships to a list of arrival [countries](/sayari-library/ontology/enumerated-types#country)","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"relationships.arrivalState","in":"query","description":"Filters shipment relationships to an arrival state","required":false,"schema":{"type":"string"}},{"name":"relationships.arrivalCity","in":"query","description":"Filters shipment relationships to an arrival city","required":false,"schema":{"type":"string"}},{"name":"relationships.departureCountry","in":"query","description":"Filters shipment relationships to a list of departure [countries](/sayari-library/ontology/enumerated-types#country)","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"relationships.departureState","in":"query","description":"Filters shipment relationships to a departure state","required":false,"schema":{"type":"string"}},{"name":"relationships.departureCity","in":"query","description":"Filters shipment relationships to a departure city","required":false,"schema":{"type":"string"}},{"name":"relationships.partnerName","in":"query","description":"Filters shipment relationships to a trade partner name","required":false,"schema":{"type":"string"}},{"name":"relationships.partnerRisk","in":"query","description":"Filters shipment relationships to a trade partner [risk tag](/sayari-library/ontology/enumerated-types#tag)","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Risk"}},{"name":"relationships.hsCode","in":"query","description":"Filters shipment relationships to an HS code","required":false,"schema":{"type":"string"}},{"name":"possibly_same_as.next","in":"query","description":"The pagination token for the next page of possibly same entities.","required":false,"schema":{"type":"string"}},{"name":"possibly_same_as.prev","in":"query","description":"The pagination token for the previous page of possibly same entities.","required":false,"schema":{"type":"string"}},{"name":"possibly_same_as.limit","in":"query","description":"Limit total possibly same as entities. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"referenced_by.next","in":"query","description":"The pagination token for the next page of the entity's referencing records","required":false,"schema":{"type":"string"}},{"name":"referenced_by.prev","in":"query","description":"The pagination token for the previous page of the entity's referencing records","required":false,"schema":{"type":"string"}},{"name":"referenced_by.limit","in":"query","description":"Limit totals values returned for entity's referencing records. Defaults to 100.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/entity_GetEntityResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/entity_summary/{id}":{"get":{"operationId":"entity_entitySummary","summary":"Entity Summary","description":"The Entity Summary endpoint returns a similar payload, minus relationships.","tags":["entity"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the entity","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/entity_EntitySummaryResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/usage":{"get":{"operationId":"info_getUsage","summary":"Get Usage","description":"The usage endpoint provides a simple interface to retrieve information on usage made by your API account. This includes both views per API path and credits consumed. The time period for the usage query is also specified in the response and whether or not this includes total usage.","tags":["info"],"parameters":[{"name":"from","in":"query","description":"An ISO 8601 encoded date string indicating the starting time period to obtain usage stats. In the format YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"An ISO 8601 encoded date string indicating the ending time period to obtain usage stats. In the format YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/info_UsageResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/history":{"get":{"operationId":"info_getHistory","summary":"Get History","description":"The history endpoint return a user's event history.","tags":["info"],"parameters":[{"name":"events","in":"query","description":"The type of events to filter on.","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"An ISO 8601 encoded date string indicating the starting time period for the events. In the format YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"An ISO 8601 encoded date string indicating the ending time period for the events. In the format YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"size","in":"query","description":"Size to limit number of events returned","required":false,"schema":{"type":"integer"}},{"name":"token","in":"query","description":"Pagination token to retrieve the next page of results","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/info_HistoryResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/negative_news":{"get":{"operationId":"negativeNews_NegativeNews","summary":"Negative News","description":"<Warning>This endpoint is in beta and subject to change</Warning>\nScreens entities against news articles and public records to identify risk-relevant content.\nLeverages machine learning to detect and classify risks across various domains.\nProvides detailed article metadata with risk assessments and direct source references.","tags":["negative_news"],"parameters":[{"name":"name","in":"query","description":"Target entity name for adverse media screening.","required":true,"schema":{"type":"string"}},{"name":"topic","in":"query","description":"Risk category filter for targeted screening. Each topic represents a distinct risk domain (e.g., `environmental` for environmental violations, `financial` for financial misconduct).","required":false,"schema":{"$ref":"#/components/schemas/negativeNews_Topics"}},{"name":"until","in":"query","description":"Date cutoff for article inclusion in `YYYY-MM-DD` format. If provided, only articles published after this date will be included in results.","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/negativeNews_NegativeNewsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/notifications/projects/{id}":{"get":{"operationId":"notifications_projectNotifications","summary":"Project Notifications","description":"<Warning>Legacy endpoint. New integrations should contact Sayari for best practices.</Warning> The Project Notifications endpoint returns a list of notifications on all entities saved to a project.","tags":["notifications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the project","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total notifications in the response. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset which notifications are returned. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/notifications_NotificationsSortField"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications_ProjectNotificationsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/notifications/resources/{id}":{"get":{"operationId":"notifications_resourceNotifications","summary":"Resource Notifications","description":"<Warning>Legacy endpoint. New integrations should contact Sayari for best practices.</Warning> The Resource Notifications endpoint returns a list of notifications for a saved entity.","tags":["notifications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total notifications in the response. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset which notifications are returned. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications_ResourceNotificationsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/notifications/projects/{project_id}":{"delete":{"operationId":"notifications_deleteProjectNotifications","summary":"Delete Project Notifications","description":"<Warning>Legacy endpoint. New integrations should contact Sayari for best practices.</Warning> Deletes all notifications from a project.","tags":["notifications"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/notifications/entity/{entity_id}":{"delete":{"operationId":"notifications_deleteEntityNotifications","summary":"Delete Entity Notifications","description":"<Warning>Legacy endpoint. New integrations should contact Sayari for best practices.</Warning> Deletes notifications for saved resources of an entity.","tags":["notifications"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/notifications/resources/{resource_id}":{"delete":{"operationId":"notifications_deleteResourceNotifications","summary":"Delete Resource Notifications","description":"<Warning>Legacy endpoint. New integrations should contact Sayari for best practices.</Warning> Deletes notifications for a saved resource.","tags":["notifications"],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology":{"get":{"operationId":"ontology_getOntology","summary":"Get Ontology","description":"Get ontology data for all resource types.","tags":["ontology"],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/attributes":{"get":{"operationId":"ontology_getAttributes","summary":"Get Attributes","description":"Get attributes from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Attribute Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Attributes"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyAttributesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/countries":{"get":{"operationId":"ontology_getCountries","summary":"Get Countries","description":"Get countries from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Country Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyCountriesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/currencies":{"get":{"operationId":"ontology_getCurrencies","summary":"Get Currencies","description":"Get currencies from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Currency Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Currency"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyCurrenciesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/entity_types":{"get":{"operationId":"ontology_getEntityTypes","summary":"Get Entity Types","description":"Get entity types from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Entity type Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Entities"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyEntityTypesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/enums":{"get":{"operationId":"ontology_getEnums","summary":"Get Enums","description":"Get enums from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Enum Id filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyEnumsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/hs_codes":{"get":{"operationId":"ontology_getHsCodes","summary":"Get HS Codes","description":"Get HS codes from ontology data.","tags":["ontology"],"parameters":[{"name":"code","in":"query","description":"HS code filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyHsCodesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/identifiers":{"get":{"operationId":"ontology_getIdentifiers","summary":"Get Identifiers","description":"Get identifiers from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Identifier Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_IdentifierType"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyIdentifiersResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/languages":{"get":{"operationId":"ontology_getLanguages","summary":"Get Languages","description":"Get languages from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Language Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Language"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyLanguagesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/regions":{"get":{"operationId":"ontology_getRegions","summary":"Get Regions","description":"Get regions from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Region Id filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyRegionsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/relationships":{"get":{"operationId":"ontology_getRelationships","summary":"Get Relationships","description":"Get relationships from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Relationship Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Relationships"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyRelationshipsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/risk_factors":{"get":{"operationId":"ontology_getRiskFactors","summary":"Get Risk Factors","description":"Get risk factors from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Risk factor Id filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"risk_category","in":"query","description":"Risk category filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskCategory"}}},{"name":"level","in":"query","description":"Risk level filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RiskLevel"}}},{"name":"risk_type","in":"query","description":"Risk type filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"enabled","in":"query","description":"Risk enabled filter.","required":false,"schema":{"type":"boolean"}},{"name":"visible","in":"query","description":"Risk visible filter.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologyRiskFactorsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/sources":{"get":{"operationId":"ontology_getSources","summary":"Get Sources","description":"Get sources from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Source Id filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"country","in":"query","description":"Source country filter.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"source_type","in":"query","description":"Source type filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologySourcesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ontology/source_types":{"get":{"operationId":"ontology_getSourceTypes","summary":"Get Source Types","description":"Get source types from ontology data.","tags":["ontology"],"parameters":[{"name":"id","in":"query","description":"Source type Id filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ontology_GetOntologySourceTypesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects":{"post":{"operationId":"project_createProject","summary":"Create Project","description":"Create a new project.","tags":["project"],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_CreateProjectResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_CreateProjectRequest"}}}},"security":[{"OAuthScheme":[]}]},"get":{"operationId":"project_getProjects","summary":"Get Projects","description":"Retrieve a list of projects including upload progress info.","tags":["project"],"parameters":[{"name":"next","in":"query","description":"The pagination token for the next page of projects.","required":false,"schema":{"type":"string"}},{"name":"prev","in":"query","description":"The pagination token for the previous page of projects.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total values returned for projects. Defaults to 100. Max 100.","required":false,"schema":{"type":"integer"}},{"name":"archived","in":"query","description":"Toggle between projects that have been archived (true) or not (false). Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"type","in":"query","description":"Which project types to return","required":false,"schema":{"$ref":"#/components/schemas/project_ProjectType"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_GetProjectsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{projectId}":{"delete":{"operationId":"project_deleteProject","summary":"Delete Project","description":"Deletes an existing project.","tags":["project"],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_DeleteProjectResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/create":{"post":{"operationId":"projectEntity_createProjectEntity","summary":"Create Project Entity","description":"The resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the search endpoint, except it's tuned to only return the best match so the client doesn't need to do as much or any post-processing work to filter down results.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"enable_llm_clean","in":"query","description":"Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to true if not supplied. Set to false to disable LLM cleaning.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_SingleProjectEntityResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_CreateResolvedProjectEntityRequest"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities":{"get":{"operationId":"projectEntity_getProjectEntities","summary":"Get Project Entities","description":"Retrieves a list of entities for a specific project with pagination support.\n\n**Response Formats:**\n- **JSON** (default): Returns structured data with nested objects\n- **CSV**: Returns tabular data with dynamic columns for attributes and risk categories\n\n**CSV Format:**\nThe CSV response includes dynamic columns based on the data:\n- `attribute_{field_name}`: Dynamic columns for each attribute field found in the data\n- `risk_category_{category_id}`: Dynamic columns for each risk category found in the data\n- Standard columns: project_id, project_entity_id, label, project_entity_url, upload_ids, strength, countries, tags, case_status, created_at, match_count, upstream_products, upstream_risk_factors, upstream_countries\n\nUse the `Accept: text/csv` header to request CSV format.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"next","in":"query","description":"The pagination token for the next page of projects.","required":false,"schema":{"type":"string"}},{"name":"prev","in":"query","description":"The pagination token for the previous page of projects.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total values returned for projects. Defaults to 100. Max 100.","required":false,"schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the project entities. Supports both dot notation (e.g., 'filter.attribute.name') and bracket notation (e.g., 'filter[attribute][name]') for nested field filtering.","required":false,"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesFilter"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}":{"get":{"operationId":"projectEntity_getProjectEntity","summary":"Get Project Entity","description":"Retrieves a specific entity in a project.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_SingleProjectEntityResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"delete":{"operationId":"projectEntity_deleteProjectEntity","summary":"Delete Project Entity","description":"Deletes a project entity.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/matches":{"post":{"operationId":"projectEntity_addProjectEntityMatches","summary":"Add Project Entity Matches","description":"Adds matches to a project entity.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_UpdateProjectEntityMatchesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_UpdateProjectEntityMatchesBody"}}}},"security":[{"OAuthScheme":[]}]},"patch":{"operationId":"projectEntity_replaceProjectEntityMatches","summary":"Replace Project Entity Matches","description":"Replace matches in a project entity.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_UpdateProjectEntityMatchesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_UpdateProjectEntityMatchesBody"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/matches/{match_id}":{"delete":{"operationId":"projectEntity_deleteProjectEntityMatch","summary":"Delete Project Entity Match","description":"Deletes a specific project entity match.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"match_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/exists":{"post":{"operationId":"projectEntity_projectEntityExists","summary":"Project Entity Exists","description":"Checks if a project entity with the given attributes already exists.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntityIdResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ResolutionAttributes"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/save":{"post":{"operationId":"projectEntity_saveProjectEntity","summary":"Save Project Entity","description":"Stores a project entity given entity IDs and a list of attributes.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_SingleProjectEntityResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_SaveProjectEntityBody"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/changes/risk":{"get":{"operationId":"projectEntity_getProjectRiskChanges","summary":"Get Project Risk Changes","description":"Retrieves the risk changes for all project entities in a project.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of risk changes to return. Default is 100.","required":false,"schema":{"type":"integer"}},{"name":"next","in":"query","description":"Token to retrieve the next page of risk changes","required":false,"schema":{"type":"string"}},{"name":"prev","in":"query","description":"Token to retrieve the previous page of risk changes","required":false,"schema":{"type":"string"}},{"name":"sort.date","in":"query","description":"Sort by timestamp in ascending or descending order. Default is desc.","required":false,"schema":{"$ref":"#/components/schemas/projectEntity_SortOrder"}},{"name":"filter.from","in":"query","description":"Filter risk changes from the provided date","required":false,"schema":{"type":"string"}},{"name":"filter.to","in":"query","description":"Filter risk changes up to the provided date","required":false,"schema":{"type":"string"}},{"name":"filter.risk_factor","in":"query","description":"Filter risk changes for the provided risk factors","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter.risk_category","in":"query","description":"Filter risk changes for risk factors from the provided risk categories","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ProjectRiskChangesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"422":{"description":"Error response with status 422","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnprocessableContentResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"delete":{"operationId":"projectEntity_deleteProjectRiskChanges","summary":"Delete Project Risk Changes","description":"Dismiss risk changes for all project entities in a project.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/changes/risk":{"get":{"operationId":"projectEntity_getProjectEntityRiskChanges","summary":"Get Project Entity Risk Changes","description":"Retrieves the risk changes for a single project entity.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of risk changes to return. Default is 100.","required":false,"schema":{"type":"integer"}},{"name":"next","in":"query","description":"Token to retrieve the next page of risk changes","required":false,"schema":{"type":"string"}},{"name":"prev","in":"query","description":"Token to retrieve the previous page of risk changes","required":false,"schema":{"type":"string"}},{"name":"sort.date","in":"query","description":"Sort by timestamp in ascending or descending order. Default is desc.","required":false,"schema":{"$ref":"#/components/schemas/projectEntity_SortOrder"}},{"name":"filter.from","in":"query","description":"Filter risk changes from the provided date","required":false,"schema":{"type":"string"}},{"name":"filter.to","in":"query","description":"Filter risk changes up to the provided date","required":false,"schema":{"type":"string"}},{"name":"filter.risk_factor","in":"query","description":"Filter risk changes for the provided risk factors","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter.risk_category","in":"query","description":"Filter risk changes for risk factors from the provided risk categories","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskChangesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"422":{"description":"Error response with status 422","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnprocessableContentResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"delete":{"operationId":"projectEntity_deleteProjectEntityRiskChanges","summary":"Delete Project Entity Risk Changes","description":"Dismiss risk changes for a single project entity.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/supply_chain/upstream":{"get":{"operationId":"projectEntity_projectEntitySupplyChain","summary":"Project Entity Supply Chain","description":"Execute a traversal of the upstream trade network (supply chain) for all matched entities of a project entity, returning a set of entities and edges between them.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","description":"The project Identifier","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","description":"The project entity Identifier","required":true,"schema":{"type":"string"}},{"name":"product","in":"query","description":"Product root edge filter. Filters results to include only trade relationships where the associated component is part of the specified product's blueprint or is a sub-component of that product.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"-product","in":"query","description":"Product root edge filter. Filters results to exclude any trade relationships where the associated component is part of the specified product's blueprint or is a sub-component of that product.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"risk","in":"query","description":"Risk leaf node filter. Only return supply chains that end with a supplier that has 1+ of the specified risk factors.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"-risk","in":"query","description":"Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"countries","in":"query","description":"Country leaf node filter. Only return supply chains that end with a supplier in 1+ of the specified countries.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"-countries","in":"query","description":"Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from any tier matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"-shipment_country","in":"query","description":"Filters supply chain paths where none of the shipment countries from any tier matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier1_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 1 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier2_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 2 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier3_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 3 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier4_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 4 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier5_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 5 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"component","in":"query","description":"Component edge filter. Only return supply chains that contain at least one edge with 1+ of the specified HS codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"-component","in":"query","description":"Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"min_date","in":"query","description":"Minimum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are greater than or equal to this date.","required":false,"schema":{"type":"string"}},{"name":"max_date","in":"query","description":"Maximum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are less than or equal to this date.","required":false,"schema":{"type":"string"}},{"name":"max_depth","in":"query","description":"The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The maximum number of results to return. Default is no limit.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/supplyChain_UpstreamTradeTraversalResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/risk_summary":{"get":{"operationId":"projectEntity_getProjectEntityRiskSummary","summary":"Get Project Entity Risk Summary","description":"Retrieves a risk summary for a specific project entity, including risk factors with network paths and risk intelligence data.\n\n**Response includes:**\n- Risk factors with their levels (elevated, high, critical)\n- Network paths showing relationships between entities\n- Risk intelligence scores and metadata\n- Risk categories and source entity information","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter risk factors by risk factor IDs and risk categories","required":true,"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskSummaryFilters"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskSummaryResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/supply_chain/upstream_summary":{"get":{"operationId":"projectEntity_projectEntitySupplyChainSummary","summary":"Project Entity Supply Chain Summary","description":"Execute a traversal of the upstream trade network (supply chain) for all matched entities of a project entity, returning a summary of countries, risks, and components.","tags":["project_entity"],"parameters":[{"name":"project_id","in":"path","description":"The project Identifier","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","description":"The project entity Identifier","required":true,"schema":{"type":"string"}},{"name":"product","in":"query","description":"Product root edge filter. Filters results to include only trade relationships where the associated component is part of the specified product's blueprint or is a sub-component of that product.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"-product","in":"query","description":"Product root edge filter. Filters results to exclude any trade relationships where the associated component is part of the specified product's blueprint or is a sub-component of that product.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"risk_factors","in":"query","description":"Risk leaf node filter. Only return supply chains that end with a supplier that has 1+ of the specified risk factors.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"-risk_factors","in":"query","description":"Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"countries","in":"query","description":"Country leaf node filter. Only return supply chains that end with a supplier in 1+ of the specified countries.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"-countries","in":"query","description":"Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"component","in":"query","description":"Component edge filter. Only return supply chains that contain at least one edge with 1+ of the specified HS codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"-component","in":"query","description":"Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"min_date","in":"query","description":"Minimum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are greater than or equal to this date.","required":false,"schema":{"type":"string"}},{"name":"max_date","in":"query","description":"Maximum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are less than or equal to this date.","required":false,"schema":{"type":"string"}},{"name":"max_depth","in":"query","description":"The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The maximum number of results to return. Default is no limit.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntity_ProjectEntitySupplyChainSummaryResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/record/{id}":{"get":{"operationId":"record_getRecord","summary":"Get Record","description":"Retrieve a record from the database based on the ID","tags":["record"],"parameters":[{"name":"id","in":"path","description":"The unique identifier for a record in the database","required":true,"schema":{"type":"string"}},{"name":"references.limit","in":"query","description":"A limit on the number of references to be returned. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"references.offset","in":"query","description":"Number of references to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/record_GetRecordResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/resolution":{"get":{"operationId":"resolution_resolution","summary":"Resolution","description":"The resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the search endpoint, except it's tuned to only return the best match so the client doesn't need to do as much or any post-processing work to filter down results.","tags":["resolution"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 10 inclusive. Defaults to 10.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Entity name","required":false,"schema":{"type":"string"}},{"name":"address","in":"query","description":"Entity address. For optimal matching results, it's recommended to concatenate the full address string (street, city, state, postal code).","required":false,"schema":{"type":"string"}},{"name":"city","in":"query","description":"Entity city that contains the provided city name.","required":false,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Entity state that contains the provided state name.","required":false,"schema":{"type":"string"}},{"name":"country","in":"query","description":"Entity country - must be ISO (3166) Trigram i.e., `USA`. See complete list [here](/sayari-library/ontology/enumerated-types#country)","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"identifier","in":"query","description":"Entity identifier. Can be from either the [Identifier Type](/sayari-library/ontology/enumerated-types#identifier-type) or [Weak Identifier Type](/sayari-library/ontology/enumerated-types#weak-identifier-type) enums.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_BothIdentifierTypes"}},{"name":"date_of_birth","in":"query","description":"Entity date of birth","required":false,"schema":{"type":"string"}},{"name":"contact","in":"query","description":"Entity contact","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"[Entity type](/sayari-library/ontology/entities). If multiple values are passed for any field, the endpoint will match entities with ANY of the values.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Entities"}},{"name":"profile","in":"query","description":"Specifies the search algorithm to use. `corporate` (default) is optimized for accurate entity attribute matching, ideal for business verification. `suppliers` is tailored for matching entities with trade data, suitable for supply chain use cases. `search` mimics /search/entity behavior, best for name-only matches.","required":false,"schema":{"$ref":"#/components/schemas/resolution_ProfileEnum"}},{"name":"name_min_percentage","in":"query","description":"Adding this param enables an alternative matching logic. It will set a minimum percentage of tokens needed to match with user input to be considered a \"hit\". Accepts integers from 0 to 100 inclusive.","required":false,"schema":{"type":"integer"}},{"name":"name_min_tokens","in":"query","description":"Adding this param enables an alternative matching logic. It sets the minimum number of matching tokens the resolved hits need to have in common with the user input to be considered a \"hit\". Accepts non-negative integers.","required":false,"schema":{"type":"integer"}},{"name":"minimum_score_threshold","in":"query","description":"Specifies the minimum score required to pass, which controls the strictness of the matching threshold. The default value is 77, and tuned for general use-case accuracy. Increase the value for stricter matching, reduce to loosen.","required":false,"schema":{"type":"integer"}},{"name":"search_fallback","in":"query","description":"Enables a name search fallback when either the corporate or supplier profiles fails to find a match. When invoked, the fallback will make a call similar to /search/entity on name only. By default set to false.","required":false,"schema":{"type":"boolean"}},{"name":"cutoff_threshold","in":"query","description":"Specifies the window of similar results returned in the match group. Increase for fewer multiple matches, decrease to open the aperture and allow for more matches. Default is .8","required":false,"schema":{"type":"integer"}},{"name":"candidate_pool_size","in":"query","description":"Specifies the maximum number of entity candidates considered during search. Default is 50. Higher values increase match pool size but also increase latency.","required":false,"schema":{"type":"integer"}},{"name":"skip_post_process","in":"query","description":"Bypasses the post-processing setps and re-ranking. Useful for debugging. By default set to false, set to true to enable.","required":false,"schema":{"type":"boolean"}},{"name":"enable_llm_clean","in":"query","description":"Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to false if not supplied. Set to true to enable LLM cleaning.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"post":{"operationId":"resolution_resolutionPOST","summary":"Resolution POST","description":"The resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the search endpoint, except it's tuned to only return the best match so the client doesn't need to do as much or any post-processing work to filter down results.","tags":["resolution"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 10 inclusive. Defaults to 10.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"enable_llm_clean","in":"query","description":"Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to true if not supplied. Set to false to disable LLM cleaning.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionBody"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/resolution/persisted/{projectId}":{"post":{"operationId":"resolution_resolutionPersisted","summary":"Resolution Persisted","description":"<Warning>This endpoint is deprecated.</Warning> The persisted resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the resolution endpoint, except it also stores matched entities into user's project.","tags":["resolution"],"parameters":[{"name":"projectId","in":"path","description":"Unique identifier of the project","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 10 inclusive. Defaults to 10.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionPersistedResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionBody"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{projectId}/resolutions":{"post":{"operationId":"resolution_resolutionUpload","summary":"Resolution Upload","description":"<Warning>This endpoint is deprecated.</Warning> This endpoint allows you to upload entities in bulk.","tags":["resolution"],"parameters":[{"name":"projectId","in":"path","description":"Unique identifier of the project","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionUploadResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolution_ResolutionUploadBody"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/resource/entity":{"post":{"operationId":"resource_saveEntity","summary":"Save Entity","description":"Save an entity to a project.","tags":["resource"],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource_SaveEntityResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource_SaveEntityRequest"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/resource/{type}/{resourceId}":{"delete":{"operationId":"resource_deleteResource","summary":"Delete Resource","description":"Deletes an existing saved resource from a project.","tags":["resource"],"parameters":[{"name":"type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/resource_ResourceType"}},{"name":"resourceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource_DeleteResourceResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/screen":{"get":{"operationId":"screen_screen","summary":"Screen","description":"Screen a project entity against watchlist records to identify potential matches. Requires the `screened_risk` role.","tags":["screen"],"parameters":[{"name":"project_id","in":"path","description":"Project identifier.","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","description":"Project entity identifier.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Comma-separated list of watchlist record types to filter by.","required":false,"schema":{"type":"string"}},{"name":"release_name","in":"query","description":"Watchlist release name to filter by.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/screen_ScreenResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"403":{"description":"Error response with status 403","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ForbiddenResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"422":{"description":"Error response with status 422","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnprocessableContentResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/screen":{"get":{"operationId":"screenByName_screenByName","summary":"Screen By Name","description":"Screen a name against watchlist records to identify potential matches. Requires the `screened_risk` role.","tags":["screen_by_name"],"parameters":[{"name":"name","in":"query","description":"Name to screen against watchlist records.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Comma-separated list of watchlist record types to filter by.","required":false,"schema":{"type":"string"}},{"name":"release_name","in":"query","description":"Watchlist release name to filter by.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/screen_ScreenResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"403":{"description":"Error response with status 403","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ForbiddenResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"422":{"description":"Error response with status 422","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnprocessableContentResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/search/entity":{"post":{"operationId":"search_searchEntity","summary":"Search Entity","description":"Search for an entity. Please note, searches are limited to a maximum of 10,000 results.","tags":["search"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_EntitySearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded."},"fields":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_SearchField"},"description":"Record or entity fields to search against."},"filter":{"$ref":"#/components/schemas/search_FilterList","description":"Filters to be applied to search query to limit the result-set."},"facets":{"type":"boolean","description":"Whether or not to return search facets in results giving counts by field. Defaults to false."},"geo_facets":{"type":"boolean","description":"Whether or not to return search geo bound facets in results giving counts by geo tile. Defaults to false."},"advanced":{"type":"boolean","description":"Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false."}},"required":["q"]}}}},"security":[{"OAuthScheme":[]}]},"get":{"operationId":"search_searchEntityGET","summary":"Search Entity GET","description":"Search for an entity. Please note, searches are limited to a maximum of 10,000 results.","tags":["search"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"q","in":"query","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Record or entity fields to search against.","required":false,"schema":{"$ref":"#/components/schemas/sharedTypes_SearchField"}},{"name":"facets","in":"query","description":"Whether or not to return search facets in results giving counts by field. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"geo_facets","in":"query","description":"Whether or not to return search geo bound facets in results giving counts by geo tile. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"advanced","in":"query","description":"Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_EntitySearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/search/record":{"post":{"operationId":"search_searchRecord","summary":"Search Record","description":"Search for a record. Please note, searches are limited to a maximum of 10,000 results.","tags":["search"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_RecordSearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded."},"filter":{"$ref":"#/components/schemas/search_FilterList","description":"Filters to be applied to search query to limit the result-set."},"facets":{"type":"boolean","description":"Whether or not to return search facets in results giving counts by field. Defaults to false."},"advanced":{"type":"boolean","description":"Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false."}},"required":["q"]}}}},"security":[{"OAuthScheme":[]}]},"get":{"operationId":"search_searchRecordGET","summary":"Search Record GET","description":"Search for a record. Please note, searches are limited to a maximum of 10,000 results.","tags":["search"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"q","in":"query","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded.","required":true,"schema":{"type":"string"}},{"name":"facets","in":"query","description":"Whether or not to return search facets in results giving counts by field. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"advanced","in":"query","description":"Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_RecordSearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"406":{"description":"Error response with status 406","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotAcceptableResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/supply_chain/upstream/{id}":{"get":{"operationId":"supplyChain_upstreamTradeTraversal","summary":"Upstream Trade Traversal","description":"Execute a traversal of the upstream trade network (supply chain) of an entity, returning a set of entities and edges between them.","tags":["supply_chain"],"parameters":[{"name":"id","in":"path","description":"The root entity identifier.","required":true,"schema":{"type":"string"}},{"name":"product","in":"query","description":"Product root edge filter. Filters results to include only trade relationships where the associated component is part of the specified product's blueprint or is a sub-component of that product.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"-product","in":"query","description":"Product root edge filter. Filters results to exclude any trade relationships where the associated component is part of the specified product's blueprint or is a sub-component of that product.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"risk","in":"query","description":"Risk leaf node filter. Only return supply chains that end with a supplier that has 1+ of the specified risk factors.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"-risk","in":"query","description":"Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},{"name":"countries","in":"query","description":"Country leaf node filter. Only return supply chains that end with a supplier in 1+ of the specified countries.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"-countries","in":"query","description":"Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from any tier matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"-shipment_country","in":"query","description":"Filters supply chain paths where none of the shipment countries from any tier matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier1_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 1 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier2_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 2 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier3_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 3 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier4_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 4 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"tier5_shipment_country","in":"query","description":"Filters supply chain paths where 1+ shipment country from tier 5 matches the provided values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}}},{"name":"component","in":"query","description":"Component edge filter. Only return supply chains that contain at least one edge with 1+ of the specified HS codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"-component","in":"query","description":"Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"min_date","in":"query","description":"Minimum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are greater than or equal to this date.","required":false,"schema":{"type":"string"}},{"name":"max_date","in":"query","description":"Maximum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are less than or equal to this date.","required":false,"schema":{"type":"string"}},{"name":"max_depth","in":"query","description":"The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The maximum number of results to return. Default is no limit.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/supplyChain_UpstreamTradeTraversalResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/trade/search/shipments":{"post":{"operationId":"trade_searchShipments","summary":"Search Shipments","description":"Search for a shipment. Please note, searches are limited to a maximum of 10,000 results.","tags":["trade"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 3000. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trade_ShipmentSearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded."},"filter":{"$ref":"#/components/schemas/trade_TradeFilterList","description":"Filters to be applied to search query to limit the result-set."},"facets":{"type":"boolean","description":"Whether or not to return search facets in results giving counts by field. Defaults to false."}}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/trade/search/suppliers":{"post":{"operationId":"trade_searchSuppliers","summary":"Search Suppliers","description":"Search for a supplier. Please note, searches are limited to a maximum of 10,000 results.","tags":["trade"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 3000. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trade_SupplierSearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded."},"filter":{"$ref":"#/components/schemas/trade_TradeFilterList","description":"Filters to be applied to search query to limit the result-set."},"facets":{"type":"boolean","description":"Whether or not to return search facets in results giving counts by field. Defaults to false."}}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/trade/search/buyers":{"post":{"operationId":"trade_searchBuyers","summary":"Search Buyers","description":"Search for a buyer. Please note, searches are limited to a maximum of 10,000 results.","tags":["trade"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned with a range between 1 and 3000. Defaults to 100.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of results to skip before returning response. Defaults to 0.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trade_BuyerSearchResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string","description":"Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded."},"filter":{"$ref":"#/components/schemas/trade_TradeFilterList","description":"Filters to be applied to search query to limit the result-set."},"facets":{"type":"boolean","description":"Whether or not to return search facets in results giving counts by field. Defaults to false."}}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/traversal/{id}":{"get":{"operationId":"traversal_traversal","summary":"Traversal","description":"The Traversal endpoint returns paths from a single target entity to up to 50 directly or indirectly-related entities. Each path includes information on the 0 to 10 intermediary entities, as well as their connecting relationships. The response's explored_count field indicates the size of the graph subset the application searched. Running a traversal on a highly connected entity with a restrictive set of argument filters and a high max depth will require the application to explore a higher number of traversal paths, which may affect performance. In cases where a traversal searches over a very large, highly-connected subgraph, a partial result set may be returned containing only the most relevant results. This will be indicated in the response by the partial_results field.","tags":["traversal"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the entity","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total values for traversal. Defaults to 10. Max of 50.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset values for traversal. Defaults to 0. Max of 1000.","required":false,"schema":{"type":"integer"}},{"name":"min_depth","in":"query","description":"Set minimum depth for traversal. Defaults to 1.","required":false,"schema":{"type":"integer"}},{"name":"max_depth","in":"query","description":"Set maximum depth for traversal. Defaults to 4.","required":false,"schema":{"type":"integer"}},{"name":"relationships","in":"query","description":"Set relationship type(s) to follow when traversing related entities. Defaults to following all relationship types.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},{"name":"psa","in":"query","description":"Also traverse relationships from entities that are possibly the same as any entity that appears in the path. Defaults to traversing possibly same as relationships.","required":false,"schema":{"type":"boolean"}},{"name":"countries","in":"query","description":"Filter paths to only those that end at an entity associated with the specified country(ies). Defaults to returning paths that end in any [country](/sayari-library/ontology/enumerated-types#country).","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"types","in":"query","description":"Filter paths to only those that end at an entity of the specified type(s). Defaults to returning paths that end at any type.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Entities"}},{"name":"sanctioned","in":"query","description":"Filter paths to only those that end at an entity appearing on a watchlist. Defaults to not filtering paths by sanctioned status.","required":false,"schema":{"type":"boolean"}},{"name":"pep","in":"query","description":"Filter paths to only those that end at an entity appearing on a pep list. Defaults to not filtering paths by pep status.","required":false,"schema":{"type":"boolean"}},{"name":"min_shares","in":"query","description":"Set minimum percentage of share ownership for traversal. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"include_unknown_shares","in":"query","description":"Also traverse relationships when share percentages are unknown. Only useful when min_shares is set greater than 0. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_former_relationships","in":"query","description":"Include relationships that were valid in the past but not at the present time. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_closed_entities","in":"query","description":"Include entities that existed in the past but not at the present time. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"risk_categories","in":"query","description":"Filter paths to only those that include an entity associated with any risk factor belonging to one of the specified categories.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskCategory"}}},{"name":"eu_high_risk_third","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_modern_slavery","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"state_owned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"formerly_sanctioned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_terrorism","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_organized_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_financial_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_bribery_and_corruption","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_other","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_cybercrime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"regulatory_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"law_enforcement_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"xinjiang_geospatial","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/traversal_TraversalResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/ubo/{id}":{"get":{"operationId":"traversal_ubo","summary":"Ubo","description":"The UBO endpoint returns paths from a single target entity to up to 50 beneficial owners. The endpoint is a shorthand for the equivalent traversal query.","tags":["traversal"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the entity","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total values for traversal. Defaults to 10. Max of 50.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset values for traversal. Defaults to 0. Max of 1000.","required":false,"schema":{"type":"integer"}},{"name":"min_depth","in":"query","description":"Set minimum depth for traversal. Defaults to 1.","required":false,"schema":{"type":"integer"}},{"name":"max_depth","in":"query","description":"Set maximum depth for traversal. Defaults to 4.","required":false,"schema":{"type":"integer"}},{"name":"relationships","in":"query","description":"Set relationship type(s) to follow when traversing related entities. Defaults to has_shareholder, has_beneficial_owner, has_partner, subsidiary_of, and branch_of.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},{"name":"psa","in":"query","description":"Also traverse relationships from entities that are possibly the same as any entity that appears in the path. Defaults to traversing possibly same as relationships.","required":false,"schema":{"type":"boolean"}},{"name":"countries","in":"query","description":"Filter paths to only those that end at an entity associated with the specified country(ies). Defaults to returning paths that end in any [country](/sayari-library/ontology/enumerated-types#country).","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"types","in":"query","description":"Filter paths to only those that end at an entity of the specified type(s). Defaults to returning paths that end at any type.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Entities"}},{"name":"sanctioned","in":"query","description":"Filter paths to only those that end at an entity appearing on a watchlist. Defaults to not filtering paths by sanctioned status.","required":false,"schema":{"type":"boolean"}},{"name":"pep","in":"query","description":"Filter paths to only those that end at an entity appearing on a pep list. Defaults to not filtering paths by pep status.","required":false,"schema":{"type":"boolean"}},{"name":"min_shares","in":"query","description":"Set minimum percentage of share ownership for traversal. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"include_unknown_shares","in":"query","description":"Also traverse relationships when share percentages are unknown. Only useful when min_shares is set greater than 0. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_former_relationships","in":"query","description":"Include relationships that were valid in the past but not at the present time. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_closed_entities","in":"query","description":"Include entities that existed in the past but not at the present time. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"risk_categories","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with any risk factor of these categories","required":false,"schema":{"$ref":"#/components/schemas/traversal_TraversalRiskCategory"}},{"name":"eu_high_risk_third","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_modern_slavery","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"state_owned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"formerly_sanctioned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_terrorism","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_organized_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_financial_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_bribery_and_corruption","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_other","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_cybercrime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"regulatory_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"law_enforcement_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"xinjiang_geospatial","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/traversal_TraversalResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/downstream/{id}":{"get":{"operationId":"traversal_ownership","summary":"Ownership","description":"The Ownership endpoint returns paths from a single target entity to up to 50 entities directly or indirectly owned by that entity. The endpoint is a shorthand for the equivalent traversal query.","tags":["traversal"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the entity","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total values for traversal. Defaults to 10. Max of 50.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset values for traversal. Defaults to 0. Max of 1000.","required":false,"schema":{"type":"integer"}},{"name":"min_depth","in":"query","description":"Set minimum depth for traversal. Defaults to 1.","required":false,"schema":{"type":"integer"}},{"name":"max_depth","in":"query","description":"Set maximum depth for traversal. Defaults to 4.","required":false,"schema":{"type":"integer"}},{"name":"relationships","in":"query","description":"Set relationship type(s) to follow when traversing related entities. Defaults to shareholder_of, beneficial_owner_of, partner_of, has_subsidiary, and has_branch.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},{"name":"psa","in":"query","description":"Also traverse relationships from entities that are possibly the same as any entity that appears in the path. Defaults to traversing possibly same as relationships.","required":false,"schema":{"type":"boolean"}},{"name":"countries","in":"query","description":"Filter paths to only those that end at an entity associated with the specified country(ies). Defaults to returning paths that end in any country.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"types","in":"query","description":"Filter paths to only those that end at an entity of the specified type(s). Defaults to returning paths that end at any type.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Entities"}},{"name":"sanctioned","in":"query","description":"Filter paths to only those that end at an entity appearing on a watchlist. Defaults to not filtering paths by sanctioned status.","required":false,"schema":{"type":"boolean"}},{"name":"pep","in":"query","description":"Filter paths to only those that end at an entity appearing on a pep list. Defaults to not filtering paths by pep status.","required":false,"schema":{"type":"boolean"}},{"name":"min_shares","in":"query","description":"Set minimum percentage of share ownership for traversal. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"include_unknown_shares","in":"query","description":"Also traverse relationships when share percentages are unknown. Only useful when min_shares is set greater than 0. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_former_relationships","in":"query","description":"Include relationships that were valid in the past but not at the present time. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_closed_entities","in":"query","description":"Include entities that existed in the past but not at the present time. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"risk_categories","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with any risk factor of these categories","required":false,"schema":{"$ref":"#/components/schemas/traversal_TraversalRiskCategory"}},{"name":"eu_high_risk_third","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_modern_slavery","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"state_owned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"formerly_sanctioned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_terrorism","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_organized_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_financial_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_bribery_and_corruption","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_other","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_cybercrime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"regulatory_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"law_enforcement_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"xinjiang_geospatial","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/traversal_TraversalResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/watchlist/{id}":{"get":{"operationId":"traversal_watchlist","summary":"Watchlist","description":"The Watchlist endpoint returns paths from a single target entity to up to 50 other entities that appear on a watchlist. The endpoint is a shorthand for the equivalent traversal query.","tags":["traversal"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the entity","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit total values for traversal. Defaults to 10. Max of 50.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset values for traversal. Defaults to 0. Max of 1000.","required":false,"schema":{"type":"integer"}},{"name":"min_depth","in":"query","description":"Set minimum depth for traversal. Defaults to 1.","required":false,"schema":{"type":"integer"}},{"name":"max_depth","in":"query","description":"Set maximum depth for traversal. Defaults to 4.","required":false,"schema":{"type":"integer"}},{"name":"relationships","in":"query","description":"Set relationship type(s) to follow when traversing related entities. Defaults to following 31 relevant relationship types covering ownership, control, and trade.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},{"name":"psa","in":"query","description":"Also traverse relationships from entities that are possibly the same as any entity that appears in the path. Defaults to traversing possibly same as relationships.","required":false,"schema":{"type":"boolean"}},{"name":"countries","in":"query","description":"Filter paths to only those that end at an entity associated with the specified country(ies). Defaults to returning paths that end in any country.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Country"}},{"name":"types","in":"query","description":"Filter paths to only those that end at an entity of the specified type(s). Defaults to returning paths that end at any type.","required":false,"schema":{"$ref":"#/components/schemas/generatedTypes_Entities"}},{"name":"sanctioned","in":"query","description":"Filter paths to only those that end at an entity appearing on a watchlist. Defaults to not filtering paths by sanctioned status.","required":false,"schema":{"type":"boolean"}},{"name":"pep","in":"query","description":"Filter paths to only those that end at an entity appearing on a pep list. Defaults to not filtering paths by pep status.","required":false,"schema":{"type":"boolean"}},{"name":"min_shares","in":"query","description":"Set minimum percentage of share ownership for traversal. Defaults to 0.","required":false,"schema":{"type":"integer"}},{"name":"include_unknown_shares","in":"query","description":"Also traverse relationships when share percentages are unknown. Only useful when min_shares is set greater than 0. Defaults to true.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_former_relationships","in":"query","description":"Include relationships that were valid in the past but not at the present time. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"exclude_closed_entities","in":"query","description":"Include entities that existed in the past but not at the present time. Defaults to false.","required":false,"schema":{"type":"boolean"}},{"name":"risk_categories","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with any risk factor of these categories","required":false,"schema":{"$ref":"#/components/schemas/traversal_TraversalRiskCategory"}},{"name":"eu_high_risk_third","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_modern_slavery","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"state_owned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"formerly_sanctioned","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_terrorism","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_organized_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_financial_crime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_bribery_and_corruption","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_other","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"reputational_risk_cybercrime","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"regulatory_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"law_enforcement_action","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}},{"name":"xinjiang_geospatial","in":"query","description":"Filter paths to only those that relate with an entity that we have flagged with this risk factor","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/traversal_TraversalResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/shortest_path":{"get":{"operationId":"traversal_shortestPath","summary":"Shortest Path","description":"The Shortest Path endpoint returns a response identifying the shortest traversal path connecting each pair of entities.","tags":["traversal"],"parameters":[{"name":"entities","in":"query","description":"A list of Sayari entity IDs specifying the source and target entities for the shortest path calculation. The list must contain exactly two entity IDs The first entity ID represents the source.The second entity ID represents the target.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/traversal_ShortestPathResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}},"502":{"description":"Error response with status 502","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadGatewayResponse"}}}},"520":{"description":"Error response with status 520","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_ConnectionErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/metadata":{"get":{"operationId":"metadata_metadata","summary":"Metadata","description":"Get metadata about the api, both its versions, which releases are present, and the identity of the authenticated user.","tags":["metadata"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/metadata_MetadataResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/attributes":{"get":{"operationId":"projectEntityAttributes_getProjectEntityAttributes","summary":"Get Project Entity Attributes","description":"Retrieves all attributes for a project entity.","tags":["project_entity_attributes"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntityAttributes_ProjectEntityAttributesResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"post":{"operationId":"projectEntityAttributes_createProjectEntityAttribute","summary":"Create Project Entity Attribute","description":"Creates a new attribute for a project entity.","tags":["project_entity_attributes"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntityAttributes_CreateProjectEntityAttributeResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntityAttributes_CreateProjectEntityAttributeRequest"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/attributes/{attribute_id}":{"put":{"operationId":"projectEntityAttributes_updateProjectEntityAttribute","summary":"Update Project Entity Attribute","description":"Updates a specific attribute for a project entity.","tags":["project_entity_attributes"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntityAttributes_UpdateProjectEntityAttributeResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntityAttributes_UpdateProjectEntityAttributeRequest"}}}},"security":[{"OAuthScheme":[]}]},"delete":{"operationId":"projectEntityAttributes_deleteProjectEntityAttribute","summary":"Delete Project Entity Attribute","description":"Deletes a specific attribute for a project entity.","tags":["project_entity_attributes"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/supply_chain/snapshots":{"get":{"operationId":"projectEntitySupplyChainSnapshots_getProjectEntitySupplyChainSnapshots","summary":"Get Project Entity Supply Chain Snapshots","description":"Retrieves all supply chain snapshots for a project entity.","tags":["project_entity_supply_chain_snapshots"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotsResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"post":{"operationId":"projectEntitySupplyChainSnapshots_createProjectEntitySupplyChainSnapshot","summary":"Create Project Entity Supply Chain Snapshot","description":"Creates a new supply chain snapshot for a project entity.","tags":["project_entity_supply_chain_snapshots"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_CreateProjectEntitySupplyChainSnapshotResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_CreateProjectEntitySupplyChainSnapshotRequest"}}}},"security":[{"OAuthScheme":[]}]}},"/v1/projects/{project_id}/entities/{project_entity_id}/supply_chain/snapshots/{snapshot_id}":{"get":{"operationId":"projectEntitySupplyChainSnapshots_getProjectEntitySupplyChainSnapshotById","summary":"Get Project Entity Supply Chain Snapshot By Id","description":"Retrieves a specific supply chain snapshot by ID for a project entity.","tags":["project_entity_supply_chain_snapshots"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"snapshot_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotByIdResponse"}}}},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]},"delete":{"operationId":"projectEntitySupplyChainSnapshots_deleteProjectEntitySupplyChainSnapshotById","summary":"Delete Project Entity Supply Chain Snapshot By Id","description":"Deletes a specific supply chain snapshot by ID for a project entity.","tags":["project_entity_supply_chain_snapshots"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"project_entity_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"snapshot_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Error response with status 400","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_BadRequestResponse"}}}},"401":{"description":"Error response with status 401","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_UnauthorizedResponse"}}}},"404":{"description":"Error response with status 404","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_NotFoundResponse"}}}},"405":{"description":"Error response with status 405","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_MethodNotAllowedResponse"}}}},"429":{"description":"Error response with status 429","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_RateLimitResponse"}}}},"500":{"description":"Error response with status 500","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sharedErrors_InternalServerErrorResponse"}}}}},"security":[{"OAuthScheme":[]}]}}},"tags":[{"name":"attributes"},{"name":"auth"},{"name":"entity"},{"name":"info"},{"name":"negative_news"},{"name":"notifications"},{"name":"ontology"},{"name":"project"},{"name":"project_entity"},{"name":"record"},{"name":"resolution"},{"name":"resource"},{"name":"screen"},{"name":"screen_by_name"},{"name":"search"},{"name":"supply_chain"},{"name":"trade"},{"name":"traversal"},{"name":"metadata"},{"name":"project_entity_attributes"},{"name":"project_entity_supply_chain_snapshots"}],"servers":[{"url":"https://api.sayari.com","description":"Production"},{"url":"https://api.internal.sayari.com","description":"Dev"},{"url":"https://api.uk.sayari.com","description":"Production_UK"}],"components":{"schemas":{"attributes_AddAttribute":{"type":"object","properties":{"entity":{"type":"string","description":"entity ID"},"type":{"type":"string","description":"type of additional information"},"value":{"description":"value of additional information in JSON format"},"date":{"type":"string","description":"as of date of the attribute"},"from_date":{"type":"string","description":"start date of the attribute"},"to_date":{"type":"string","description":"end date of the attribute"}},"required":["entity","type","value"],"title":"AddAttribute"},"attributes_AttributeProperties":{"type":"object","properties":{"editable":{"type":"boolean"},"record_count":{"type":"integer"},"id":{"type":"string"}},"required":["editable","record_count","id"],"title":"AttributeProperties"},"attributes_AttributeResponseData":{"type":"object","properties":{"value":{"description":"Any type"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/attributes_AttributeProperties"}}},"required":["value","properties"],"title":"AttributeResponseData"},"attributes_AttributeResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/attributes_AttributeResponseData"}},"required":["data"],"description":"OK","title":"AttributeResponse"},"sharedErrors_BadRequestResponse":{"description":"Any type","title":"BadRequestResponse"},"sharedErrors_UnauthorizedResponse":{"description":"Any type","title":"UnauthorizedResponse"},"sharedErrors_MethodNotAllowedResponse":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}},"required":["status","message","success"],"description":"Resource not found or does not exist.","title":"MethodNotAllowedResponse"},"sharedErrors_RateLimitResponse":{"description":"Any type","title":"RateLimitResponse"},"sharedErrors_InternalServerErrorResponse":{"description":"Any type","title":"InternalServerErrorResponse"},"sharedErrors_BadGatewayResponse":{"description":"Any type","title":"BadGatewayResponse"},"sharedErrors_ConnectionErrorResponse":{"description":"Any type","title":"ConnectionErrorResponse"},"attributes_UpdateAttribute":{"type":"object","properties":{"value":{"description":"value of additional information in JSON format"},"date":{"type":"string","description":"as of date of the attribute"},"from_date":{"type":"string","description":"start date of the attribute"},"to_date":{"type":"string","description":"end date of the attribute"}},"required":["value"],"title":"UpdateAttribute"},"sharedErrors_NotFoundResponse":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}},"required":["status","message","success"],"description":"Request made with an unsupported HTTP method.","title":"NotFoundResponse"},"auth_AuthResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The bearer token you will pass in to subsequent API calls to authenticate."},"expires_in":{"type":"integer","description":"Tells you how long (in seconds) until your bearer token expires."},"token_type":{"type":"string","description":"Will always be \"Bearer\""}},"required":["access_token","expires_in","token_type"],"title":"AuthResponse"},"generatedTypes_Relationships":{"type":"string","enum":["associate_of","has_associate","auditor_of","has_auditor","awarder_of","awarded_by","beneficial_owner_of","has_beneficial_owner","branch_of","has_branch","carrier_of","has_carrier","client_of","has_client","credits_to","credited_by","debits_from","debited_by","director_of","has_director","employee_of","has_employee","executive_of","has_executive","family_of","founder_of","has_founder","generic","issuer_of","has_issuer","judicial_representative_of","has_judicial_representative","judidical_representative_of","lawyer_in","has_lawyer","lawyer_of","legal_predecessor_of","has_legal_predecessor","legal_representative_of","has_legal_representative","legal_successor_of","has_legal_successor","linked_to","liquidator_of","has_liquidator","manager_of","has_manager","member_of_the_board_of","has_member_of_the_board","notify_party_of","has_notify_party","officer_of","has_officer","owner_of","has_owner","partner_of","has_partner","party_to","has_party","procures_from","contracted_by","receiver_of","received_by","recipient_of","awarded_to","registered_agent_of","has_registered_agent","secretary_of","has_secretary","shareholder_of","has_shareholder","shipper_of","shipped_by","ships_to","receives_from","sole_proprietor_of","has_sole_proprietor","subsidiary_of","has_subsidiary","supervisor_of","has_supervisor","transfers_to","transfers_from","possibly_same_as"],"title":"Relationships"},"generatedTypes_Country":{"type":"string","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","RKS","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","UNK","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XXX","YEM","ZAF","ZMB","ZWE"],"description":"Country enums are normalized representations of country names. [Source](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#ECU)","title":"Country"},"generatedTypes_Risk":{"type":"string","enum":["acea_default_list","aspi_uyghur_forced_labor_report_entity","aspi_uyghur_forced_labor_report_entity_adjacent","basel_aml","bis_addresses_high_diversion_risk","bis_affiliates_50_percent_rule","bis_boycott_requester_list","bis_entity_minority_ownership","bis_meu_minority_ownership","china_state_asset_controller","chinese_core_soe","chinese_soe_adjacent","chinese_state_owned","cicca_unfulfilled_awards","cmic_entity","cmic_entity_50_percent_rule","controlled_by_aus_sanctioned","controlled_by_bis_entity","controlled_by_bis_meu","controlled_by_eu_sanctioned","controlled_by_implausible_date_of_birth","controlled_by_jpn_sanctioned","controlled_by_mass_business_registration","controlled_by_ofac_fto_sanctioned","controlled_by_ofac_illicit_drugs_eo14059_sanctioned","controlled_by_ofac_sdgt_sanctioned","controlled_by_ofac_sdn","controlled_by_ofac_sdnt_sanctioned","controlled_by_ofac_sdntk_sanctioned","controlled_by_tcsp_keyword_risk","controlled_by_uk_sanctioned","controlled_by_ukr_sanctioned","controlled_by_un_sanctioned","cpi_score","entity_licensed_with_fsb_rf","esg_score_high","esg_score_medium","esg_score_very_high","eu_50_percent_rule","eu_high_risk_third","eu_minority_ownership","eu_sanctioned","export_controls","export_controls_adjacent","export_controls_bis_entity","export_controls_bis_entity_50_percent_rule","export_controls_bis_meu","export_controls_bis_meu_50_percent_rule","export_controls_other","export_controls_other_adjacent","export_controls_section_1260h","export_controls_section_1260h_50_percent_rule","export_controls_unverified_list","export_controls_unverified_list_50_percent_rule","export_to_blr_soe","export_to_chinese_soe","export_to_rus_soe","export_to_sanctioned","export_to_sanctioned_other","export_to_soe","exports_bis_high_priority_items_critical_components_direct","exports_bis_high_priority_items_critical_components_indirect","exports_bis_high_priority_items_direct","exports_bis_high_priority_items_indirect","exports_conflict_minerals","exports_eudr_shipment_cattle","exports_eudr_shipment_cocoa","exports_eudr_shipment_coffee","exports_eudr_shipment_palm_oil","exports_eudr_shipment_rubber","exports_eudr_shipment_soya","exports_eudr_shipment_wood","exports_ilab_child_labor","exports_ilab_forced_labor","exports_russian_coal","exports_russian_gold","exports_russian_important_good","exports_russian_oil","exports_to_bis_addresses_high_diversion_risk","exports_to_entity_licensed_with_fsb_rf","exports_to_jpn_meti_end_user_entity","exports_to_jpn_mofa_export_ban_entity","exports_to_sanctioned_arg_repet_jus_entity","exports_to_sanctioned_aus_dfat_entity","exports_to_sanctioned_bel_fpsf_entity","exports_to_sanctioned_can_gac_entity","exports_to_sanctioned_che_seco_entity","exports_to_sanctioned_cze_mof_entity","exports_to_sanctioned_eu_dg_fisma_ec_entity","exports_to_sanctioned_eu_ec_regulation_833_2014_entity","exports_to_sanctioned_eu_ec_sanctions_map_entity","exports_to_sanctioned_eu_sanctions_entity","exports_to_sanctioned_fra_dgt_mefids_entity","exports_to_sanctioned_gbr_fcdo_entity","exports_to_sanctioned_gbr_hmt_ofsi_entity","exports_to_sanctioned_isr_mod_nbctf_entity","exports_to_sanctioned_jpn_mof_entity","exports_to_sanctioned_ltu_mi_entity","exports_to_sanctioned_lva_fis_entity","exports_to_sanctioned_mys_moha_entity","exports_to_sanctioned_nld_mofa_entity","exports_to_sanctioned_nzl_mfat_rus_entity","exports_to_sanctioned_pol_mia_entity","exports_to_sanctioned_sgp_agc_entity","exports_to_sanctioned_ukr_nsdc_entity","exports_to_sanctioned_ukr_sfms_entity","exports_to_sanctioned_un_sc_entity","exports_to_sanctioned_usa_ofac_non_sdn_entity","exports_to_sanctioned_usa_ofac_sdn_entity","exports_to_sanctioned_xxx_ebrd_entity","exports_to_sanctioned_xxx_iabd_entity","exports_to_usa_aeca_debarred_entity","exports_to_usa_bis_denied_persons_entity","exports_to_usa_bis_entity","exports_to_usa_bis_meu_entity","exports_to_usa_bis_unverified_entity","exports_to_usa_isn_entity","exports_to_usa_section_1260h_entity","forced_labor_aspi_origin_direct","forced_labor_aspi_origin_subtier","forced_labor_aspi_origin_subtier_product_blueprint","forced_labor_china_keywords","forced_labor_sheffield_hallam_university_reports_origin_direct","forced_labor_sheffield_hallam_university_reports_origin_subtier","forced_labor_sheffield_hallam_university_reports_origin_subtier_product_blueprint","forced_labor_uflpa_origin_direct","forced_labor_uflpa_origin_subtier","forced_labor_uflpa_origin_subtier_product_blueprint","forced_labor_wro_origin_direct","forced_labor_wro_origin_subtier","forced_labor_wro_origin_subtier_product_blueprint","forced_labor_xinjiang_contractors","forced_labor_xinjiang_cotton_entity","forced_labor_xinjiang_geospatial","forced_labor_xinjiang_name","forced_labor_xinjiang_operations","forced_labor_xinjiang_origin_direct","forced_labor_xinjiang_origin_subtier","forced_labor_xinjiang_origin_subtier_product_blueprint","forced_labor_xinjiang_registration","forced_labor_xinjiang_uflpa","forced_labor_xinjiang_uflpa_adjacent","former_soe","former_wro_entity","formerly_sanctioned","formerly_sanctioned_arg_repet_jus","formerly_sanctioned_aus_dfat","formerly_sanctioned_bel_fpsf","formerly_sanctioned_can_gac","formerly_sanctioned_che_seco","formerly_sanctioned_cze_mof","formerly_sanctioned_eu_dg_fisma_ec","formerly_sanctioned_eu_ec_regulation_833_2014","formerly_sanctioned_eu_ec_sanctions_map","formerly_sanctioned_eu_sanctions","formerly_sanctioned_fra_dgt_mefids","formerly_sanctioned_gbr_fcdo","formerly_sanctioned_gbr_hmt_ofsi","formerly_sanctioned_isr_mod_nbctf","formerly_sanctioned_jpn_mof","formerly_sanctioned_ltu_mi","formerly_sanctioned_lva_fis","formerly_sanctioned_mys_moha","formerly_sanctioned_nld_mofa","formerly_sanctioned_nzl_mfat_rus","formerly_sanctioned_pol_mia","formerly_sanctioned_sgp_agc","formerly_sanctioned_ukr_nsdc","formerly_sanctioned_ukr_sfms","formerly_sanctioned_un_sc","formerly_sanctioned_usa_ofac_non_sdn","formerly_sanctioned_usa_ofac_sdn","formerly_sanctioned_xxx_ebrd","formerly_sanctioned_xxx_iabd","ica_unfulfilled_awards","implausible_date_of_birth","imports_bis_high_priority_items","imports_bis_high_priority_items_critical_components","imports_conflict_minerals","imports_eudr_shipment_cattle","imports_eudr_shipment_cocoa","imports_eudr_shipment_coffee","imports_eudr_shipment_palm_oil","imports_eudr_shipment_rubber","imports_eudr_shipment_soya","imports_eudr_shipment_wood","imports_from_bis_addresses_high_diversion_risk","imports_from_jpn_meti_end_user_entity","imports_from_jpn_mofa_export_ban_entity","imports_from_sanctioned_arg_repet_jus_entity","imports_from_sanctioned_aus_dfat_entity","imports_from_sanctioned_bel_fpsf_entity","imports_from_sanctioned_can_gac_entity","imports_from_sanctioned_che_seco_entity","imports_from_sanctioned_cze_mof_entity","imports_from_sanctioned_eu_dg_fisma_ec_entity","imports_from_sanctioned_eu_ec_regulation_833_2014_entity","imports_from_sanctioned_eu_ec_sanctions_map_entity","imports_from_sanctioned_eu_sanctions_entity","imports_from_sanctioned_fra_dgt_mefids_entity","imports_from_sanctioned_gbr_fcdo_entity","imports_from_sanctioned_gbr_hmt_ofsi_entity","imports_from_sanctioned_isr_mod_nbctf_entity","imports_from_sanctioned_jpn_mof_entity","imports_from_sanctioned_ltu_mi_entity","imports_from_sanctioned_lva_fis_entity","imports_from_sanctioned_mys_moha_entity","imports_from_sanctioned_nld_mofa_entity","imports_from_sanctioned_nzl_mfat_rus_entity","imports_from_sanctioned_pol_mia_entity","imports_from_sanctioned_sgp_agc_entity","imports_from_sanctioned_ukr_nsdc_entity","imports_from_sanctioned_ukr_sfms_entity","imports_from_sanctioned_un_sc_entity","imports_from_sanctioned_usa_ofac_non_sdn_entity","imports_from_sanctioned_usa_ofac_sdn_entity","imports_from_sanctioned_xxx_ebrd_entity","imports_from_sanctioned_xxx_iabd_entity","imports_from_usa_aeca_debarred_entity","imports_from_usa_bis_denied_persons_entity","imports_from_usa_bis_entity","imports_from_usa_bis_meu_entity","imports_from_usa_bis_unverified_entity","imports_from_usa_isn_entity","imports_from_usa_section_1260h_entity","imports_ilab_child_labor","imports_ilab_forced_labor","imports_ndaa_889_telecom_equipment","imports_russian_coal","imports_russian_gold","imports_russian_important_good","imports_russian_oil","jpn_meti_end_user","jpn_mofa_export_ban","law_enforcement_action","law_enforcement_action_breaking","law_enforcement_action_historic","law_enforcement_action_recent","mass_address_usage","mass_business_registration","meu_list_contractors","military_civil_fusion","military_civil_fusion_50_percent_rule","military_end_use_china_keywords","ndaa_889_covered_entities","ofac_50_percent_rule","ofac_fto_sanctioned","ofac_illicit_drugs_eo14059_sanctioned","ofac_minority_ownership","ofac_sdgt_sanctioned","ofac_sdn","ofac_sdn_mex_dto_sanctioned","ofac_sdn_mex_dto_sanctioned_adjacent","ofac_sdnt_sanctioned","ofac_sdntk_sanctioned","owned_by_aspi_forced_labor_entity","owned_by_bis_meu_entity","owned_by_blr_soe","owned_by_chinese_soe","owned_by_cmic_entity","owned_by_entity_in_export_controls","owned_by_entity_in_export_controls_other","owned_by_forced_labor_xinjiang_uflpa","owned_by_jpn_meti_end_user_entity","owned_by_jpn_mofa_export_ban_entity","owned_by_military_civil_fusion","owned_by_ofac_fto_sanctioned","owned_by_ofac_illicit_drugs_eo14059_sanctioned","owned_by_ofac_sdgt_sanctioned","owned_by_ofac_sdn_mex_dto_sanctioned","owned_by_ofac_sdnt_sanctioned","owned_by_ofac_sdntk_sanctioned","owned_by_regulatory_action_entity","owned_by_rus_soe","owned_by_sanctioned_arg_repet_jus_entity","owned_by_sanctioned_aus_dfat_entity","owned_by_sanctioned_bel_fpsf_entity","owned_by_sanctioned_can_gac_entity","owned_by_sanctioned_che_seco_entity","owned_by_sanctioned_cze_mof_entity","owned_by_sanctioned_entity","owned_by_sanctioned_eu_dg_fisma_ec_entity","owned_by_sanctioned_eu_ec_regulation_833_2014_entity","owned_by_sanctioned_eu_ec_sanctions_map_entity","owned_by_sanctioned_eu_sanctions_entity","owned_by_sanctioned_fra_dgt_mefids_entity","owned_by_sanctioned_gbr_fcdo_entity","owned_by_sanctioned_gbr_hmt_ofsi_entity","owned_by_sanctioned_isr_mod_nbctf_entity","owned_by_sanctioned_jpn_mof_entity","owned_by_sanctioned_ltu_mi_entity","owned_by_sanctioned_lva_fis_entity","owned_by_sanctioned_mys_moha_entity","owned_by_sanctioned_nld_mofa_entity","owned_by_sanctioned_nzl_mfat_rus_entity","owned_by_sanctioned_other_entity","owned_by_sanctioned_pol_mia_entity","owned_by_sanctioned_sgp_agc_entity","owned_by_sanctioned_ukr_nsdc_entity","owned_by_sanctioned_ukr_sfms_entity","owned_by_sanctioned_un_sc_entity","owned_by_sanctioned_usa_ofac_non_sdn_entity","owned_by_sanctioned_usa_ofac_sdn_entity","owned_by_sanctioned_xxx_ebrd_entity","owned_by_sanctioned_xxx_iabd_entity","owned_by_section_1260h_entity","owned_by_sheffield_hallam_university_reports_forced_labor_entity","owned_by_soe","owned_by_tcsp_keyword_risk","owned_by_usa_aeca_debarred_entity","owned_by_usa_bis_denied_persons_entity","owned_by_usa_bis_entity","owned_by_usa_bis_meu_entity","owned_by_usa_bis_unverified_entity","owned_by_usa_isn_entity","owned_by_usa_section_1260h_entity","owned_by_wro_entity","owned_by_xinjiang_entity","owner_of_aspi_forced_labor_entity","owner_of_blr_soe","owner_of_chinese_soe","owner_of_export_controls_entity","owner_of_export_controls_other_entity","owner_of_forced_labor_xinjiang_entity","owner_of_forced_labor_xinjiang_uflpa","owner_of_jpn_meti_end_user_entity","owner_of_jpn_mofa_export_ban_entity","owner_of_ofac_fto_sanctioned","owner_of_ofac_illicit_drugs_eo14059_sanctioned","owner_of_ofac_sdgt_sanctioned","owner_of_ofac_sdn_mex_dto_sanctioned","owner_of_ofac_sdnt_sanctioned","owner_of_ofac_sdntk_sanctioned","owner_of_regulatory_action_entity","owner_of_rus_soe","owner_of_sanctioned_arg_repet_jus_entity","owner_of_sanctioned_aus_dfat_entity","owner_of_sanctioned_bel_fpsf_entity","owner_of_sanctioned_can_gac_entity","owner_of_sanctioned_che_seco_entity","owner_of_sanctioned_cze_mof_entity","owner_of_sanctioned_entity","owner_of_sanctioned_eu_dg_fisma_ec_entity","owner_of_sanctioned_eu_ec_regulation_833_2014_entity","owner_of_sanctioned_eu_ec_sanctions_map_entity","owner_of_sanctioned_eu_sanctions_entity","owner_of_sanctioned_fra_dgt_mefids_entity","owner_of_sanctioned_gbr_fcdo_entity","owner_of_sanctioned_gbr_hmt_ofsi_entity","owner_of_sanctioned_isr_mod_nbctf_entity","owner_of_sanctioned_jpn_mof_entity","owner_of_sanctioned_ltu_mi_entity","owner_of_sanctioned_lva_fis_entity","owner_of_sanctioned_mys_moha_entity","owner_of_sanctioned_nld_mofa_entity","owner_of_sanctioned_nzl_mfat_rus_entity","owner_of_sanctioned_other_entity","owner_of_sanctioned_pol_mia_entity","owner_of_sanctioned_sgp_agc_entity","owner_of_sanctioned_ukr_nsdc_entity","owner_of_sanctioned_ukr_sfms_entity","owner_of_sanctioned_un_sc_entity","owner_of_sanctioned_usa_ofac_non_sdn_entity","owner_of_sanctioned_usa_ofac_sdn_entity","owner_of_sanctioned_xxx_ebrd_entity","owner_of_sanctioned_xxx_iabd_entity","owner_of_sheffield_hallam_university_reports_forced_labor_entity","owner_of_soe","owner_of_usa_aeca_debarred_entity","owner_of_usa_bis_denied_persons_entity","owner_of_usa_bis_entity","owner_of_usa_bis_meu_entity","owner_of_usa_bis_unverified_entity","owner_of_usa_isn_entity","owner_of_usa_section_1260h_entity","owner_of_wro_entity","pep","pep_adjacent","psa_bis_boycott_requester_list","psa_bis_entity_minority_ownership","psa_bis_meu_minority_ownership","psa_chinese_state_owned","psa_cmic_entity_50_percent_rule","psa_entity_licensed_with_fsb_rf","psa_eu_50_percent_rule","psa_eu_minority_ownership","psa_export_controls","psa_export_controls_bis_entity_50_percent_rule","psa_export_controls_bis_meu_50_percent_rule","psa_export_controls_other","psa_export_controls_section_1260h_50_percent_rule","psa_export_controls_unverified_list_50_percent_rule","psa_export_to_blr_soe","psa_export_to_chinese_soe","psa_export_to_rus_soe","psa_export_to_sanctioned","psa_export_to_sanctioned_other","psa_export_to_soe","psa_exports_bis_high_priority_items_critical_components_direct","psa_exports_bis_high_priority_items_critical_components_indirect","psa_exports_bis_high_priority_items_direct","psa_exports_bis_high_priority_items_indirect","psa_exports_conflict_minerals","psa_exports_eudr_shipment_cattle","psa_exports_eudr_shipment_cocoa","psa_exports_eudr_shipment_coffee","psa_exports_eudr_shipment_palm_oil","psa_exports_eudr_shipment_rubber","psa_exports_eudr_shipment_soya","psa_exports_eudr_shipment_wood","psa_exports_ilab_child_labor","psa_exports_ilab_forced_labor","psa_exports_russian_coal","psa_exports_russian_gold","psa_exports_russian_important_good","psa_exports_russian_oil","psa_exports_to_bis_addresses_high_diversion_risk","psa_exports_to_entity_licensed_with_fsb_rf","psa_exports_to_jpn_meti_end_user_entity","psa_exports_to_jpn_mofa_export_ban_entity","psa_exports_to_sanctioned_arg_repet_jus_entity","psa_exports_to_sanctioned_aus_dfat_entity","psa_exports_to_sanctioned_bel_fpsf_entity","psa_exports_to_sanctioned_can_gac_entity","psa_exports_to_sanctioned_che_seco_entity","psa_exports_to_sanctioned_cze_mof_entity","psa_exports_to_sanctioned_eu_dg_fisma_ec_entity","psa_exports_to_sanctioned_eu_ec_regulation_833_2014_entity","psa_exports_to_sanctioned_eu_ec_sanctions_map_entity","psa_exports_to_sanctioned_eu_sanctions_entity","psa_exports_to_sanctioned_fra_dgt_mefids_entity","psa_exports_to_sanctioned_gbr_fcdo_entity","psa_exports_to_sanctioned_gbr_hmt_ofsi_entity","psa_exports_to_sanctioned_isr_mod_nbctf_entity","psa_exports_to_sanctioned_jpn_mof_entity","psa_exports_to_sanctioned_ltu_mi_entity","psa_exports_to_sanctioned_lva_fis_entity","psa_exports_to_sanctioned_mys_moha_entity","psa_exports_to_sanctioned_nld_mofa_entity","psa_exports_to_sanctioned_nzl_mfat_rus_entity","psa_exports_to_sanctioned_pol_mia_entity","psa_exports_to_sanctioned_sgp_agc_entity","psa_exports_to_sanctioned_ukr_nsdc_entity","psa_exports_to_sanctioned_ukr_sfms_entity","psa_exports_to_sanctioned_un_sc_entity","psa_exports_to_sanctioned_usa_ofac_non_sdn_entity","psa_exports_to_sanctioned_usa_ofac_sdn_entity","psa_exports_to_sanctioned_xxx_ebrd_entity","psa_exports_to_sanctioned_xxx_iabd_entity","psa_exports_to_usa_aeca_debarred_entity","psa_exports_to_usa_bis_denied_persons_entity","psa_exports_to_usa_bis_entity","psa_exports_to_usa_bis_meu_entity","psa_exports_to_usa_bis_unverified_entity","psa_exports_to_usa_isn_entity","psa_exports_to_usa_section_1260h_entity","psa_forced_labor_aspi_origin_direct","psa_forced_labor_aspi_origin_subtier","psa_forced_labor_aspi_uyghur","psa_forced_labor_sheffield_hallam_university_reports_origin_direct","psa_forced_labor_sheffield_hallam_university_reports_origin_subtier","psa_forced_labor_uflpa_origin_direct","psa_forced_labor_uflpa_origin_subtier","psa_forced_labor_wro_origin_direct","psa_forced_labor_wro_origin_subtier","psa_forced_labor_xinjiang_cotton_entity","psa_forced_labor_xinjiang_geospatial","psa_forced_labor_xinjiang_name","psa_forced_labor_xinjiang_operations","psa_forced_labor_xinjiang_origin_direct","psa_forced_labor_xinjiang_origin_subtier","psa_forced_labor_xinjiang_registration","psa_forced_labor_xinjiang_uflpa","psa_imports_bis_high_priority_items","psa_imports_bis_high_priority_items_critical_components","psa_imports_conflict_minerals","psa_imports_eudr_shipment_cattle","psa_imports_eudr_shipment_cocoa","psa_imports_eudr_shipment_coffee","psa_imports_eudr_shipment_palm_oil","psa_imports_eudr_shipment_rubber","psa_imports_eudr_shipment_soya","psa_imports_eudr_shipment_wood","psa_imports_from_bis_addresses_high_diversion_risk","psa_imports_from_jpn_meti_end_user_entity","psa_imports_from_jpn_mofa_export_ban_entity","psa_imports_from_sanctioned_arg_repet_jus_entity","psa_imports_from_sanctioned_aus_dfat_entity","psa_imports_from_sanctioned_bel_fpsf_entity","psa_imports_from_sanctioned_can_gac_entity","psa_imports_from_sanctioned_che_seco_entity","psa_imports_from_sanctioned_cze_mof_entity","psa_imports_from_sanctioned_eu_dg_fisma_ec_entity","psa_imports_from_sanctioned_eu_ec_regulation_833_2014_entity","psa_imports_from_sanctioned_eu_ec_sanctions_map_entity","psa_imports_from_sanctioned_eu_sanctions_entity","psa_imports_from_sanctioned_fra_dgt_mefids_entity","psa_imports_from_sanctioned_gbr_fcdo_entity","psa_imports_from_sanctioned_gbr_hmt_ofsi_entity","psa_imports_from_sanctioned_isr_mod_nbctf_entity","psa_imports_from_sanctioned_jpn_mof_entity","psa_imports_from_sanctioned_ltu_mi_entity","psa_imports_from_sanctioned_lva_fis_entity","psa_imports_from_sanctioned_mys_moha_entity","psa_imports_from_sanctioned_nld_mofa_entity","psa_imports_from_sanctioned_nzl_mfat_rus_entity","psa_imports_from_sanctioned_pol_mia_entity","psa_imports_from_sanctioned_sgp_agc_entity","psa_imports_from_sanctioned_ukr_nsdc_entity","psa_imports_from_sanctioned_ukr_sfms_entity","psa_imports_from_sanctioned_un_sc_entity","psa_imports_from_sanctioned_usa_ofac_non_sdn_entity","psa_imports_from_sanctioned_usa_ofac_sdn_entity","psa_imports_from_sanctioned_xxx_ebrd_entity","psa_imports_from_sanctioned_xxx_iabd_entity","psa_imports_from_usa_aeca_debarred_entity","psa_imports_from_usa_bis_denied_persons_entity","psa_imports_from_usa_bis_entity","psa_imports_from_usa_bis_meu_entity","psa_imports_from_usa_bis_unverified_entity","psa_imports_from_usa_isn_entity","psa_imports_from_usa_section_1260h_entity","psa_imports_ilab_child_labor","psa_imports_ilab_forced_labor","psa_imports_ndaa_889_telecom_equipment","psa_imports_russian_coal","psa_imports_russian_gold","psa_imports_russian_important_good","psa_imports_russian_oil","psa_jpn_meti_end_user","psa_jpn_mofa_export_ban","psa_military_civil_fusion","psa_military_civil_fusion_50_percent_rule","psa_ofac_50_percent_rule","psa_ofac_minority_ownership","psa_ofac_sdn_mex_dto_sanctioned_adjacent","psa_owned_by_aspi_forced_labor_entity","psa_owned_by_bis_meu_entity","psa_owned_by_blr_soe","psa_owned_by_chinese_soe","psa_owned_by_cmic_entity","psa_owned_by_entity_in_export_controls","psa_owned_by_entity_in_export_controls_other","psa_owned_by_forced_labor_xinjiang_uflpa","psa_owned_by_jpn_meti_end_user_entity","psa_owned_by_jpn_mofa_export_ban_entity","psa_owned_by_military_civil_fusion","psa_owned_by_ofac_fto_sanctioned","psa_owned_by_ofac_illicit_drugs_eo14059_sanctioned","psa_owned_by_ofac_sdgt_sanctioned","psa_owned_by_ofac_sdn_mex_dto_sanctioned","psa_owned_by_ofac_sdnt_sanctioned","psa_owned_by_ofac_sdntk_sanctioned","psa_owned_by_regulatory_action_entity","psa_owned_by_rus_soe","psa_owned_by_sanctioned_arg_repet_jus_entity","psa_owned_by_sanctioned_aus_dfat_entity","psa_owned_by_sanctioned_bel_fpsf_entity","psa_owned_by_sanctioned_can_gac_entity","psa_owned_by_sanctioned_che_seco_entity","psa_owned_by_sanctioned_cze_mof_entity","psa_owned_by_sanctioned_entity","psa_owned_by_sanctioned_eu_dg_fisma_ec_entity","psa_owned_by_sanctioned_eu_ec_regulation_833_2014_entity","psa_owned_by_sanctioned_eu_ec_sanctions_map_entity","psa_owned_by_sanctioned_eu_sanctions_entity","psa_owned_by_sanctioned_fra_dgt_mefids_entity","psa_owned_by_sanctioned_gbr_fcdo_entity","psa_owned_by_sanctioned_gbr_hmt_ofsi_entity","psa_owned_by_sanctioned_isr_mod_nbctf_entity","psa_owned_by_sanctioned_jpn_mof_entity","psa_owned_by_sanctioned_ltu_mi_entity","psa_owned_by_sanctioned_lva_fis_entity","psa_owned_by_sanctioned_mys_moha_entity","psa_owned_by_sanctioned_nld_mofa_entity","psa_owned_by_sanctioned_nzl_mfat_rus_entity","psa_owned_by_sanctioned_other_entity","psa_owned_by_sanctioned_pol_mia_entity","psa_owned_by_sanctioned_sgp_agc_entity","psa_owned_by_sanctioned_ukr_nsdc_entity","psa_owned_by_sanctioned_ukr_sfms_entity","psa_owned_by_sanctioned_un_sc_entity","psa_owned_by_sanctioned_usa_ofac_non_sdn_entity","psa_owned_by_sanctioned_usa_ofac_sdn_entity","psa_owned_by_sanctioned_xxx_ebrd_entity","psa_owned_by_sanctioned_xxx_iabd_entity","psa_owned_by_section_1260h_entity","psa_owned_by_sheffield_hallam_university_reports_forced_labor_entity","psa_owned_by_soe","psa_owned_by_usa_aeca_debarred_entity","psa_owned_by_usa_bis_denied_persons_entity","psa_owned_by_usa_bis_entity","psa_owned_by_usa_bis_meu_entity","psa_owned_by_usa_bis_unverified_entity","psa_owned_by_usa_isn_entity","psa_owned_by_usa_section_1260h_entity","psa_owned_by_wro_entity","psa_owned_by_xinjiang_entity","psa_owner_of_aspi_forced_labor_entity","psa_owner_of_blr_soe","psa_owner_of_chinese_soe","psa_owner_of_export_controls_entity","psa_owner_of_export_controls_other_entity","psa_owner_of_forced_labor_xinjiang_entity","psa_owner_of_forced_labor_xinjiang_uflpa","psa_owner_of_jpn_meti_end_user_entity","psa_owner_of_jpn_mofa_export_ban_entity","psa_owner_of_ofac_fto_sanctioned","psa_owner_of_ofac_illicit_drugs_eo14059_sanctioned","psa_owner_of_ofac_sdgt_sanctioned","psa_owner_of_ofac_sdn_mex_dto_sanctioned","psa_owner_of_ofac_sdnt_sanctioned","psa_owner_of_ofac_sdntk_sanctioned","psa_owner_of_regulatory_action_entity","psa_owner_of_rus_soe","psa_owner_of_sanctioned_arg_repet_jus_entity","psa_owner_of_sanctioned_aus_dfat_entity","psa_owner_of_sanctioned_bel_fpsf_entity","psa_owner_of_sanctioned_can_gac_entity","psa_owner_of_sanctioned_che_seco_entity","psa_owner_of_sanctioned_cze_mof_entity","psa_owner_of_sanctioned_entity","psa_owner_of_sanctioned_eu_dg_fisma_ec_entity","psa_owner_of_sanctioned_eu_ec_regulation_833_2014_entity","psa_owner_of_sanctioned_eu_ec_sanctions_map_entity","psa_owner_of_sanctioned_eu_sanctions_entity","psa_owner_of_sanctioned_fra_dgt_mefids_entity","psa_owner_of_sanctioned_gbr_fcdo_entity","psa_owner_of_sanctioned_gbr_hmt_ofsi_entity","psa_owner_of_sanctioned_isr_mod_nbctf_entity","psa_owner_of_sanctioned_jpn_mof_entity","psa_owner_of_sanctioned_ltu_mi_entity","psa_owner_of_sanctioned_lva_fis_entity","psa_owner_of_sanctioned_mys_moha_entity","psa_owner_of_sanctioned_nld_mofa_entity","psa_owner_of_sanctioned_nzl_mfat_rus_entity","psa_owner_of_sanctioned_other_entity","psa_owner_of_sanctioned_pol_mia_entity","psa_owner_of_sanctioned_sgp_agc_entity","psa_owner_of_sanctioned_ukr_nsdc_entity","psa_owner_of_sanctioned_ukr_sfms_entity","psa_owner_of_sanctioned_un_sc_entity","psa_owner_of_sanctioned_usa_ofac_non_sdn_entity","psa_owner_of_sanctioned_usa_ofac_sdn_entity","psa_owner_of_sanctioned_xxx_ebrd_entity","psa_owner_of_sanctioned_xxx_iabd_entity","psa_owner_of_sheffield_hallam_university_reports_forced_labor_entity","psa_owner_of_soe","psa_owner_of_usa_aeca_debarred_entity","psa_owner_of_usa_bis_denied_persons_entity","psa_owner_of_usa_bis_entity","psa_owner_of_usa_bis_meu_entity","psa_owner_of_usa_bis_unverified_entity","psa_owner_of_usa_isn_entity","psa_owner_of_usa_section_1260h_entity","psa_owner_of_wro_entity","psa_pep","psa_regulatory_action","psa_sanctioned","psa_sanctioned_arg_repet_jus","psa_sanctioned_aus_dfat","psa_sanctioned_bel_fpsf","psa_sanctioned_can_gac","psa_sanctioned_che_seco","psa_sanctioned_cze_mof","psa_sanctioned_eu_dg_fisma_ec","psa_sanctioned_eu_ec_regulation_833_2014","psa_sanctioned_eu_ec_sanctions_map","psa_sanctioned_eu_sanctions","psa_sanctioned_fra_dgt_mefids","psa_sanctioned_gbr_fcdo","psa_sanctioned_gbr_hmt_ofsi","psa_sanctioned_isr_mod_nbctf","psa_sanctioned_jpn_mof","psa_sanctioned_ltu_mi","psa_sanctioned_lva_fis","psa_sanctioned_mys_moha","psa_sanctioned_nld_mofa","psa_sanctioned_nzl_mfat_rus","psa_sanctioned_other","psa_sanctioned_pol_mia","psa_sanctioned_sgp_agc","psa_sanctioned_ukr_nsdc","psa_sanctioned_ukr_sfms","psa_sanctioned_un_sc","psa_sanctioned_usa_ofac_non_sdn","psa_sanctioned_usa_ofac_sdn","psa_sanctioned_xxx_ebrd","psa_sanctioned_xxx_iabd","psa_sheffield_hallam_university_forced_labor_entity","psa_sheffield_hallam_university_intermediary_entity","psa_sheffield_hallam_university_useful_resources","psa_state_owned","psa_state_owned_blr","psa_state_owned_rus","psa_state_owned_ven","psa_uk_50_percent_rule","psa_uk_minority_ownership","psa_usa_aeca_debarred","psa_usa_bis","psa_usa_bis_50_percent_rule","psa_usa_bis_denied_persons","psa_usa_bis_meu","psa_usa_bis_meu_50_percent_rule","psa_usa_bis_unverified","psa_usa_isn","psa_usa_section_1260h","psa_ven_soe_50_percent","psa_wro_entity","regulatory_action","reputational_risk_bribery_and_corruption","reputational_risk_bribery_and_corruption_breaking","reputational_risk_bribery_and_corruption_historic","reputational_risk_bribery_and_corruption_recent","reputational_risk_cybercrime","reputational_risk_cybercrime_breaking","reputational_risk_cybercrime_historic","reputational_risk_cybercrime_recent","reputational_risk_financial_crime","reputational_risk_financial_crime_breaking","reputational_risk_financial_crime_historic","reputational_risk_financial_crime_recent","reputational_risk_forced_labor","reputational_risk_forced_labor_breaking","reputational_risk_forced_labor_historic","reputational_risk_forced_labor_recent","reputational_risk_organized_crime","reputational_risk_organized_crime_breaking","reputational_risk_organized_crime_historic","reputational_risk_organized_crime_recent","reputational_risk_other","reputational_risk_other_breaking","reputational_risk_other_historic","reputational_risk_other_recent","reputational_risk_terrorism","reputational_risk_terrorism_breaking","reputational_risk_terrorism_historic","reputational_risk_terrorism_recent","sanctioned","sanctioned_adjacent","sanctioned_arg_repet_jus","sanctioned_aus_dfat","sanctioned_bel_fpsf","sanctioned_can_gac","sanctioned_che_seco","sanctioned_cze_mof","sanctioned_eu_dg_fisma_ec","sanctioned_eu_ec_regulation_269_2014","sanctioned_eu_ec_regulation_833_2014","sanctioned_eu_ec_sanctions_map","sanctioned_eu_sanctions","sanctioned_fra_dgt_mefids","sanctioned_gbr_fcdo","sanctioned_gbr_hmt_ofsi","sanctioned_isr_mod_nbctf","sanctioned_jpn_mof","sanctioned_ltu_mi","sanctioned_lva_fis","sanctioned_mys_moha","sanctioned_nld_mofa","sanctioned_nzl_mfat_rus","sanctioned_other","sanctioned_other_adjacent","sanctioned_pol_mia","sanctioned_sgp_agc","sanctioned_ukr_nsdc","sanctioned_ukr_sfms","sanctioned_un_sc","sanctioned_usa_ofac_non_sdn","sanctioned_usa_ofac_sdn","sanctioned_xxx_ebrd","sanctioned_xxx_iabd","sheffield_hallam_university_forced_labor_entity","sheffield_hallam_university_forced_labor_reports_entity_adjacent","sheffield_hallam_university_forced_labor_reports_intermediary_entity","sheffield_hallam_university_useful_resources","soe_adjacent","state_owned","state_owned_blr","state_owned_rus","state_owned_ven","subsidiary_of_ndaa_889_covered_entities","tcsp_keyword_risk","uk_50_percent_rule","uk_minority_ownership","uk_sanctioned","usa_aeca_debarred","usa_bis","usa_bis_50_percent_rule","usa_bis_denied_persons","usa_bis_meu","usa_bis_meu_50_percent_rule","usa_bis_unverified","usa_isn","usa_section_1260h","ven_soe_50_percent","wro_entity","wro_entity_adjacent"],"title":"Risk"},"generatedTypes_Entities":{"type":"string","enum":["account","aircraft","company","contract","generic","government_organization","intellectual_property","legal_matter","person","property","security","shipment","tradename","transaction","unknown","vessel"],"description":"This represents which type of entity is being returned.","title":"Entities"},"generatedTypes_IdentifierType":{"type":"string","enum":["acer_code","aer_free_zone_license","aer_free_zone_reg_no","aer_ner_number","afg_business_license","afg_passport","afg_trade_internal_shipment_id","afghan_tin_number","ago_matricula_number","ago_nif_number","alb_registration_number","alb_tax_id","alberta_corporation_number","alei","are_difc_reg_no","are_dubai_land_case_no","are_reg_auth_number","arg_cdi_number","arg_cuil_number","arg_cuit_number","arg_dni_number","arg_igj_number","arg_import_export_id","arg_lib_civica_number","arg_lib_enrolamiento_number","arg_partial_cuit","arm_enterprise_code","arm_passport_number","arm_registration_no","arm_statement_identifier","arm_vat_no","aruba_chamber_of_commerce_id","atg_business_registry_internal_id","aus_adv_number","aus_afs_licence_number","aus_afs_rep_number","aus_business_number","aus_company_number","aus_consolidated_sanctions_reference","aus_credit_licence_number","aus_credit_rep_number","aus_equifax_uhc_name_hash","aus_passport","aus_trademark_reg_no","aut_firmenbuch_no","aut_uid","aze_tin_number","bd_bin","bel_enterprise_number","bel_establishment_number","bel_fsma_name_hash","bel_national_register_no","bel_vat_number","bfa_entity_id","bfa_rccm_number","bgd_passport","bgd_tin","bgr_egn_hashed","bgr_uic","bh_cr_number","bh_cr_number_and_branch","bhr_passport","bhs_tin","bih_customs_number","bih_jib_number","bih_mbs_number","bill_of_lading","bitcoin_address","blr_passport","blr_registration_number","blz_bccar_reg_no","bmu_registrar_of_companies_number","bmu_registration_number","bol_matricula","bol_old_matricula","bra_case_number","bra_cnpj","bra_codigo_da_unidade_organizacional","bra_cpf_number","bra_foreigner_reg_num","bra_rg_number","bra_servidor_portal","bra_shipment_number","bwa_uin_reg_number","bze_bicar_reg_no","ca_corporate_id_num","ca_lp_file_num","caf_passport","cage","can_bc_company_registration_id","can_bc_extraprovincial_registration_id","can_bc_registration_number","can_business_number","can_corporation_number","can_cra_program_account_number","can_data_axle_hash","can_ipo_trademark_application_no","can_mb_registry","can_new_brunswick_reference_number","can_nl_corporate_registry","can_nrd","can_nrd_individual_id","can_ns_corporate_registry","can_pe_registration_number","can_qc_mbs_num","can_qc_sap_registry_ref_num","can_sedar_profile_number","can_techsalerator_id","can_tm_registration_no","ccamlr_rfmo_id","ccs_registration","ccsbt_rfmo_id","che_ch_id_number","che_seco_sanction_number","che_uid_number","china_vessel_inspection_registration","china_vessel_registration","chl_cedula_number","chl_import_export_control_id","chl_import_manifest_number","chl_importer_exporter_id","chn_algorithm_filing_no","chn_cninfo_internal_shareholder_id","chn_cnipa_tm","chn_csrc_no","chn_customs_registration_code","chn_customs_registration_no","chn_passport","chn_resident_id_number","chn_shanghai_stock_exchange_company_code","chn_shenzen_sec_code","cm_nui_tax_reg_num","cma_id","cn_hk_br_number","cn_hk_cr_number","cn_hk_filing_number","cn_hurd_internal_company_id","cn_importexport_code","cn_invest_code","cn_organization_code","cn_qichacha_internal_id","cn_registration_number","cn_tax_identification_number","cn_tianyancha_company_id","cn_tianyancha_human_id","cn_unified_social_credit_code","cod_passport","cod_rccm_number","cod_rccm_ohada_number","cok_corp_reg_corpid","cok_corp_reg_corpofficerid","cok_corp_reg_number","col_cedula_no","col_dian_numero_formulario","col_nit_no","col_nur","col_secop_no","cri_cedula_citizen_person","cri_cedula_foreign_person","cri_cedula_juridica","cri_cedula_number","cri_exp","cri_imp","cri_op_no","cub_cod","cuw_reg_number","cym_co_no","cyp_id_card","cyp_infocredit_entity_id","cyp_passport","cyp_reg_no","cyp_ssn","cze_file_number","cze_ico_number","dart_cik","dash_address","deu_bafin_id","deu_registernummer","deu_vat_number","dji_rcs_number","dma_business_registry_internal_id","dnk_cvr","dnk_entity","dnk_production_unit_no","dom_onapi_num","dom_rnc","duns_number","ecu_branch_id","ecu_cedula_number","ecu_company_id","ecu_exporter_id","ecu_importer_id","ecu_ruc_number","ecu_shipment_ref_no","egy_id","egy_passport","eic_code","esp_be_code","esp_borme_reg_id","esp_cif","esp_internal_employee_number","esp_nif","esp_tr_number","est_business_reg_code","est_personal_id","ethereum_address","eu_fsd_id","eu_sanction_rn","euid","fdic_num","fed_fin_id","ffa_rfmo_id","fin_business_id","fin_vat_number","fl_prop_folio","fl_prop_folio_dade","fra_asset_freeze_id","fra_passport","fra_rna","fra_siren","fra_siret","fra_vat_number","fro_reg_num","gbr_charity_no","gbr_company_number","gbr_contract_id","gbr_disqualification_case_num","gbr_enforcement_action_num","gbr_go_no","gbr_grant_id","gbr_hm_treasury_sanction_group_id","gbr_ipo_trademark_reg_no","gbr_trade_internal_shipment_id","gbr_trustee_id","gbr_uk_sanctions_id","gbr_vat_no","geo_identification_code","geo_legal_code","geo_personal_number","geo_state_registration_number","gfcm_rfmo_id","ggy_corporate_reg_number","ggy_trademark_no","ggy_trademark_submission_ref","gib_corp_reg_number","gln_code","global_trade_internal_shipment_id","grc_afm_number","grc_gemi_number","grc_passport","grc_vat_number","gtm_cui_number","gtm_nit_number","hkg_identity_card","hkg_stock_code","hkg_tender_ref_code","hnd_coc_company_registration_number","hnd_tegucigalpa_matricula","hong_kong_case_number","hr_mbs","hr_oib","hun_company_register_number","hun_krs_number","hun_person_tax_id","hun_tax_number","iattc_rfmo_id","iban","iccat_rfmo_id","icij_offshore_internal_id","icij_offshore_node_id","idn_nik_id","idn_no_sk","idn_passport","idn_tax_id","idn_trade_internal_shipment_id","idn_transaction_number","idn_ubo_owner_id","ihs_owner_code","imn_company_number","imo_no","ind_bse_ticker_code","ind_charity_registration_number","ind_company_registration_number","ind_coopsoc_registration_number","ind_corporate_id_number","ind_darpan_uid","ind_director_id_number","ind_fcrn","ind_gstin","ind_ifsc","ind_llpin","ind_nse_ticker_code","ind_passport","ind_permanent_account_number","ind_society_registration_number","ind_techsalerator_id","ind_tin","ind_trademark_submission_ref","ind_udyam","int_maritime_org_id","internal_curated_merge_id","internal_curated_split_id","internal_md5","iotc_rfmo_id","iraqi_stock_exchange_symbol","irl_rcn","irl_registration_no","irn_coc_internal_id","irn_coc_internal_id_cardno","irn_national_id","irn_national_number","irn_passport","irq_passport","irq_voter_id","isin","isl_tin_number","isl_vat_num","isr_association_number","isr_company_number","isr_national_id","isr_passport","isr_pbc_number","ita_fiscal_code","ita_rea_number","ita_vat_number","jam_company_id","jey_corporate_reg_number","jey_trademark_reg_no","jo_institution_number","jo_internal_id","jo_national_institution_number","jor_id_no","jor_passport","jor_voter_card_no","jordan_company_no","jpn_corporate_no","jpn_edinet_code","jpn_trade_internal_shipment_id","kaz_bin","kaz_business_identification_number","kaz_identifier","kaz_okpo_num","kaz_state_reg_num","kaz_tin","ken_personal_id","kgz_reg_number","khm_tin_number","kor_business_tin","kor_corporate_registration_number","kor_trade_internal_shipment_id","krx_ticker_code","kwt_passport","lao_enterprise_number","lbn_national_id","lbn_passport","lby_passport","lca_business_registry_internal_id","lei","lie_public_reg_no","litecoin_address","lloyds_internal_entity_id","lloyds_internal_vessel_id","lr_tin","lso_corpreg_id","ltu_company_registration_code","lux_rcs_number","lva_insolvency_proceeding_id","lva_personal_code","lva_reg_number","mac_raem_case_url_id","mac_registration_no","malta_accountancy_registration_id","malta_company_number","malta_national_id","mar_passport","mato_grosso_legal_id","mco_nis","mco_rci_number","mda_idno_number","mdg_nif_number","mdg_rcs_number","mdg_stat_number","mdv_registration_number","mex_cluni","mex_denue_clee","mex_open_contracts_internal_id","mex_rnie","mex_shipment_number","mex_tm_no","mex_yucatan_folio","mh_reg_id","mkd_archive_number","mkd_embs_branch_number","mkd_embs_number","mmm_id","mmr_corp_id","mmr_officer_id","mmr_personal_id_no","mmr_prior_reg_no","mmr_reg_no","mne_pib","mne_property_uid","mne_reg_number","mng_reg_number","montana_sos_internal_entity_id","moz_dire_no","moz_id_number","moz_nuel_no","moz_nuit_co","moz_nuit_person","moz_passport","moz_voter_no","mus_file_no","mus_reg_id","mw_tpin_tax_reg_num","mx_curp","mx_office_fme","mx_rfc_company","mx_rfc_person","mys_company_reg_no","mys_id_card_no","mys_moha_list_number","mys_passport","ncua_num","ng_check_internal_id","nga_crp_reg_internal_id","nga_drivers","nga_nin","nga_passport","nga_registration_number","nga_registration_sn","nga_tax_id","nic_numero_unico","nic_ruc_number","nic_trade_internal_shipment_id","ninea_no","nld_kvk_branch_number","nld_kvk_number","nor_org_no","npfc_rfmo_id","npl_co_reg_no","nyc_bbl","nyc_crfn","nzl_co_no","nzl_nzbn","nzl_russia_sanctions_uid","omn_passport","on_business_id_number","ontario_corporation_number","open_sanctions_internal_id","pak_co_ntn","pak_egm_id","pak_ind_ntn","pak_ngo_reg_no","pak_passport","pan_cedula_number","pan_declaration_number","pan_folio_ficha_id","pan_importer_exporter_id","panadata_internal_id","panadata_internal_sid","per_carne_de_extranjeria","per_dni_no","per_ruc_no","phl_bnn","phl_passport","phl_pse_id","phl_sec_id","phl_tin","png_ipa_reg_id","pol_krs_number","pol_nip_number","pol_regon_number","pol_rejestr_person_id","prk_entity_id","prk_internal_trade_id","prk_passport","prk_registration_id","prk_shipment_id","prt_nipc","prt_trust_number","prt_vat_number","pry_cedula_number","pry_old_ruc_number","pry_ruc_number","pry_shipment_number","pry_tax_id","pse_registration_id","qat_cr_number","qat_passport","qat_qfc_number","quebec_enterprise_number","rccm_no","rio_de_janeiro_legal_id","rks_business_number","rks_fiscal_number","rks_registration_number","rou_commercial_register_id","rou_company_registration_code","rou_company_tin","rou_identity_card","rou_personal_id_number","ru_inn","ru_ogrn","ru_registration_number","ru_ship_register_id","ru_tin","ru_trade_internal_shipment_id","rus_bik_code","rus_contract_number","rus_declaration_number","rus_micex_code","rus_passport","rus_tourist_obj","saskatchewan_registry_number","sau_cr_number","sau_establishment_num","sau_id","sau_passport","sayari_internal_identifier","sesamm_company_id","sgp_passport","sgp_unqiue_entity_number","siger_internal_id","slb_reg_id","slv_commercial_reg_number","slv_mcas","slv_numero_identificacion_tributaria","slv_uid_number","smr_economic_operator_code","snl_internal_id","som_passport","som_ubi","south_africa_enterprise_number","south_africa_passport_number","sp_company_id","sp_key","srb_beneficial_owner_id","srb_branch_id","srb_mb_number","srb_pib_number","ssd_passport","stock_ticker","svk_ico_number","svk_vat_num","svn_ajpes_zapst_number","svn_co_reg_no","svn_vat_number","swe_fi_id","swe_org_no","swe_per_id_no","swe_tax_number","swift_bic_code","syr_passport","syria_commercial_register_number","tcu_id","tha_registration_no","tjk_ein_number","tjk_tin_number","tokyo_stock_exchange_no","ton_reg_id","ton_tax_id","tto_biz_number","tun_passport","tur_id","tur_istanbul_coc_reg_no","tur_izmir_coc_reg_no","tur_mersis_number","tur_passport","tur_shipment_id","tur_tax_id","tur_ticaret_sicil_no","twn_factory_establishment_permit_case_number","twn_factory_registration_number","twn_passport_number","twn_unified_number","tx_corp_file_num","tx_entity_filing_num","tx_land_id","tx_pacs_id","tx_prop_id","tx_tax_id","tza_brela_reg_num","tza_tansad_number","tza_tin","uga_passport","uga_tin","uk_company_number","uk_firm_reference_number","uk_passport","uk_person_number","uk_title_number","ukr_fiu_list_number","ukr_moj_id","ukr_passport","ukr_reg_num","ukr_sanctions_nazk_company_internal_id","ukr_sanctions_nazk_person_internal_id","un_sanction_prn","ury_ruc_number","usa_ak_entity_no","usa_al_sos_id","usa_ar_filing_no","usa_az_corp_reg_entity_num","usa_central_registration_depository_number","usa_cgac_agency_code","usa_co_reg_no","usa_consolidated_screening_list_synthetic_id","usa_corpwatch_id","usa_ct_business_id","usa_ct_internal_id","usa_cusip_number","usa_dc_entity_no","usa_dc_file_no","usa_dc_ssl","usa_de_file_number","usa_de_registered_agent_id","usa_fei_number","usa_fl_document_no","usa_fl_fic_name_reg_no","usa_fl_martin_pid","usa_fl_pb_pcn","usa_fl_property_id","usa_fl_property_mp_id","usa_fl_property_state_par_id","usa_fl_sl_pid","usa_ga_business_id","usa_ga_control_no","usa_govt_agency_id","usa_govt_office_id","usa_hi_corporate_registry_id","usa_hi_corporate_registry_person_id","usa_hi_trade_name_cert","usa_ia_corp_no","usa_id_control_no","usa_id_party_id","usa_il_chicago_account_number","usa_il_file_number","usa_in_biz_no","usa_irs_ein","usa_irs_giin","usa_ks_biz_id","usa_ky_org_no","usa_la_sos_id","usa_mass_sos_company_id","usa_md_dpt_tax","usa_me_corp_id","usa_mi_corp_id","usa_mi_corp_id_old","usa_mn_filing_number","usa_mn_master_id","usa_mo_corp_id","usa_ms_biz_id","usa_nc_internal_id","usa_nd_control_id","usa_ne_acct_no","usa_ne_agent_id","usa_nh_business_id","usa_nj_business_id","usa_nm_business_no","usa_nm_license_id","usa_npi_number","usa_nv_bizid","usa_nv_corpno","usa_ny_dos_id","usa_ny_reg_id","usa_ofac_sdn_number","usa_oh_charter_num","usa_ok_filing_no","usa_or_regno","usa_oti_id","usa_pa_corporate_registry_id","usa_piid","usa_prime_award_unique_key","usa_puerto_rico_register_number","usa_ri_fei_no","usa_sam_exclusions_number","usa_sam_uei_number","usa_sc_corp_id","usa_sd_corp_id","usa_sec_cik_number","usa_sec_file_number_bd","usa_sec_file_number_ia","usa_sec_private_fund","usa_social_security_number","usa_subaward_sam_report_id","usa_tn_control_no","usa_tn_party_id","usa_upin_number","usa_uspto_foreign_application_no","usa_uspto_foreign_reg_no","usa_uspto_reg_no","usa_uspto_serial_number","usa_usvi_corp_number","usa_va_fairfax_parcel_id","usa_va_old_reg_id","usa_va_reg_id","usa_vt_biz_id","usa_washington_state_ubi","usa_wi_dfi_id","usa_wv_reg_id","usa_wy_filing_id","usa_wy_filing_num","usa_wy_internal_filing_id","usa_wy_party_id","utah_corporate_registry_internal_entity_number","uzb_tin_number","uzb_vat_number","validatis_number","vat","ven_cedula_number","ven_rif","ven_rnc_number","ven_saren_internal_employer_number","vgb_company_number","vnm_citizenship_no","vnm_dichvuthongtin_internal_id","vnm_enterprise_code","vnm_person_id_no","vut_corp_reg_number","wcpfc_rfmo_id","wipo_intl_ref_no","wipo_intl_reg_no","wsm_reg_id","xxx_acuris_id","xxx_cedar_rose_person_uid","xxx_cedar_rose_uid","xxx_crb_monitor_entity_id","xxx_edi_global_issuer_id","xxx_edi_global_security_id","xxx_eu_esma_sanctions_id","xxx_intel_internal_id","xxx_rccm","yem_coc_registration_number","yem_passport","yugoslav_master_citizen_num","zcash_address"],"description":"Describes the real-world type of an identifier value that uniquely (strongly) identifies an entity. These are often associated with a governmental organization within a certain jurisdiction. Some of these types are deprecated, meaning they are no longer used.","title":"IdentifierType"},"generatedTypes_WeakIdentifierType":{"type":"string","enum":["arg_igj_number","arg_import_export_id","atg_corporate_registry_entity_num","aus_asic_disqualified_persons_number","aus_declaration_number","aus_state_reg_number","aus_trade_internal_shipment_id","aut_former_cr_no","aut_natl_bank_no","bgd_bill_of_entry","bih_mbs_number","bill_of_lading","bmu_registration_number","bol_shipment_declaration_number","bra_partial_cpf","brazilian_oab","bwa_shipment_number","cage","can_procurement_id","can_reference_number","ccs_ship_class_number","cfi_code","chl_santiago_gazette_cve","chn_cninfo_legal_person_id","chn_contract_number","chn_customs_registration_code","chn_partial_resident_id_number","chn_project_number","civ_aeo_code","cmr_shipment_declaration_number","cn_qcc_internal_id","cofi_code","col_bill_of_lading","col_declaration_number","col_matricula_mercantil","col_secop_no","cri_op_no","cri_shipment_declaration_number","cze_file_number","deu_registernummer","dma_corporate_registry_entity_num","esp_internal_employee_number","gbr_bankruptcy_case_num","gbr_charity_no","gbr_declaration_number","gbr_grant_info_number","geo_state_registration_number","gha_shipment_declaration_number","habw_id","hkg_partial_identity_card","hkg_stock_code","hnd_tegucigalpa_notary","hun_opten_id","igm_number","ind_sebi","ind_shipment_bill_id","int_trade_internal_shipment_id","international_trademark_no","irl_registration_no","irn_reg_number","irq_provision_card","ita_ebr_reg_number","ita_ebr_short_search_code","jor_sol_prop_institution_number","jordan_company_no","jpn_declaration_number","jpn_permit_no","kaz_shipment_declaration_number","ken_shipment_declaration_number","kgz_inn","kgz_okpo","khm_tin_number","kor_declaration_number","lbn_family_number","lbn_registration_number","lbr_tin","lca_corporate_registry_entity_num","lso_import_entry_number","lva_court_case_id","lva_person_id_masked","mac_raem_case_number","maritime_call_sign","maritime_mobile_service_identity","mbl_hm_hud_num","mbl_hm_sn","mbl_hm_title_num","mdg_nif_number","mdg_rcs_number","mex_declaranet_acuse","mex_shipment_declaration_number","mex_tm_app_no","mex_tm_reg_no","mlr_reg_num","mwi_shipment_reg_no","mx_fme","mx_partial_rfc_person","mys_declaration_number","mys_partial_national_identity_number","mys_trade_shipment_id","nam_shipment_assessment_no","nam_shipment_reg_no","nga_drivers","nga_nin","nga_registration_number","nga_registration_sn","nga_shipment_registry_number","pak_cnic_family_no","pak_old_company_code","pak_shipment_bill_number","pan_folio","pan_ibc_ruc","partial_ven_cedula","per_shipment_control_id","pol_nip_number","pol_regon_number","prk_internal_trade_id","prk_ship_reg_no","pry_shipment_number","rks_business_number","rks_fiscal_number","rks_kta_number","rou_commercial_register_id","ru_kpp","ru_license_number","ru_nza","ru_okpo","ru_oktmo","rus_cbr_id","rus_contract_internal_id","rus_procurement_notice_number","sgp_partial_national_identity_number","slb_foreign_investor_id","south_africa_partial_id_number","svk_filing_number","tokyo_shoko_id","ton_foreign_investor_id","tur_declaration_number","tur_office_registration_number","tur_partial_mersis_number","tx_bexar_property_geo_id","tza_bill_of_lading","tza_crn_no","tza_tansad_number","ukr_edrpou","ukr_registration_document_number","ukr_shipment_declaration_number","unknown","unknown_bra_case_number","unknown_chamber_of_commerce_id","unknown_civil_reg_num","unknown_commercial_register_id","unknown_folio_id_num","unknown_industrial_license_num","unknown_license_num","unknown_national_id_num","unknown_passport","unknown_residency_num","usa_camdbs_id","usa_cbp_wro_id","usa_cedri_id","usa_eis_id","usa_epa_facility_registry_system","usa_former_fein","usa_frs_id","usa_generic_ticker","usa_ghgrp_id","usa_icis_air_id","usa_icis_id","usa_icis_npdes_id","usa_il_chicago_site_number","usa_imports_system_identity_id","usa_mn_filing_number","usa_mo_corp_number","usa_mo_entity_id","usa_nc_corp_no","usa_nm_license_id","usa_prime_award_fain","usa_prime_award_piid","usa_rcra_info_id","usa_rmp_id","usa_sam_uei_number","usa_sdwis_id","usa_sems_id","usa_subaward_number","usa_tri_id","usa_tsca_id","uzb_customs_registration_number","vat","ven_colegiado_number","ven_manifiesto_number","ven_rnc_number","vnm_shipment_declaration_number","malformed mmr_prior_reg_no"],"description":"This includes all weak (non-unique) identifiers in Sayari's database.","title":"WeakIdentifierType"},"generatedTypes_BothIdentifierTypes":{"oneOf":[{"$ref":"#/components/schemas/generatedTypes_IdentifierType"},{"$ref":"#/components/schemas/generatedTypes_WeakIdentifierType"}],"title":"BothIdentifierTypes"},"sharedTypes_Identifier":{"type":"object","properties":{"value":{"type":"string"},"type":{"$ref":"#/components/schemas/generatedTypes_BothIdentifierTypes","description":"[Identifier Type](/sayari-library/ontology/enumerated-types#identifier-type) or [Weak Identifier Type](/sayari-library/ontology/enumerated-types#weak-identifier-type)"},"label":{"type":"string"}},"required":["value","type","label"],"description":"Identifiers associated with the entity.","title":"Identifier"},"sharedTypes_SourceCountInfo":{"type":"object","properties":{"count":{"type":"integer"},"label":{"type":"string"}},"required":["count","label"],"description":"The number of time the entity is referenced by a source.","title":"SourceCountInfo"},"sharedTypes_RelationshipCount":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of related entities for a given [relationship type](/sayari-library/ontology/relationships).","title":"RelationshipCount"},"sharedTypes_EntityRegistrationDate":{"type":"string","description":"Type (registered/incorporated/active) and date of the earliest significant activity associated with the entity. Will appear as 'Registered YYYY-MM-DD'","title":"EntityRegistrationDate"},"sharedTypes_EntityTranslatedLabel":{"type":"string","description":"Label in English if available. Translation performed by Sayari.","title":"EntityTranslatedLabel"},"sharedTypes_EntityHSCode":{"type":"string","description":"Harmonized Tariff Schedule Code associated with the entity/shipment","title":"EntityHSCode"},"sharedTypes_ShipmentArrival":{"type":"string","description":"Arrival date of a shipment.","title":"ShipmentArrival"},"sharedTypes_ShipmentDeparture":{"type":"string","description":"Departure date of a shipment.","title":"ShipmentDeparture"},"sharedTypes_CompanyType":{"type":"string","description":"A type of legal entity in a given jurisdiction (e.g. 'LLC,' 'Sociedad Anonima,' 'Private Company Limited by Shares')","title":"CompanyType"},"sharedTypes_Status":{"type":"object","properties":{"status":{"type":"string"},"date":{"type":"string"}},"required":["status"],"description":"The most recent status of an entity and when that status was observed.","title":"Status"},"sharedTypes_RiskValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"title":"RiskValue"},"sharedTypes_RiskLevel":{"type":"string","enum":["critical","high","elevated","relevant"],"title":"RiskLevel"},"sharedTypes_RiskData":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/sharedTypes_RiskValue"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"}},"level":{"$ref":"#/components/schemas/sharedTypes_RiskLevel","description":"The severity of the risk."}},"required":["value","metadata","level"],"title":"RiskData"},"sharedTypes_EntityRisk":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_RiskData"},"description":"Risk factors associated with the entity.","title":"EntityRisk"},"baseTypes_CountQualifier":{"type":"string","enum":["eq","gte"],"title":"CountQualifier"},"baseTypes_QualifiedCount":{"type":"object","properties":{"count":{"type":"integer"},"qualifier":{"$ref":"#/components/schemas/baseTypes_CountQualifier"}},"required":["count","qualifier"],"title":"QualifiedCount"},"generatedTypes_AdditionalInformationProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"type":"string","description":"The type of additional information being conveyed"},"value":{"type":"string","description":"The additional information itself"}},"title":"AdditionalInformationProperties"},"generatedTypes_AdditionalInformationData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_AdditionalInformationProperties"}},"required":["record","record_count","properties"],"title":"AdditionalInformationData"},"generatedTypes_AdditionalInformationInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_AdditionalInformationData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"This is a generic attribute used to hold miscellaneous information not covered by any other attribute. Includes \"value\" (for the attribute itself), \"type\" (a name: e.g., \"Real property description\"), and \"extra\" (a miscellaneous field to hold any other details).","title":"AdditionalInformationInfo"},"generatedTypes_Language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"description":"Language enums are normalized representations of languages. [Source](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).","title":"Language"},"generatedTypes_AddressProperties":{"type":"object","properties":{"building":{"type":"string"},"category":{"type":"string","description":"For category queries like \"restaurants\", etc."},"city":{"type":"string","description":"Any human settlement, including cities, towns, villages, hamlets, localities, etc."},"city_district":{"type":"string","description":"Boroughs or districts within a city that serve some official purpose (e.g., \"Brooklyn\", \"Hackney\", or \"Bratislava IV\")"},"country":{"type":"string","description":"Sovereign nations and their dependent territories; anything with an ISO 3166 code"},"country_region":{"type":"string","description":"Informal subdivision of a country without any political status"},"date":{"type":"string","description":"as-of date of attribute"},"entrance":{"type":"string","description":"Numbered/lettered entrance"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"house":{"type":"string","description":"Building/site name (e.g., \"Brooklyn Academy of Music\", \"Empire State Building\")"},"house_number":{"type":"string","description":"Usually refers to the external (street-facing) building number. In some jurisdictions, this may be a compound number that also includes an apartment/block number."},"island":{"type":"string","description":"Named islands (e.g., \"Maui\")"},"language":{"$ref":"#/components/schemas/generatedTypes_Language","description":"The language in which the address was provided in the record"},"level":{"type":"string","description":"Expressions indicating a floor number (e.g., \"3rd Floor\", \"Ground Floor\")"},"metro_station":{"type":"string"},"near":{"type":"string","description":"Phrases like \"in\", \"near\", etc. used after a category phrase, to help with parsing queries like \"restaurants in Brooklyn\""},"normalized":{"type":"string"},"po_box":{"type":"string","description":"Typically found in non-physical (mail-only) addresses"},"postcode":{"type":"string","description":"Postal codes used for mail sorting"},"precision_code":{"type":"string","description":"A code describing the precision of the X and Y coordinates"},"road":{"type":"string","description":"Street name(s)"},"staircase":{"type":"string","description":"Numbered/lettered staircase"},"state":{"type":"string","description":"A first-level administrative division, including provinces and departments. Scotland, Northern Ireland, Wales, and England in the UK are also mapped to \"state\" (convention commonly used in geocoding tools)."},"state_district":{"type":"string","description":"A second-level administrative division or county"},"suburb":{"type":"string","description":"Usually an unofficial neighborhood name, like \"Harlem\", \"South Bronx\", or \"Crown Heights\""},"to_date":{"type":"string","description":"end date of attribute"},"translated":{"type":"string","description":"The address value translated to English"},"transliterated":{"type":"string","description":"The address value transliterated to English"},"type":{"type":"string","description":"Indicates what the address is referring to. For example, it could be a physical address, mailing address, or other address type."},"unit":{"type":"string","description":"An apartment, unit, office, lot, or other secondary unit designator"},"value":{"type":"string"},"world_region":{"type":"string","description":"Currently only used for appending “West Indies” after the country name, a pattern frequently used in the English-speaking Caribbean (e.g., “Jamaica, West Indies”)"},"x":{"type":"number","format":"double","description":"The X coordinate (longitude) of the address"},"y":{"type":"number","format":"double","description":"The Y coordinate (latitude) of the address"}},"title":"AddressProperties"},"generatedTypes_AddressData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_AddressProperties"}},"required":["record","record_count","properties"],"title":"AddressData"},"generatedTypes_AddressInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_AddressData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A physical location description. Addresses may exist as a simple string (\"123 South Main St., South Bend, IN 46556\"), or may be in smaller chunks with separate fields (\"Number: 123\", \"Street name: South Main ...\"). Where possible, these fields will be parsed using the [Libpostal ontology](https://github.com/openvenues/libpostal#parser-labels), which facilitates more robust address analysis and comparison.","title":"AddressInfo"},"generatedTypes_BusinessPurposeStandard":{"type":"string","enum":["ADGM","ATECO","CAE","CAEM2005","CCNAE2021","CNAE2","ESA2010","GCED2011","HS","ISIC3","ISIC31","ISIC4","JSIC13","KSIC10","NACE1","NACE2","NACEBEL2003","NACEBEL2008","NAF1","NAF2","NAICS2017","NIC2008","PKD2007","SBI2008","SCIAN2018","SIC","SKD2002","SKD2008","SSIC2020","TOL2008","TSIC2552","can_gsin","can_object_code","eu_cpv","gbr_grant_programme_code","rus_okdp","rus_okpd2","rus_okved","usa_psc"],"description":"Business purpose standard enums describe the type of code listed in a business purpose attribute, which may or may not allow for [Pyisic](https://github.com/sayari-analytics/pyisic) conversions/lookups.","title":"BusinessPurposeStandard"},"generatedTypes_BusinessPurposeProperties":{"type":"object","properties":{"code":{"type":"string","description":"A code"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"standard":{"$ref":"#/components/schemas/generatedTypes_BusinessPurposeStandard","description":"The type of code (e.g., \"ISIC4\", \"NACE1\")"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"type":"string","description":"A text description"}},"title":"BusinessPurposeProperties"},"generatedTypes_BusinessPurposeData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_BusinessPurposeProperties"}},"required":["record","record_count","properties"],"title":"BusinessPurposeData"},"generatedTypes_BusinessPurposeInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_BusinessPurposeData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"Text and/or a code (NAICS, NACE, ISIC, etc.) that describes what a company is legally allowed to do or produce","title":"BusinessPurposeInfo"},"generatedTypes_CompanyTypeProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"type":"string"}},"title":"CompanyTypeProperties"},"generatedTypes_CompanyTypeData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_CompanyTypeProperties"}},"required":["record","record_count","properties"],"title":"CompanyTypeData"},"generatedTypes_CompanyTypeInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_CompanyTypeData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A type of legal entity in a given jurisdiction (e.g., \"LLC\", \"Sociedad Anonima\", \"Private Company Limited by Shares\")","title":"CompanyTypeInfo"},"generatedTypes_ContactType":{"type":"string","enum":["email","fax","phone_number","url"],"description":"Contact type enums describe different methods of contact reported in a record about a given entity.","title":"ContactType"},"generatedTypes_ContactProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"$ref":"#/components/schemas/generatedTypes_ContactType","description":"Email, fax, phone number, or URL"},"value":{"type":"string","description":"The contact detail itself (e.g., \"jdoe@sayari.com\", \"202-555-5555\")"}},"required":["value"],"title":"ContactProperties"},"generatedTypes_ContactData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_ContactProperties"}},"required":["record","record_count","properties"],"title":"ContactData"},"generatedTypes_ContactInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_ContactData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"Contact information for an entity","title":"ContactInfo"},"generatedTypes_CountryContext":{"type":"string","enum":["activity_in","address","awarding_country","citizenship","domicile","export_activity_in","import_activity_in","incorporation","mentioned_in","nationality","product_origin","residence","shipment_arrival","shipment_departure","shipment_transit","vessel_flag"],"description":"Country context enums describe different ways an entity can be connected to a country.","title":"CountryContext"},"generatedTypes_CountryProperties":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/generatedTypes_CountryContext","description":"The type of affiliation"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"state":{"type":"string","description":"The subnational state, province, region, etc."},"to_date":{"type":"string","description":"end date of attribute"},"value":{"$ref":"#/components/schemas/generatedTypes_Country","description":"The country, ideally normalized to an ISO trigram"}},"required":["value"],"title":"CountryProperties"},"generatedTypes_CountryData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_CountryProperties"}},"required":["record","record_count","properties"],"title":"CountryData"},"generatedTypes_CountryInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_CountryData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"An affiliation of an entity with a given country through residence, nationality, etc.","title":"CountryInfo"},"generatedTypes_DateOfBirthProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"type":"string","description":"The date of birth in YYYY-MM-DD, YYYY-MM, or YYYY format"}},"required":["value"],"title":"DateOfBirthProperties"},"generatedTypes_DateOfBirthData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_DateOfBirthProperties"}},"required":["record","record_count","properties"],"title":"DateOfBirthData"},"generatedTypes_DateOfBirthInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_DateOfBirthData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"Birth date of a person","title":"DateOfBirthInfo"},"generatedTypes_FinanceType":{"type":"string","enum":["authorized_capital","paid_up_capital","registered_capital","share_amount","share_percentage","subscribed_capital"],"description":"Finance type enums describe financial information about an entity. They're typically used to describe the cumulative monetary value of share capital issued by a company or held by an individual shareholder.","title":"FinanceType"},"generatedTypes_Currency":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BEF","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","ITL","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NLG","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UKH","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"description":"Currency enums are normalized representations of currencies. [Source](https://en.wikipedia.org/wiki/ISO_4217).","title":"Currency"},"generatedTypes_FinancesProperties":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/generatedTypes_FinanceType","description":"The type of figure"},"currency":{"$ref":"#/components/schemas/generatedTypes_Currency","description":"The currency, if applicable"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"type":"string","description":"A free-text definition of the type"},"value":{"type":"number","format":"double","description":"The numerical amount"}},"required":["value"],"title":"FinancesProperties"},"generatedTypes_FinancesData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_FinancesProperties"}},"required":["record","record_count","properties"],"title":"FinancesData"},"generatedTypes_FinancesInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_FinancesData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A financial figure, typically share capital","title":"FinancesInfo"},"generatedTypes_ReportingPeriodType":{"type":"string","enum":["annual_fiscal","last_twelve_months","quarterly_fiscal","semi_annual_fiscal","year_to_date_fiscal"],"description":"Reporting period type enums designate the type of statement period the values in a financials attribute are measured for.","title":"ReportingPeriodType"},"generatedTypes_FinancialsProperties":{"type":"object","properties":{"accounts_payable":{"type":"number","format":"double","description":"Trade payables for the purchase of materials and supplies to be used in the production of goods or in providing of services and are due in customary trade terms within one year or within the normal operating cycle of the company."},"asset_writeoff":{"type":"number","format":"double","description":"Write-off of any intangible or tangible fixed assets by the company and includes any value charged towards restructuring of operations."},"assets":{"type":"number","format":"double","description":"The total value of assets owned by a company"},"basic_eps":{"type":"number","format":"double","description":"Profitability metric that indicates how much profit a company generates for each outstanding share of common stock."},"cash_and_equivalent":{"type":"number","format":"double","description":"Total Cash and Equivalent"},"cash_financing":{"type":"number","format":"double","description":"Net cash used or generated in financing activities, during the stated period of time."},"cash_investing":{"type":"number","format":"double","description":"Net cash used or generated in investing activities, during the stated period of time."},"cash_operations":{"type":"number","format":"double","description":"Net cash used or generated in operating activities, during the stated period of time."},"change_accounts_payable":{"type":"number","format":"double","description":"Increase or decrease in accounts payable by the company during the stated period."},"change_accounts_receivable":{"type":"number","format":"double","description":"Increase or decrease in the accounts receivable of the company during the stated period."},"change_inventory":{"type":"number","format":"double","description":"Change in the inventory of the company reflected in the operating section of cash flow statement."},"common_stock":{"type":"number","format":"double","description":"Total Common Stock"},"currency":{"$ref":"#/components/schemas/generatedTypes_Currency","description":"Reporting currency"},"date":{"type":"string","description":"as-of date of attribute"},"employees":{"type":"integer","description":"Total employees"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"gross_profit":{"type":"number","format":"double","description":"Total Gross Profit"},"interest_expense":{"type":"number","format":"double","description":"Interest expense (net of capitalized interest) incurred by the company on the debt taken. Also includes debt procurement costs, and dividend paid by parent company on the preferred stock of its subsidiary or on trust preferred securities reported in the income statement."},"inventory":{"type":"number","format":"double","description":"Total Inventory"},"issued_common_stock":{"type":"number","format":"double","description":"The total cash inflow received from issuing new common shares during the reporting period."},"legal_settlements":{"type":"number","format":"double","description":"Costs incurred in legal disputes or receipts from legal settlements received by the company and reflected on the income statement."},"liabilities":{"type":"number","format":"double","description":"Sum of the combined debts a company owes"},"net_change_cash":{"type":"number","format":"double","description":"Net increase or decrease in cash and cash equivalents during the stated period of time. Sum of cash flows from operating activities, investing activities and financing activities plus foreign exchange rate adjustments and other miscellaneous cash flows."},"net_income":{"type":"number","format":"double","description":"Company's earnings for a period after subtracting operating costs, taxes, and interest"},"operating_income":{"type":"number","format":"double","description":"Reported Operating Income"},"paid_up_capital":{"type":"number","format":"double","description":"Paid-up capital is the capital already held by the company"},"rd_expenses":{"type":"number","format":"double","description":"Costs incurred by a company on the development of a new product, innovation relating to technology formulation, process development, or on the process undertaken in upgrading the existing product or service line."},"registered_capital":{"type":"number","format":"double","description":"Registered capital is the maximum amount of share capital that a company is authorized to raise"},"reporting_period_type":{"$ref":"#/components/schemas/generatedTypes_ReportingPeriodType","description":"Reporting period type"},"revenue":{"type":"number","format":"double","description":"The total amount of income generated by the sale of goods or services related to the company's primary operations"},"sale_ppe":{"type":"number","format":"double","description":"Cash flows obtained by the company through the sale of property, plant, and equipment."},"to_date":{"type":"string","description":"end date of attribute"},"total_capitalization":{"type":"number","format":"double","description":"The sum of total debt and all types of equity of a company."},"total_current_assets":{"type":"number","format":"double","description":"Assets which are expected to be converted into cash or used in the production of revenue within a period of twelve months."},"total_current_liabilities":{"type":"number","format":"double","description":"The total amount of a company’s short-term financial obligations that are due within one year, such as accounts payable, short-term loans, and wages payable"},"total_debt":{"type":"number","format":"double","description":"Total Debt"},"total_debt_issued":{"type":"number","format":"double","description":"Cash inflow from issuance of debt."},"total_dividends":{"type":"number","format":"double","description":"Cash outflows towards dividends or distributions, either to common or preferred stockholders during the relevant period. The value paid may relate to pending dividend of earlier period also."},"total_equity":{"type":"number","format":"double","description":"Equity as defined under the indicated accounting principles. Includes par value, paid in capital, retained earnings, and other adjustments to equity."},"total_liabilities":{"type":"number","format":"double","description":"All liabilities (current and long-term) as of the date indicated, as carried on the balance sheet."},"total_operating_expenses":{"type":"number","format":"double","description":"The costs a business incurs to maintain its day-to-day operations, excluding the cost of goods sold."},"total_receivables":{"type":"number","format":"double","description":"Summation of accounts receivable - trade, accounts receivable - other, and loans receivable current."},"unusual_items":{"type":"number","format":"double","description":"Sum of all income or expenses that are deemed infrequent and not typical of a company's ordinary operations."}},"title":"FinancialsProperties"},"generatedTypes_FinancialsData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_FinancialsProperties"}},"required":["record","record_count","properties"],"title":"FinancialsData"},"generatedTypes_FinancialsInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_FinancialsData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A summary of financial information at one point in time","title":"FinancialsInfo"},"generatedTypes_Gender":{"type":"string","enum":["female","male","other"],"description":"Gender enums are normalized ways to refer to different genders.","title":"Gender"},"generatedTypes_GenderProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"$ref":"#/components/schemas/generatedTypes_Gender","description":"May be described as \"female\", \"male\", or \"other\""}},"required":["value"],"title":"GenderProperties"},"generatedTypes_GenderData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_GenderProperties"}},"required":["record","record_count","properties"],"title":"GenderData"},"generatedTypes_GenderInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_GenderData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A person's gender","title":"GenderInfo"},"generatedTypes_GenericProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"type":"string","description":"A text description of the attribute (e.g., \"name of pet\")"},"value":{"type":"string","description":"The value of the attribute as text (e.g., \"Max\")"}},"title":"GenericProperties"},"generatedTypes_GenericData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_GenericProperties"}},"required":["record","record_count","properties"],"title":"GenericData"},"generatedTypes_GenericInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_GenericData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A placeholder attribute. Rarely used. A generic attribute typically does not fit any other attribute type.","title":"GenericInfo"},"generatedTypes_IdentifierProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"$ref":"#/components/schemas/generatedTypes_BothIdentifierTypes"},"value":{"type":"string","description":"The text/number value of the identifier"}},"required":["type","value"],"title":"IdentifierProperties"},"generatedTypes_IdentifierData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_IdentifierProperties"}},"required":["record","record_count","properties"],"title":"IdentifierData"},"generatedTypes_IdentifierInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_IdentifierData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"An ID number that uniquely identifies one entity when value and type are taken into account.","title":"IdentifierInfo"},"generatedTypes_MeasurementType":{"type":"string","enum":["built_area","gross_weight","land_area","net_weight","quantity"],"description":"Measurement type enums refer to the type of measurement applied to the entity, e.g., net weight.","title":"MeasurementType"},"generatedTypes_Unit":{"type":"string","enum":["gram","kilogram","long_ton","measurement_ton","metre","metres_squared","metric_ton","ounce","pound","short_ton","unit"],"description":"These enums describe the unit of measurement (i.e., using SI base units) for some dimension of an entity.","title":"Unit"},"generatedTypes_MeasurementProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"$ref":"#/components/schemas/generatedTypes_MeasurementType","description":"Type of the measurement"},"unit":{"$ref":"#/components/schemas/generatedTypes_Unit","description":"The unit of the measurement"},"value":{"type":"number","format":"double","description":"The value of the measurement"}},"required":["type","unit","value"],"title":"MeasurementProperties"},"generatedTypes_MeasurementData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_MeasurementProperties"}},"required":["record","record_count","properties"],"title":"MeasurementData"},"generatedTypes_MeasurementInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_MeasurementData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A numerical measurement of a dimension of an entity (e.g., weight) using a standard unit","title":"MeasurementInfo"},"generatedTypes_MonetaryValueContext":{"type":"string","enum":["assessed_value","cadastral_value","carriage_and_insurance_paid_to","carriage_paid_to","contract_value","cost_and_freight","cost_insurance_and_freight","delivered_at_place","delivered_at_place_unloaded","delivered_duty_paid","ex_works","free_alongside_ship","free_carrier","free_on_board","sale_value"],"description":"Monetary value context enums describe the types of financial values an asset can have.","title":"MonetaryValueContext"},"generatedTypes_MonetaryValueProperties":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/generatedTypes_MonetaryValueContext","description":"The type of value"},"currency":{"$ref":"#/components/schemas/generatedTypes_Currency","description":"The ISO 4217 currency code"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"type":"number","format":"double","description":"The financial value of the asset"}},"required":["context","value"],"title":"MonetaryValueProperties"},"generatedTypes_MonetaryValueData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_MonetaryValueProperties"}},"required":["record","record_count","properties"],"title":"MonetaryValueData"},"generatedTypes_MonetaryValueInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_MonetaryValueData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"The financial value of an asset (e.g., FOB, CIF)","title":"MonetaryValueInfo"},"generatedTypes_NameProperties":{"type":"object","properties":{"context":{"type":"string"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"language":{"$ref":"#/components/schemas/generatedTypes_Language","description":"The language that the name is in"},"to_date":{"type":"string","description":"end date of attribute"},"translated":{"type":"string","description":"The name value translated to English"},"transliterated":{"type":"string","description":"The name value transliterated to English"},"value":{"type":"string","description":"The name, as text"}},"required":["value"],"title":"NameProperties"},"generatedTypes_NameData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_NameProperties"}},"required":["record","record_count","properties"],"title":"NameData"},"generatedTypes_NameInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_NameData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"An entity's name. The value may be straightforward (e.g., \"Acme LLC\", \"John Doe\") or context specific (e.g., \"Jones v. Smith\" as a legal matter name).","title":"NameInfo"},"generatedTypes_PersonStatus":{"type":"string","enum":["born","died","married"],"description":"Person status enums describe different life events.","title":"PersonStatus"},"generatedTypes_PersonStatusProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"$ref":"#/components/schemas/generatedTypes_PersonStatus","description":"The event"}},"required":["value"],"title":"PersonStatusProperties"},"generatedTypes_PersonStatusData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_PersonStatusProperties"}},"required":["record","record_count","properties"],"title":"PersonStatusData"},"generatedTypes_PersonStatusInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_PersonStatusData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A key event occurring in a person's life, usually temporal","title":"PersonStatusInfo"},"generatedTypes_PositionProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"type":"string","description":"The position as text"}},"required":["value"],"title":"PositionProperties"},"generatedTypes_PositionData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_PositionProperties"}},"required":["record","record_count","properties"],"title":"PositionData"},"generatedTypes_PositionInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_PositionData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"An attribute used for many different relationship types that allows for the inclusion of a title or designation (e.g., member_of_the_board_of, Position: \"Secretary of the Board\" or shareholder_of, Position: \"Minority shareholder\")","title":"PositionInfo"},"generatedTypes_RiskEventCategory":{"type":"string","enum":["bribery_and_corruption","cybercrime","esg_environmental","esg_governance","esg_social","financial_crime_and_fraud","financial_regulator","law_enforcement","modern_slavery","organized_crime","other_alleged_offenses","regulatory_enforcement_lists","reputational_risk_exposure","terrorism"],"description":"Describes the high-level classification of a risk event, covering ESG controversies, regulatory actions, legal enforcement, and reputational risk associated with an entity.","title":"RiskEventCategory"},"generatedTypes_EsgEventIntensity":{"type":"string","enum":["high","low","medium"],"description":"Used to assess the severity or impact of a specific Environmental, Social, and Governance (ESG) event on a company, normalizing vendor-specific scoring systems (like SESAMm's 1-5 scale) into a standard scale.","title":"EsgEventIntensity"},"generatedTypes_RiskEventProperties":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/generatedTypes_RiskEventCategory","description":"The high-level classification of the risk event (e.g., Organized Crime, Law Enforcement, ESG - Governance)"},"credibility":{"type":"string","description":"An indicator of the reliability of the source reporting on a specific event. It can take the values 'Low', 'Medium', or 'High'. The higher the value, the more credible the source substantiating the event is considered to be."},"currency":{"$ref":"#/components/schemas/generatedTypes_Currency","description":"The ISO 4217 currency code"},"date":{"type":"string","description":"as-of date of attribute"},"dismissal_and_clearance":{"type":"string","description":"Captures positive resolutions such as acquittals, dropped charges, overturned sentences, and removal from enforcement lists"},"esg_event_intensity":{"$ref":"#/components/schemas/generatedTypes_EsgEventIntensity","description":"A categorization of the impact of a specific Environmental, Social, and Governance (ESG) event on a company ranging from Low (minimal impact) to High (maximum impact)."},"event_stage":{"type":"string","description":"Captures active movement in a legal, criminal, or regulatory investigation lifecycle (e.g., Investigation, Arrest, Released)"},"event_type":{"type":"string","description":"Catch-all for general list tags, notices, and unstructured risk exposure where a specific procedural stage or penalty is not defined (e.g., Reputational Risk Exposure Event Type, Notice of Hearing)"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"monetary_value":{"type":"number","format":"double","description":"The numerical financial amount associated with the event, such as a regulatory fine or penalty"},"penalty_and_restriction":{"type":"string","description":"Captures tangible punitive actions, financial sanctions, operational restrictions, and guilty sentences (e.g., Fine, Debarment, Conviction)"},"source_url":{"type":"string","description":"The URL linking to the original document, article, press release, or evidence substantiating the risk event"},"subcategory":{"type":"string","description":"The specific sub-classification, issue, or issuing agency associated with the event (e.g., Traffic and Distribution of Narcotics, Police - West Midlands Police - News - United Kingdom, Workplace Diversity & Inclusion)"},"summary":{"type":"string","description":"A descriptive narrative summarizing the details of the risk event"},"title":{"type":"string","description":"The headline or title of the supporting evidence for the risk event"},"to_date":{"type":"string","description":"end date of attribute"}},"required":["category"],"title":"RiskEventProperties"},"generatedTypes_RiskEventData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_RiskEventProperties"}},"required":["record","record_count","properties"],"title":"RiskEventData"},"generatedTypes_RiskEventInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskEventData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"An attribute used to capture risk (e.g., ESG controversies, reputational risk,regulatory, legal, and enforcement) events associated with an entity. This attribute is designed to handle structured event timelines, adverse media, and enforcement records from various sources.","title":"RiskEventInfo"},"generatedTypes_Tag":{"type":"string","enum":["aspi_uyghur_forced_labor_report_entity","bis_boycott_requester_list","esg_score","esg_score_high","esg_score_low","esg_score_medium","esg_score_very_high","export_controls","export_controls_bis_entity","financial_risk_score","forced_labor_xinjiang_contractors","forced_labor_xinjiang_uflpa","former_soe","formerly_sanctioned","law_enforcement_action","pep","regulatory_action","reputational_risk_bribery_and_corruption","reputational_risk_cybercrime","reputational_risk_financial_crime","reputational_risk_forced_labor","reputational_risk_modern_slavery","reputational_risk_organized_crime","reputational_risk_other","reputational_risk_terrorism","sanctioned","sheffield_hallam_university_forced_labor_entity","state_owned","uflpa_entity","usa_bis","wro_entity"],"description":"Risk tags describe risk associated with an entity.","title":"Tag"},"generatedTypes_RiskIntelligenceProperties":{"type":"object","properties":{"authority":{"type":"string","description":"Government authority issuing the enforcement or risk intelligence action"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"list":{"type":"string","description":"Official list where the entity's risk information or enforcement action is recorded"},"program":{"type":"string","description":"Specific to sanctions risk. Sanctions program under which the entity is designated."},"reason":{"type":"string","description":"Explanation or legal basis for the risk intelligence"},"score":{"type":"number","format":"double","description":"A value indicating the assessed level of a certain risk tied to an entity. Meaning and scale depend on the specific scoring model used."},"to_date":{"type":"string","description":"end date of attribute"},"type":{"$ref":"#/components/schemas/generatedTypes_Tag","description":"Type of risk intelligence"}},"required":["type"],"title":"RiskIntelligenceProperties"},"generatedTypes_RiskIntelligenceData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_RiskIntelligenceProperties"}},"required":["record","record_count","properties"],"title":"RiskIntelligenceData"},"generatedTypes_RiskIntelligenceInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskIntelligenceData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"An attribute for risk intelligence metadata","title":"RiskIntelligenceInfo"},"generatedTypes_SharesProperties":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/generatedTypes_Currency","description":"The currency of the monetary_value"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"monetary_value":{"type":"number","format":"double","description":"The total monetary value of the shares"},"num_shares":{"type":"number","format":"double","description":"The number of shares held, issued, etc."},"percentage":{"type":"number","format":"double","description":"The percentage of shares owned"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"type":"string","description":"A string describing the type of shares (e.g., \"Class B\", \"Protected cell shares\")"}},"title":"SharesProperties"},"generatedTypes_SharesData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_SharesProperties"}},"required":["record","record_count","properties"],"title":"SharesData"},"generatedTypes_SharesInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_SharesData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"Shares associated with an entity (e.g., number of shares issued by a company or number of shares held by a shareholder)","title":"SharesInfo"},"generatedTypes_StatusContext":{"type":"string","enum":["broker_license","general_partnership_status","investment_advisor_license","limited_liability_partnership_status","sole_proprietorship_status"],"description":"Status context enums describe the different types of statuses that can be represented in a status attribute.","title":"StatusContext"},"generatedTypes_CompanyStatus":{"type":"string","enum":["active","closed","closing","dissolved","expanded","expired","in_receivership","inactive","incorporated","opening","registered","registration_revoked","seized","terminated","under_external_control"],"description":"Company status enums describe a normalized set of statuses to which we map specific terms describing a company's status in a source document.","title":"CompanyStatus"},"generatedTypes_StatusProperties":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/generatedTypes_StatusContext","description":"The type of status, such as license or partnership type"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"text":{"type":"string","description":"The raw status text"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"$ref":"#/components/schemas/generatedTypes_CompanyStatus","description":"The status, normalized to one of the status enums"}},"title":"StatusProperties"},"generatedTypes_StatusData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_StatusProperties"}},"required":["record","record_count","properties"],"title":"StatusData"},"generatedTypes_StatusInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_StatusData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"The status of an entity. This attribute is used to indicate details such as registration, operating, or liquidation status as well as an entity's license or sole proprietorship status.","title":"StatusInfo"},"generatedTypes_TranslationContext":{"type":"string","enum":["google_translate","pinyin","sayari_machine_translation"],"description":"Translation context enums describe different types of translations.","title":"TranslationContext"},"generatedTypes_TranslatedNameProperties":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/generatedTypes_TranslationContext","description":"The type of translation"},"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"original":{"type":"string","description":"The original name"},"to_date":{"type":"string","description":"end date of attribute"},"value":{"type":"string","description":"The name, as text"}},"required":["value"],"title":"TranslatedNameProperties"},"generatedTypes_TranslatedNameData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_TranslatedNameProperties"}},"required":["record","record_count","properties"],"title":"TranslatedNameData"},"generatedTypes_TranslatedNameInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_TranslatedNameData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A name that has been translated to English","title":"TranslatedNameInfo"},"generatedTypes_WeakIdentifierProperties":{"type":"object","properties":{"date":{"type":"string","description":"as-of date of attribute"},"extra":{"type":"object","additionalProperties":{"description":"Any type"},"description":"extra information of attribute"},"from_date":{"type":"string","description":"start date of attribute"},"to_date":{"type":"string","description":"end date of attribute"},"type":{"$ref":"#/components/schemas/generatedTypes_WeakIdentifierType","description":"The type of the identifier, including the country/jurisdiction that issued it"},"value":{"type":"string","description":"The text value of the identifier"}},"required":["type","value"],"title":"WeakIdentifierProperties"},"generatedTypes_WeakIdentifierData":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"array","items":{"type":"string"}},"record_count":{"type":"integer"},"properties":{"$ref":"#/components/schemas/generatedTypes_WeakIdentifierProperties"}},"required":["record","record_count","properties"],"title":"WeakIdentifierData"},"generatedTypes_WeakIdentifierInfo":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"data":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_WeakIdentifierData"}},"next":{"description":"Any type"},"offset":{"type":"integer"}},"required":["limit","size","data"],"description":"A non-unique ID number, like a partially redacted tax ID or a registry identifier, whose value and type may be shared by multiple entities","title":"WeakIdentifierInfo"},"generatedTypes_AttributeDetails":{"type":"object","properties":{"additional_information":{"$ref":"#/components/schemas/generatedTypes_AdditionalInformationInfo"},"address":{"$ref":"#/components/schemas/generatedTypes_AddressInfo"},"business_purpose":{"$ref":"#/components/schemas/generatedTypes_BusinessPurposeInfo"},"company_type":{"$ref":"#/components/schemas/generatedTypes_CompanyTypeInfo"},"contact":{"$ref":"#/components/schemas/generatedTypes_ContactInfo"},"country":{"$ref":"#/components/schemas/generatedTypes_CountryInfo"},"date_of_birth":{"$ref":"#/components/schemas/generatedTypes_DateOfBirthInfo"},"finances":{"$ref":"#/components/schemas/generatedTypes_FinancesInfo"},"financials":{"$ref":"#/components/schemas/generatedTypes_FinancialsInfo"},"gender":{"$ref":"#/components/schemas/generatedTypes_GenderInfo"},"generic":{"$ref":"#/components/schemas/generatedTypes_GenericInfo"},"identifier":{"$ref":"#/components/schemas/generatedTypes_IdentifierInfo"},"measurement":{"$ref":"#/components/schemas/generatedTypes_MeasurementInfo"},"monetary_value":{"$ref":"#/components/schemas/generatedTypes_MonetaryValueInfo"},"name":{"$ref":"#/components/schemas/generatedTypes_NameInfo"},"person_status":{"$ref":"#/components/schemas/generatedTypes_PersonStatusInfo"},"position":{"$ref":"#/components/schemas/generatedTypes_PositionInfo"},"risk_event":{"$ref":"#/components/schemas/generatedTypes_RiskEventInfo"},"risk_intelligence":{"$ref":"#/components/schemas/generatedTypes_RiskIntelligenceInfo"},"shares":{"$ref":"#/components/schemas/generatedTypes_SharesInfo"},"status":{"$ref":"#/components/schemas/generatedTypes_StatusInfo"},"translated_name":{"$ref":"#/components/schemas/generatedTypes_TranslatedNameInfo"},"weak_identifier":{"$ref":"#/components/schemas/generatedTypes_WeakIdentifierInfo"}},"title":"AttributeDetails"},"sharedTypes_PSAEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"label":{"type":"string","description":"Display name of the entity"},"degree":{"type":"integer","description":"Number of outgoing relationships"},"closed":{"type":"boolean","description":"True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation."},"entity_url":{"type":"string","description":"Convenience URL to the entity in the API."},"pep":{"type":"boolean","description":"True if the entity has the [\"Politically Exposed Person (PEP)\" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false."},"psa_id":{"type":"string"},"psa_count":{"type":"integer","description":"Number of entities that are Possibly the Same As (PSA) the entity."},"sanctioned":{"type":"boolean","description":"True if the entity has the [\"Sanctioned\" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false."},"type":{"$ref":"#/components/schemas/generatedTypes_Entities","description":"The [entity type](/sayari-library/ontology/entities)."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity [country](/sayari-library/ontology/enumerated-types#country)"},"source_count":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_SourceCountInfo"},"description":"Number of records associated with the entity, grouped by source."},"addresses":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)"},"trade_count":{"type":"object","additionalProperties":{"type":"integer"}},"date_of_birth":{"type":"string","description":"Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)"},"relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"user_relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"related_entities_count":{"type":"integer"},"user_related_entities_count":{"type":"integer"},"user_record_count":{"type":"integer"},"reference_id":{"type":"string"},"logistics_entity":{"type":"boolean"},"risk":{"$ref":"#/components/schemas/sharedTypes_EntityRisk"},"registration_date":{"$ref":"#/components/schemas/sharedTypes_EntityRegistrationDate"},"company_type":{"$ref":"#/components/schemas/sharedTypes_CompanyType"},"latest_status":{"$ref":"#/components/schemas/sharedTypes_Status"}},"required":["id","label","degree","closed","entity_url","pep","psa_count","sanctioned","type","identifiers","countries","source_count","addresses","trade_count","relationship_count","user_relationship_count","attribute_count","user_attribute_count","related_entities_count","user_related_entities_count","user_record_count","risk"],"description":"The entity that is possibly the same as the target entity.","title":"PSAEntity"},"sharedTypes_PossiblySameAsMatch":{"type":"object","properties":{"source":{"type":"string"},"target":{"type":"string"}},"required":["source","target"],"title":"PossiblySameAsMatch"},"sharedTypes_PossiblySameAsData":{"type":"object","properties":{"editable":{"type":"boolean"},"entity":{"$ref":"#/components/schemas/sharedTypes_PSAEntity"},"matches":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAsMatch"}}}},"required":["entity","matches"],"title":"PossiblySameAsData"},"sharedTypes_PossiblySameAs":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"description":"Any type"},"data":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAsData"}}},"required":["limit","size","data"],"description":"<Warning>This property is deprecated.</Warning> List of entities that are Possibly the Same As (PSA) the entity.","title":"PossiblySameAs"},"sharedTypes_RecordDetails":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a record in the database"},"label":{"type":"string"},"source":{"type":"string","description":"The unique identifier for a source in the database"},"publication_date":{"type":"string","description":"The date the record was published"},"acquisition_date":{"type":"string","description":"The date Sayari acquired this record"},"references_count":{"type":"integer","description":"Number of times this record is referenced"},"record_url":{"type":"string","description":"The url to download the record from Sayari"},"source_url":{"type":"string","description":"The url to access to original source"},"document_urls":{"type":"array","items":{"type":"string"}},"matches":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"country":{"$ref":"#/components/schemas/generatedTypes_Country"},"page":{"type":"number","format":"double"},"page_count":{"type":"number","format":"double"}},"required":["id","label","source","acquisition_date","references_count","record_url"],"title":"RecordDetails"},"sharedTypes_ReferencedByDataType":{"type":"string","enum":["about","mentions"],"title":"ReferencedByDataType"},"sharedTypes_ReferencedByData":{"type":"object","properties":{"record":{"$ref":"#/components/schemas/sharedTypes_RecordDetails"},"type":{"$ref":"#/components/schemas/sharedTypes_ReferencedByDataType"}},"required":["record","type"],"title":"ReferencedByData"},"sharedTypes_ReferencedBy":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"description":"Any type"},"data":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_ReferencedByData"}}},"required":["limit","size","data"],"description":"List of records that reference the entity.","title":"ReferencedBy"},"sharedTypes_EntityDetails":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"label":{"type":"string","description":"Display name of the entity"},"degree":{"type":"integer","description":"Number of outgoing relationships"},"closed":{"type":"boolean","description":"True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation."},"entity_url":{"type":"string","description":"Convenience URL to the entity in the API."},"pep":{"type":"boolean","description":"True if the entity has the [\"Politically Exposed Person (PEP)\" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false."},"psa_id":{"type":"string"},"psa_count":{"type":"integer","description":"Number of entities that are Possibly the Same As (PSA) the entity."},"sanctioned":{"type":"boolean","description":"True if the entity has the [\"Sanctioned\" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false."},"type":{"$ref":"#/components/schemas/generatedTypes_Entities","description":"The [entity type](/sayari-library/ontology/entities)."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity [country](/sayari-library/ontology/enumerated-types#country)"},"source_count":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_SourceCountInfo"},"description":"Number of records associated with the entity, grouped by source."},"addresses":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)"},"trade_count":{"type":"object","additionalProperties":{"type":"integer"}},"date_of_birth":{"type":"string","description":"Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)"},"relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"user_relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"related_entities_count":{"type":"integer"},"user_related_entities_count":{"type":"integer"},"user_record_count":{"type":"integer"},"reference_id":{"type":"string"},"logistics_entity":{"type":"boolean"},"registration_date":{"$ref":"#/components/schemas/sharedTypes_EntityRegistrationDate"},"translated_label":{"$ref":"#/components/schemas/sharedTypes_EntityTranslatedLabel"},"hs_code":{"$ref":"#/components/schemas/sharedTypes_EntityHSCode"},"shipment_arrival":{"$ref":"#/components/schemas/sharedTypes_ShipmentArrival"},"shipment_departure":{"$ref":"#/components/schemas/sharedTypes_ShipmentDeparture"},"company_type":{"$ref":"#/components/schemas/sharedTypes_CompanyType"},"latest_status":{"$ref":"#/components/schemas/sharedTypes_Status"},"risk":{"$ref":"#/components/schemas/sharedTypes_EntityRisk","description":"[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity."},"attributes":{"$ref":"#/components/schemas/generatedTypes_AttributeDetails","description":"Detailed information about the entity's [attributes](/sayari-library/ontology/attributes)."},"relationships":{"$ref":"#/components/schemas/sharedTypes_EntityRelationships","description":"Detailed information about the entity's [relationships](/sayari-library/ontology/relationships)."},"possibly_same_as":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAs"},"referenced_by":{"$ref":"#/components/schemas/sharedTypes_ReferencedBy"}},"required":["id","label","degree","closed","entity_url","pep","psa_count","sanctioned","type","identifiers","countries","source_count","addresses","trade_count","relationship_count","user_relationship_count","attribute_count","user_attribute_count","related_entities_count","user_related_entities_count","user_record_count","risk"],"description":"Additional fields providing more details about an entity","title":"EntityDetails"},"sharedTypes_RelationshipInfo":{"type":"object","properties":{"editable":{"type":"boolean"},"record":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"description":"Any type"}}},"date":{"type":"string"},"from_date":{"type":"string"},"to_date":{"type":"string"},"acquisition_date":{"type":"string"},"former":{"type":"boolean"},"publication_date":{"type":"string"}},"required":["record","attributes","acquisition_date"],"title":"RelationshipInfo"},"sharedTypes_RelationshipData":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/sharedTypes_EntityDetails"},"types":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RelationshipInfo"}},"description":"Additional information for each [relationship type](/sayari-library/ontology/relationships)."},"dates":{"type":"array","items":{"type":"string"}},"first_observed":{"type":"string"},"former":{"type":"boolean"},"last_observed":{"type":"string"},"start_date":{"type":"string"},"end_date":{"type":"string"}},"required":["target","types","dates"],"title":"RelationshipData"},"sharedTypes_EntityRelationships":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"next":{"description":"Any type"},"data":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RelationshipData"}}},"required":["limit","size","data"],"description":"All relationships the entity is a part of.","title":"EntityRelationships"},"entity_GetEntityResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"label":{"type":"string","description":"Display name of the entity"},"degree":{"type":"integer","description":"Number of outgoing relationships"},"closed":{"type":"boolean","description":"True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation."},"entity_url":{"type":"string","description":"Convenience URL to the entity in the API."},"pep":{"type":"boolean","description":"True if the entity has the [\"Politically Exposed Person (PEP)\" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false."},"psa_id":{"type":"string"},"psa_count":{"type":"integer","description":"Number of entities that are Possibly the Same As (PSA) the entity."},"sanctioned":{"type":"boolean","description":"True if the entity has the [\"Sanctioned\" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false."},"type":{"$ref":"#/components/schemas/generatedTypes_Entities","description":"The [entity type](/sayari-library/ontology/entities)."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity [country](/sayari-library/ontology/enumerated-types#country)"},"source_count":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_SourceCountInfo"},"description":"Number of records associated with the entity, grouped by source."},"addresses":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)"},"trade_count":{"type":"object","additionalProperties":{"type":"integer"}},"date_of_birth":{"type":"string","description":"Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)"},"relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"user_relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"related_entities_count":{"type":"integer"},"user_related_entities_count":{"type":"integer"},"user_record_count":{"type":"integer"},"reference_id":{"type":"string"},"logistics_entity":{"type":"boolean"},"registration_date":{"$ref":"#/components/schemas/sharedTypes_EntityRegistrationDate"},"translated_label":{"$ref":"#/components/schemas/sharedTypes_EntityTranslatedLabel"},"hs_code":{"$ref":"#/components/schemas/sharedTypes_EntityHSCode"},"shipment_arrival":{"$ref":"#/components/schemas/sharedTypes_ShipmentArrival"},"shipment_departure":{"$ref":"#/components/schemas/sharedTypes_ShipmentDeparture"},"company_type":{"$ref":"#/components/schemas/sharedTypes_CompanyType"},"latest_status":{"$ref":"#/components/schemas/sharedTypes_Status"},"risk":{"$ref":"#/components/schemas/sharedTypes_EntityRisk","description":"[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity."},"attributes":{"$ref":"#/components/schemas/generatedTypes_AttributeDetails","description":"Detailed information about the entity's [attributes](/sayari-library/ontology/attributes)."},"relationships":{"$ref":"#/components/schemas/sharedTypes_EntityRelationships","description":"Detailed information about the entity's [relationships](/sayari-library/ontology/relationships)."},"possibly_same_as":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAs"},"referenced_by":{"$ref":"#/components/schemas/sharedTypes_ReferencedBy"}},"required":["id","label","degree","closed","entity_url","pep","psa_count","sanctioned","type","identifiers","countries","source_count","addresses","trade_count","relationship_count","user_relationship_count","attribute_count","user_attribute_count","related_entities_count","user_related_entities_count","user_record_count","risk"],"description":"OK","title":"GetEntityResponse"},"entity_EntitySummaryResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"label":{"type":"string","description":"Display name of the entity"},"degree":{"type":"integer","description":"Number of outgoing relationships"},"closed":{"type":"boolean","description":"True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation."},"entity_url":{"type":"string","description":"Convenience URL to the entity in the API."},"pep":{"type":"boolean","description":"True if the entity has the [\"Politically Exposed Person (PEP)\" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false."},"psa_id":{"type":"string"},"psa_count":{"type":"integer","description":"Number of entities that are Possibly the Same As (PSA) the entity."},"sanctioned":{"type":"boolean","description":"True if the entity has the [\"Sanctioned\" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false."},"type":{"$ref":"#/components/schemas/generatedTypes_Entities","description":"The [entity type](/sayari-library/ontology/entities)."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity [country](/sayari-library/ontology/enumerated-types#country)"},"source_count":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_SourceCountInfo"},"description":"Number of records associated with the entity, grouped by source."},"addresses":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)"},"trade_count":{"type":"object","additionalProperties":{"type":"integer"}},"date_of_birth":{"type":"string","description":"Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)"},"relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"user_relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"related_entities_count":{"type":"integer"},"user_related_entities_count":{"type":"integer"},"user_record_count":{"type":"integer"},"reference_id":{"type":"string"},"logistics_entity":{"type":"boolean"},"registration_date":{"$ref":"#/components/schemas/sharedTypes_EntityRegistrationDate"},"translated_label":{"$ref":"#/components/schemas/sharedTypes_EntityTranslatedLabel"},"hs_code":{"$ref":"#/components/schemas/sharedTypes_EntityHSCode"},"shipment_arrival":{"$ref":"#/components/schemas/sharedTypes_ShipmentArrival"},"shipment_departure":{"$ref":"#/components/schemas/sharedTypes_ShipmentDeparture"},"company_type":{"$ref":"#/components/schemas/sharedTypes_CompanyType"},"latest_status":{"$ref":"#/components/schemas/sharedTypes_Status"},"risk":{"$ref":"#/components/schemas/sharedTypes_EntityRisk","description":"[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity."},"attributes":{"$ref":"#/components/schemas/generatedTypes_AttributeDetails","description":"Detailed information about the entity's [attributes](/sayari-library/ontology/attributes)."},"relationships":{"$ref":"#/components/schemas/sharedTypes_EntityRelationships","description":"Detailed information about the entity's [relationships](/sayari-library/ontology/relationships)."},"possibly_same_as":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAs"},"referenced_by":{"$ref":"#/components/schemas/sharedTypes_ReferencedBy"}},"required":["id","label","degree","closed","entity_url","pep","psa_count","sanctioned","type","identifiers","countries","source_count","addresses","trade_count","relationship_count","user_relationship_count","attribute_count","user_attribute_count","related_entities_count","user_related_entities_count","user_record_count","risk"],"description":"OK","title":"EntitySummaryResponse"},"info_UsageInfo":{"type":"object","properties":{"entity":{"type":"integer"},"record":{"type":"integer"},"resolve":{"type":"integer"},"search":{"type":"integer"},"trade_traversal":{"type":"integer"},"traversal":{"type":"integer"}},"title":"UsageInfo"},"info_UsageResponse":{"type":"object","properties":{"usage":{"$ref":"#/components/schemas/info_UsageInfo","description":"Usage information for each endpoint"},"from":{"type":"string","description":"The start date of the returned usage information."},"to":{"type":"string","description":"The end date of the returned usage information."}},"required":["usage","from","to"],"title":"UsageResponse"},"info_EventInfo":{"type":"object","additionalProperties":{"description":"Any type"},"description":"A map of fields appearing in the audit logs for this event","title":"EventInfo"},"info_HistoryInfo":{"type":"object","properties":{"user":{"type":"string"},"environment":{"type":"string"},"event":{"type":"string"},"data":{"$ref":"#/components/schemas/info_EventInfo"},"timestamp":{"type":"string"}},"required":["user","environment","event","data","timestamp"],"title":"HistoryInfo"},"info_HistoryResponse":{"type":"object","properties":{"size":{"type":"integer"},"next_token":{"type":"string"},"events":{"type":"array","items":{"$ref":"#/components/schemas/info_HistoryInfo"}}},"required":["size","next_token","events"],"title":"HistoryResponse"},"negativeNews_Topics":{"type":"string","enum":["overview","environmental_and_social","cybersecurity","disruption","criminal","reputational","financial","sanctions_and_regulatory","legal","political","terrorism"],"title":"Topics"},"negativeNews_Article":{"type":"object","properties":{"published":{"type":"string","description":"Article publication date"},"risk_flags":{"type":"array","items":{"type":"string"},"description":"Array of risk flags"},"search_term":{"description":"Contains the search query and associated terms used to find the article"},"snippet":{"type":"string","description":"Brief excerpt or summary of the article content"},"source":{"type":"string","description":"Name of the publishing organization or media outlet"},"title":{"type":"string","description":"Article headline or title from the source publication"},"url":{"type":"string","description":"Direct URL link to the original article"}},"required":["published","risk_flags","search_term","snippet","source","title","url"],"description":"Array of analyzed news articles and risk assessments. Each article includes source metadata and identified risk categories based on content analysis.","title":"Article"},"negativeNews_NegativeNewsResponse":{"type":"array","items":{"$ref":"#/components/schemas/negativeNews_Article"},"title":"NegativeNewsResponse"},"notifications_NotificationsSortField":{"type":"string","enum":["-date"],"description":"Defines a sort order on a field. The value should begin with a '-' to indicate a descending sort, followed by a field name to sort on.","title":"NotificationsSortField"},"notifications_NotificationType":{"type":"string","enum":["risk"],"title":"NotificationType"},"notifications_NotificationAdditionalInformation":{"type":"object","properties":{"value":{"type":"object","additionalProperties":{"description":"Any type"}},"properties":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_AdditionalInformationProperties"}}},"required":["properties"],"title":"NotificationAdditionalInformation"},"notifications_Notification":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/notifications_NotificationType","description":"The type of notification, currently limited to 'risk'"},"field":{"$ref":"#/components/schemas/generatedTypes_Risk","description":"The field that the notification is for"},"values":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RiskValue"},"description":"The previous values of the field"},"date":{"type":"string","description":"The date the notification was created"},"additional_information":{"$ref":"#/components/schemas/notifications_NotificationAdditionalInformation"}},"required":["type","field","values","date"],"title":"Notification"},"notifications_ProjectNotificationRiskData":{"type":"object","properties":{"added":{"type":"array","items":{"type":"string"},"description":"The list of fields added"},"removed":{"type":"array","items":{"type":"string"},"description":"The list of fields removed"},"date":{"type":"string","description":"The date of the notification"}},"required":["added","removed","date"],"title":"ProjectNotificationRiskData"},"notifications_ProjectNotificationData":{"type":"object","properties":{"resource_id":{"type":"string","description":"The ID of the saved resource"},"entity_id":{"type":"string","description":"The ID of the entity"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/notifications_Notification"}},"custom_fields":{"type":"object","additionalProperties":{"description":"Any type"},"description":"<Warning>This property is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> custom user key/value pairs (key must be prefixed with \"custom_\" and value must be \"string\" type)"},"risk_notifications":{"$ref":"#/components/schemas/notifications_ProjectNotificationRiskData","description":"Aggregated risk notifications"}},"required":["resource_id","entity_id","notifications","risk_notifications"],"title":"ProjectNotificationData"},"notifications_ProjectNotificationsResponse":{"type":"object","properties":{"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/notifications_ProjectNotificationData"}},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"}},"required":["next","data","size"],"description":"OK","title":"ProjectNotificationsResponse"},"notifications_ResourceNotificationData":{"type":"object","properties":{"saved_resource_id":{"type":"string","description":"The ID of the saved resource"},"project_id":{"type":"string","description":"The ID of the project the entity is saved to"},"entity_id":{"type":"string","description":"The ID of the entity"},"type":{"$ref":"#/components/schemas/notifications_NotificationType","description":"The type of notification, currently limited to 'risk'"},"field":{"$ref":"#/components/schemas/generatedTypes_Risk","description":"The field that the notification is for"},"value":{"$ref":"#/components/schemas/sharedTypes_RiskValue","description":"The previous value of the field"},"date":{"type":"string","description":"The date the notification was created"}},"required":["saved_resource_id","project_id","entity_id","type","field","value","date"],"title":"ResourceNotificationData"},"notifications_ResourceNotificationsResponse":{"type":"object","properties":{"offset":{"type":"integer"},"limit":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/notifications_ResourceNotificationData"}}},"required":["offset","limit","next","data"],"description":"OK","title":"ResourceNotificationsResponse"},"generatedTypes_Attributes":{"type":"string","enum":["additional_information","address","business_purpose","company_type","contact","country","date_of_birth","finances","financials","gender","generic","identifier","measurement","monetary_value","name","person_status","position","risk_event","risk_intelligence","shares","status","translated_name","weak_identifier"],"title":"Attributes"},"ontology_OntologyAttributeField":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"comment":{"type":"string"},"type":{"type":"array","items":{"type":"string"}}},"required":["id","label","comment","type"],"title":"OntologyAttributeField"},"ontology_OntologyAttribute":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_Attributes"},"label":{"type":"string"},"comment":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyAttributeField"}}},"required":["id","label","comment","fields"],"title":"OntologyAttribute"},"ontology_OntologyCountry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_Country"},"label":{"type":"string"},"code":{"type":"integer"}},"required":["id","label","code"],"title":"OntologyCountry"},"ontology_OntologyCurrency":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_Currency"},"label":{"type":"string"}},"required":["id","label"],"title":"OntologyCurrency"},"ontology_OntologyEntityTypeField":{"oneOf":[{"$ref":"#/components/schemas/generatedTypes_Attributes"},{"$ref":"#/components/schemas/generatedTypes_Relationships"}],"title":"OntologyEntityTypeField"},"ontology_OntologyEntityType":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_Entities"},"label":{"type":"string"},"comment":{"type":"string"},"attribute":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Attributes"}},"relationship":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},"field":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyEntityTypeField"}}},"required":["id","label","comment","attribute","relationship","field"],"title":"OntologyEntityType"},"ontology_OntologyEnumSymbol":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"comment":{"type":"string"}},"required":["id","label","comment"],"title":"OntologyEnumSymbol"},"ontology_OntologyEnum":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"comment":{"type":"string"},"symbols":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyEnumSymbol"}}},"required":["id","label","comment","symbols"],"title":"OntologyEnum"},"ontology_OntologyIdentifier":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_IdentifierType"},"label":{"type":"string"},"comment":{"type":"string"},"regex":{"type":"string"}},"required":["id","label","comment","regex"],"title":"OntologyIdentifier"},"ontology_OntologyLanguage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_Language"},"label":{"type":"string"}},"required":["id","label"],"title":"OntologyLanguage"},"ontology_OntologyRegion":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"title":"OntologyRegion"},"ontology_OntologyRelationshipBetween":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/generatedTypes_Entities"},"to":{"$ref":"#/components/schemas/generatedTypes_Entities"}},"required":["from","to"],"title":"OntologyRelationshipBetween"},"ontology_OntologyRelationship":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/generatedTypes_Relationships"},"label":{"type":"string"},"description":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string"},"inverse":{"$ref":"#/components/schemas/generatedTypes_Relationships"},"between":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRelationshipBetween"}},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Attributes"}}},"required":["id","label","description","comment","type","inverse","between","attributes"],"title":"OntologyRelationship"},"ontology_OntologyRiskFactor":{"type":"object","properties":{"id":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"label":{"type":"string"},"description":{"type":"string"},"doc":{"type":"string"},"code":{"type":"integer"},"level":{"type":"string"},"risk_type":{"type":"string"},"risk_viz":{"type":"string"},"visible":{"type":"boolean"},"enabled":{"type":"boolean"},"type":{"type":"string"},"tg":{"type":"boolean"},"do_not_render_metadata":{"type":"array","items":{"type":"string"}}},"required":["id","categories","label","description","doc","code","level","risk_type","risk_viz","visible","enabled","type","tg","do_not_render_metadata"],"title":"OntologyRiskFactor"},"ontology_OntologySource":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"country":{"$ref":"#/components/schemas/generatedTypes_Country"},"region":{"type":"string"},"date_added":{"type":"string","format":"date","description":"An ISO 8601 encoded date string indicating the added date. In the format YYYY-MM-DD"},"source_type":{"type":"string"},"record_type":{"type":"string"},"structure":{"type":"string"},"source_url":{"type":"string"},"pep":{"type":"boolean"},"watchlist":{"type":"boolean"}},"required":["id","label","description","country","region","date_added","source_type","record_type","structure","pep","watchlist"],"title":"OntologySource"},"ontology_OntologySourceType":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"title":"OntologySourceType"},"ontology_GetOntologyResponseData":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyAttribute"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyCountry"}},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyCurrency"}},"entity_types":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyEntityType"}},"enums":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyEnum"}},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyIdentifier"}},"languages":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyLanguage"}},"regions":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRegion"}},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRelationship"}},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRiskFactor"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologySource"}},"source_types":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologySourceType"}}},"required":["attributes","countries","currencies","entity_types","enums","identifiers","languages","regions","relationships","risk_factors","sources","source_types"],"title":"GetOntologyResponseData"},"ontology_GetOntologyResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ontology_GetOntologyResponseData"}},"required":["data"],"title":"GetOntologyResponse"},"ontology_OntologyAttributesFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Attributes"},"description":"Attribute Id filter."}},"title":"OntologyAttributesFilters"},"ontology_GetOntologyAttributesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyAttributesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyAttribute"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyAttributesResponse"},"ontology_OntologyCountriesFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Country Id filter."}},"title":"OntologyCountriesFilters"},"ontology_GetOntologyCountriesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyCountriesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyCountry"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyCountriesResponse"},"ontology_OntologyCurrenciesFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Currency"},"description":"Currency Id filter."}},"title":"OntologyCurrenciesFilters"},"ontology_GetOntologyCurrenciesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyCurrenciesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyCurrency"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyCurrenciesResponse"},"ontology_OntologyEntityTypesFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Entities"},"description":"Entity type Id filter."}},"title":"OntologyEntityTypesFilters"},"ontology_GetOntologyEntityTypesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyEntityTypesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyEntityType"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyEntityTypesResponse"},"ontology_OntologyBaseFilters":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string"},"description":"Resource Id filter."}},"title":"OntologyBaseFilters"},"ontology_GetOntologyEnumsResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyBaseFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyEnum"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyEnumsResponse"},"ontology_OntologyHsCodesFilters":{"type":"object","properties":{"code":{"type":"array","items":{"type":"string"},"description":"HS code filter."}},"title":"OntologyHsCodesFilters"},"ontology_OntologyHsCode":{"type":"object","properties":{"code":{"type":"string"},"short_description":{"type":"string"},"long_description":{"type":"string"}},"required":["code","short_description","long_description"],"title":"OntologyHsCode"},"ontology_GetOntologyHsCodesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyHsCodesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyHsCode"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyHsCodesResponse"},"ontology_OntologyIdentifiersFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_IdentifierType"},"description":"Identifier Id filter."}},"title":"OntologyIdentifiersFilters"},"ontology_GetOntologyIdentifiersResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyIdentifiersFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyIdentifier"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyIdentifiersResponse"},"ontology_OntologyLanguagesFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Language"},"description":"Language Id filter."}},"title":"OntologyLanguagesFilters"},"ontology_GetOntologyLanguagesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyLanguagesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyLanguage"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyLanguagesResponse"},"ontology_GetOntologyRegionsResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyBaseFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRegion"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyRegionsResponse"},"ontology_OntologyRelationshipsFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Relationships"},"description":"Relationship Id filter."}},"title":"OntologyRelationshipsFilters"},"ontology_GetOntologyRelationshipsResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyRelationshipsFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRelationship"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyRelationshipsResponse"},"generatedTypes_RiskCategory":{"type":"string","enum":["adverse_media","environmental_risk","export_controls","forced_labor","political_exposure","regulatory_action","sanctions","sanctions_and_export_control_lists","shell_company_risk"],"title":"RiskCategory"},"ontology_OntologyRiskFactorsFilters":{"type":"object","properties":{"id":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"Risk factor Id filter."},"risk_category":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskCategory"},"description":"Risk category filter."},"level":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RiskLevel"},"description":"Risk level filter."},"risk_type":{"type":"array","items":{"type":"string"},"description":"Risk type filter."},"enabled":{"type":"boolean","description":"Risk enabled filter."},"visible":{"type":"boolean","description":"Risk visible filter."}},"title":"OntologyRiskFactorsFilters"},"ontology_GetOntologyRiskFactorsResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyRiskFactorsFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologyRiskFactor"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologyRiskFactorsResponse"},"ontology_OntologySourcesFilters":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string"},"description":"Source Id filter."},"country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Source country filter."},"source_type":{"type":"array","items":{"type":"string"},"description":"Source type filter."}},"title":"OntologySourcesFilters"},"ontology_GetOntologySourcesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologySourcesFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologySource"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologySourcesResponse"},"ontology_GetOntologySourceTypesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ontology_OntologyBaseFilters"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ontology_OntologySourceType"}},"total_count":{"type":"integer"}},"required":["filters","data","total_count"],"title":"GetOntologySourceTypesResponse"},"project_ProjectType":{"type":"string","enum":["network","supply_chain"],"title":"ProjectType"},"project_Role":{"type":"string","enum":["viewer","editor","admin"],"description":"Role enum describes the access levels a user has to a project and its contents.","title":"Role"},"project_ProjectShareOnCreate":{"type":"object","properties":{"org":{"$ref":"#/components/schemas/project_Role"}},"required":["org"],"title":"ProjectShareOnCreate"},"project_CreateProjectRequest":{"type":"object","properties":{"label":{"type":"string"},"type":{"$ref":"#/components/schemas/project_ProjectType","description":"Specifies which type of project to create. Defaults to 'network'"},"share":{"$ref":"#/components/schemas/project_ProjectShareOnCreate","description":"Specifies access levels available to users in a project within an organization. For comprehensive access, the admin role is recommended."}},"required":["label"],"title":"CreateProjectRequest"},"project_ProjectCounts":{"type":"object","properties":{"entity":{"type":"integer","description":"The number of entities in the project."},"graph":{"type":"integer"},"search":{"type":"integer"},"record":{"type":"integer"}},"title":"ProjectCounts"},"project_Project":{"type":"object","properties":{"id":{"type":"string","description":"Unique project identifier."},"label":{"type":"string","description":"Most recently set name for the project."},"archived":{"type":"boolean","description":"Whether the project is archived. Archival is a soft delete."},"created":{"type":"string"},"updated":{"type":"string"},"counts":{"$ref":"#/components/schemas/project_ProjectCounts"},"is_scrm":{"type":"boolean","description":"**Deprecated.** Use `type == 'supply_chain'` instead."},"type":{"$ref":"#/components/schemas/project_ProjectType"}},"required":["id","label","archived","created","updated","counts","type"],"title":"Project"},"project_CreateProjectResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/project_Project"}},"required":["data"],"title":"CreateProjectResponse"},"project_RoleMemberType":{"type":"string","enum":["user","group"],"description":"Role member type enum describes how access is granted to a project and its contents","title":"RoleMemberType"},"project_RoleMember":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/project_RoleMemberType"},"role":{"$ref":"#/components/schemas/project_Role"},"created":{"type":"string"},"updated":{"type":"string"}},"required":["id","type","role","created","updated"],"title":"RoleMember"},"project_ProjectWithMembers":{"type":"object","properties":{"id":{"type":"string","description":"Unique project identifier."},"label":{"type":"string","description":"Most recently set name for the project."},"archived":{"type":"boolean","description":"Whether the project is archived. Archival is a soft delete."},"created":{"type":"string"},"updated":{"type":"string"},"counts":{"$ref":"#/components/schemas/project_ProjectCounts"},"is_scrm":{"type":"boolean","description":"**Deprecated.** Use `type == 'supply_chain'` instead."},"type":{"$ref":"#/components/schemas/project_ProjectType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/project_RoleMember"}},"upload_count":{"type":"integer","description":"Number of uploads associated with the project."}},"required":["id","label","archived","created","updated","counts","type","members","upload_count"],"title":"ProjectWithMembers"},"project_GetProjectsResponse":{"type":"object","properties":{"next":{"type":"string"},"prev":{"type":"string"},"first":{"type":"boolean"},"last":{"type":"boolean"},"limit":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/project_ProjectWithMembers"}}},"required":["limit","data"],"title":"GetProjectsResponse"},"project_DeleteProjectResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/project_Project"}},"required":["data"],"title":"DeleteProjectResponse"},"projectEntity_StringOrNumber":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number","format":"double"}],"title":"StringOrNumber"},"baseTypes_CustomFieldValue":{"type":"string","description":"<Warning>This property is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> custom user key/value pairs (key must be prefixed with \"custom_\" and value must be \"string\" type)","title":"CustomFieldValue"},"projectEntity_ResolutionAttrSchema":{"type":"object","properties":{"identifier":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_StringOrNumber"}},"name":{"type":"array","items":{"type":"string"}},"country":{"type":"array","items":{"type":"string"}},"address":{"type":"array","items":{"type":"string"}},"date_of_birth":{"type":"array","items":{"type":"string"}},"contact":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_StringOrNumber"}},"type":{"type":"array","items":{"type":"string"}},"city":{"type":"array","items":{"type":"string"}},"state":{"type":"array","items":{"type":"string"}},"custom_{field name}":{"$ref":"#/components/schemas/baseTypes_CustomFieldValue"}},"title":"ResolutionAttrSchema"},"projectEntity_ResolutionProfile":{"type":"string","enum":["suppliers","corporate","search","screen"],"title":"ResolutionProfile"},"projectEntity_CreateResolvedProjectEntityRequest":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/projectEntity_ResolutionAttrSchema"},"limit":{"type":"integer"},"profile":{"$ref":"#/components/schemas/projectEntity_ResolutionProfile"},"enable_llm_clean":{"type":"boolean","description":"Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to false if not supplied. Set to true to enable LLM cleaning."}},"required":["attributes"],"title":"CreateResolvedProjectEntityRequest"},"sharedTypes_MatchStrengthEnum":{"type":"string","enum":["strong","partial","no_match","manual"],"title":"MatchStrengthEnum"},"projectEntity_AttributeValues":{"type":"object","properties":{"match_resolution":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}},"required":["match_resolution","values"],"title":"AttributeValues"},"projectEntity_ProjectRiskCategory":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"risk_factors":{"type":"array","items":{"type":"string"}}},"required":["id","label","risk_factors"],"title":"ProjectRiskCategory"},"projectEntity_ProjectRiskFactor":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"ProjectRiskFactor"},"projectEntity_TradeCounts":{"type":"object","properties":{"receiver_of":{"type":"integer"},"shipper_of":{"type":"integer"}},"required":["receiver_of","shipper_of"],"title":"TradeCounts"},"projectEntity_ProductCount":{"type":"object","properties":{"product":{"type":"string"},"count":{"type":"integer"}},"required":["count"],"title":"ProductCount"},"projectEntity_UpstreamCount":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProductCount"}}},"title":"UpstreamCount"},"projectEntity_UpstreamInfo":{"type":"object","properties":{"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskFactor"}},"countries":{"type":"array","items":{"type":"string"}},"trade_counts":{"$ref":"#/components/schemas/projectEntity_TradeCounts"},"has_upstream":{"type":"boolean"},"products":{"type":"array","items":{"type":"string"}},"risk_counts":{"$ref":"#/components/schemas/projectEntity_UpstreamCount"},"country_counts":{"$ref":"#/components/schemas/projectEntity_UpstreamCount"}},"required":["risk_factors","countries","trade_counts","has_upstream","products"],"title":"UpstreamInfo"},"projectEntity_TagResponse":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","created_at"],"title":"TagResponse"},"sharedTypes_CaseStatus":{"type":"string","enum":["not_assigned","in_review","approved","rejected"],"title":"CaseStatus"},"sharedTypes_CaseInfo":{"type":"object","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/sharedTypes_CaseStatus"},"created_at":{"type":"string"},"comment":{"type":"string"}},"required":["id","status","created_at"],"title":"CaseInfo"},"projectEntity_BusinessPurpose":{"type":"object","properties":{"code":{"type":"string"},"standard":{"type":"string"}},"required":["code","standard"],"title":"BusinessPurpose"},"projectEntity_SourceField":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"title":"SourceField"},"projectEntity_Location":{"type":"object","properties":{"lat":{"type":"number","format":"double"},"lon":{"type":"number","format":"double"}},"required":["lat","lon"],"title":"Location"},"projectEntity_Address":{"type":"object","properties":{"value":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"location":{"$ref":"#/components/schemas/projectEntity_Location"}},"required":["value"],"title":"Address"},"projectEntity_MatchProfileEnum":{"type":"string","enum":["corporate","suppliers","screen","search"],"title":"MatchProfileEnum"},"projectEntity_FieldMatchQuality":{"type":"string","enum":["high","medium","low","na"],"title":"FieldMatchQuality"},"projectEntity_ProjectEntityMatchExplanation":{"type":"object","properties":{"field":{"type":"string"},"quality":{"$ref":"#/components/schemas/projectEntity_FieldMatchQuality","description":"Quality of the match"},"description":{"type":"array","items":{"type":"string"}},"matches":{"type":"array","items":{"type":"string"}}},"required":["field","quality"],"title":"ProjectEntityMatchExplanation"},"projectEntity_ProjectEntityMatchResponse":{"type":"object","properties":{"match_id":{"type":"string"},"sayari_entity_id":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"countries":{"type":"array","items":{"type":"string"}},"risk_categories":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskCategory"}},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskFactor"}},"business_purpose":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_BusinessPurpose"}},"upstream":{"$ref":"#/components/schemas/projectEntity_UpstreamInfo"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_SourceField"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_Address"}},"hs_codes":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"match_profile":{"$ref":"#/components/schemas/projectEntity_MatchProfileEnum"},"deleted_at":{"type":"string"},"match_explanation":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectEntityMatchExplanation"}}},"required":["match_id","sayari_entity_id","type","label","countries","risk_categories","risk_factors","business_purpose","upstream","sources","addresses","hs_codes","created_at"],"title":"ProjectEntityMatchResponse"},"projectEntity_ProjectEntityResponse":{"type":"object","properties":{"project_entity_id":{"type":"string"},"project_id":{"type":"string"},"label":{"type":"string"},"upload_ids":{"type":"array","items":{"type":"string"}},"strength":{"$ref":"#/components/schemas/sharedTypes_MatchStrengthEnum"},"created_at":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/projectEntity_AttributeValues"}},"countries":{"type":"array","items":{"type":"string"}},"risk_categories":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskCategory"}},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskFactor"}},"upstream":{"$ref":"#/components/schemas/projectEntity_UpstreamInfo"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_TagResponse"}},"case":{"$ref":"#/components/schemas/sharedTypes_CaseInfo"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectEntityMatchResponse"}},"updated_at":{"type":"string"},"updated_by":{"type":"string"}},"required":["project_entity_id","project_id","label","upload_ids","strength","created_at","attributes","countries","risk_categories","risk_factors","upstream","tags","matches"],"title":"ProjectEntityResponse"},"projectEntity_SingleProjectEntityResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/projectEntity_ProjectEntityResponse"}},"required":["data"],"title":"SingleProjectEntityResponse"},"projectEntity_ProjectEntitiesFuzzyFilter":{"type":"object","properties":{"fuzzy":{"type":"array","items":{"type":"string"},"description":"Filter with fuzzy matching."}},"title":"ProjectEntitiesFuzzyFilter"},"projectEntity_ProjectEntitiesExactFilter":{"type":"object","properties":{"exact":{"type":"array","items":{"type":"string"},"description":"Filter with exact matching."}},"title":"ProjectEntitiesExactFilter"},"sharedTypes_MatchCount":{"type":"string","enum":["one","many"],"title":"MatchCount"},"projectEntity_ProjectEntitiesCustomFieldFilter":{"type":"object","properties":{"custom_{field name}":{"$ref":"#/components/schemas/baseTypes_CustomFieldValue"}},"title":"ProjectEntitiesCustomFieldFilter"},"projectEntity_ProjectEntitiesFilter":{"type":"object","properties":{"risk_factor":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"Filter by [risk factor](/sayari-library/ontology/risk-factors) ID."},"risk_category":{"type":"array","items":{"type":"string"},"description":"Filter by risk factor `category`, e.g. `sanctions`. At least one risk factor from each provided category must be present."},"upstream_product":{"type":"array","items":{"type":"string"},"description":"Filter by upstream (supply chain) product ID."},"shipment_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by upstream (supply chain) [country](/sayari-library/ontology/enumerated-types#country) at any tier."},"tier1_shipment_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by upstream (supply chain) [country](/sayari-library/ontology/enumerated-types#country) at tier 1."},"tier2_shipment_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by upstream (supply chain) [country](/sayari-library/ontology/enumerated-types#country) at tier 2."},"tier3_shipment_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by upstream (supply chain) [country](/sayari-library/ontology/enumerated-types#country) at tier 3."},"tier4_shipment_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by upstream (supply chain) [country](/sayari-library/ontology/enumerated-types#country) at tier 4."},"tier5_shipment_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by upstream (supply chain) [country](/sayari-library/ontology/enumerated-types#country) at tier 5."},"country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Filter by [country](/sayari-library/ontology/enumerated-types#country)."},"business_purpose":{"type":"array","items":{"type":"string"},"description":"Filter by HS code, HS code description, or business description."},"label":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesFuzzyFilter","description":"Filter by entity label with fuzzy matching."},"city":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesFuzzyFilter","description":"Filter by entity city with fuzzy matching."},"state":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesFuzzyFilter","description":"Filter by entity address state with fuzzy matching."},"identifier":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesFuzzyFilter","description":"Filter by entity identifier attributes with fuzzy matching."},"source":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesExactFilter","description":"Filter by entity source ID."},"status":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_CompanyStatus"},"description":"Filter by entity [company status](/sayari-library/ontology/enumerated-types#company-status)."},"bounds":{"type":"string","description":"Filter by a geographical bounding box. The value is a pipe-delimited set of four values representing the top, left, bottom, and right sides of the bounding box, in that order. The pipes should be URL-encoded as `%7C`. The top coordinate must greater than the bottom coordinate, and the left coordinate must be less than the right coordinate. A sample is `55.680357237879136|-71.53607290158526|41.10876347746233|-40.963927098414736`"},"match_entity_id":{"type":"array","items":{"type":"string"},"description":"Filter by match entity ID."},"entity_type":{"type":"array","items":{"type":"string"},"description":"Filter by entity type."},"tag":{"type":"array","items":{"type":"string"},"description":"Filter by tag ID."},"upload":{"type":"array","items":{"type":"string"},"description":"Filter by upload ID."},"case_status":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_CaseStatus"},"description":"Filter by case status."},"match_strength":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_MatchStrengthEnum"},"description":"Filter by match strength."},"match_count":{"$ref":"#/components/schemas/sharedTypes_MatchCount","description":"Filter by match count."},"attribute":{"$ref":"#/components/schemas/projectEntity_ProjectEntitiesCustomFieldFilter","description":"Filter by custom field."}},"title":"ProjectEntitiesFilter"},"projectEntity_ProjectEntitiesResponse":{"type":"object","properties":{"limit":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectEntityResponse"}},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"next":{"type":"string"},"prev":{"type":"string"}},"required":["limit","data","size"],"title":"ProjectEntitiesResponse"},"projectEntity_UpdateProjectEntityMatchesBody":{"type":"object","properties":{"entity_ids":{"type":"array","items":{"type":"string"}},"override_deleted":{"type":"boolean","description":"Add a previously deleted match. Defaults to false."},"limit":{"type":"integer","description":"Limit total matches to update. Defaults to 10. Max 50."}},"required":["entity_ids"],"title":"UpdateProjectEntityMatchesBody"},"projectEntity_UpdateProjectEntityMatchesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"},"description":"Updated entity ids"}},"required":["data"],"title":"UpdateProjectEntityMatchesResponse"},"projectEntity_ResolutionAttributes":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/projectEntity_ResolutionAttrSchema"}},"required":["attributes"],"title":"ResolutionAttributes"},"projectEntity_ProjectEntityExistsResponseData":{"type":"object","properties":{"project_entity_id":{"type":"string"}},"title":"ProjectEntityExistsResponseData"},"projectEntity_ProjectEntityIdResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/projectEntity_ProjectEntityExistsResponseData"}},"required":["data"],"title":"ProjectEntityIdResponse"},"projectEntity_SaveProjectEntityBody":{"type":"object","properties":{"entity_ids":{"type":"array","items":{"type":"string"}},"attributes":{"$ref":"#/components/schemas/projectEntity_ResolutionAttrSchema"},"profile":{"$ref":"#/components/schemas/projectEntity_ResolutionProfile"}},"required":["entity_ids","attributes","profile"],"title":"SaveProjectEntityBody"},"projectEntity_SortOrder":{"type":"string","enum":["asc","desc"],"title":"SortOrder"},"projectEntity_RiskChangeFilters":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"risk_factor":{"type":"array","items":{"type":"string"}},"risk_category":{"type":"array","items":{"type":"string"}}},"title":"RiskChangeFilters"},"projectEntity_RiskChangeFactorChangeType":{"type":"string","enum":["added","removed"],"title":"RiskChangeFactorChangeType"},"projectEntity_RiskChangeFactor":{"type":"object","properties":{"id":{"type":"string"},"timestamp":{"type":"string","description":"Timestamp of risk change detection"},"change_type":{"$ref":"#/components/schemas/projectEntity_RiskChangeFactorChangeType"}},"required":["id","timestamp","change_type"],"title":"RiskChangeFactor"},"projectEntity_ProjectRiskChange":{"type":"object","properties":{"project_entity_id":{"type":"string"},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_RiskChangeFactor"}}},"required":["project_entity_id","risk_factors"],"title":"ProjectRiskChange"},"projectEntity_ProjectRiskChangesResponseData":{"type":"object","properties":{"project_id":{"type":"string"},"risk_changes":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskChange"}}},"required":["project_id","risk_changes"],"title":"ProjectRiskChangesResponseData"},"projectEntity_ProjectRiskChangesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/projectEntity_RiskChangeFilters"},"next":{"type":"string"},"prev":{"type":"string"},"limit":{"type":"integer"},"data":{"$ref":"#/components/schemas/projectEntity_ProjectRiskChangesResponseData"}},"required":["filters","limit","data"],"title":"ProjectRiskChangesResponse"},"sharedErrors_UnprocessableContentResponse":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}},"required":["status","message","success"],"description":"Request made with an invalid body. This is most commonly due to parameter validation errors.","title":"UnprocessableContentResponse"},"projectEntity_ProjectEntityRiskChangesResponseData":{"type":"object","properties":{"project_id":{"type":"string"},"project_entity_id":{"type":"string"},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_RiskChangeFactor"}}},"required":["project_id","project_entity_id","risk_factors"],"title":"ProjectEntityRiskChangesResponseData"},"projectEntity_ProjectEntityRiskChangesResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/projectEntity_RiskChangeFilters"},"next":{"type":"string"},"prev":{"type":"string"},"limit":{"type":"integer"},"data":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskChangesResponseData"}},"required":["filters","limit","data"],"title":"ProjectEntityRiskChangesResponse"},"supplyChain_TradeTraversalFilters":{"type":"object","properties":{"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"Risk leaf node filter. Only return supply chains that end with a supplier that has 1+ of the specified risk factors."},"-risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors."},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Country leaf node filter. Only return supply chains that end with a supplier in 1+ of the specified countries."},"-countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries."},"product":{"type":"array","items":{"type":"string"},"description":"Product root edge filter. Only return supply chains that start with an edge that has 1+ of the specified HS codes."},"-product":{"type":"array","items":{"type":"string"},"description":"Product root edge filter. Only return supply chains that start with an edge that has none of the specified HS codes."},"component":{"type":"array","items":{"type":"string"},"description":"Component edge filter. Only return supply chains that contain at least one edge with 1+ of the specified HS codes."},"-component":{"type":"array","items":{"type":"string"},"description":"Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes."},"min_date":{"type":"string","description":"Minimum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are greater than or equal to this date."},"max_date":{"type":"string","description":"Maximum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are less than or equal to this date."},"max_depth":{"type":"integer","description":"The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out."},"limit":{"type":"integer","description":"The maximum number of results to return. Default is no limit."}},"title":"TradeTraversalFilters"},"supplyChain_TradeTraversalComponent":{"type":"object","properties":{"hs_code":{"type":"string"},"arrival_countries":{"type":"array","items":{"type":"string"}},"departure_countries":{"type":"array","items":{"type":"string"}},"min_date":{"type":"string"},"max_date":{"type":"string"}},"required":["hs_code","arrival_countries","departure_countries"],"title":"TradeTraversalComponent"},"supplyChain_TradeTraversalPathSegment":{"type":"object","properties":{"tier":{"type":"integer","description":"Associated tier for that path segment (1-5)"},"entity_id":{"type":"string","description":"Supplier entity ID"},"components":{"type":"array","items":{"$ref":"#/components/schemas/supplyChain_TradeTraversalComponent"},"description":"Components shipped by the supplier"}},"required":["tier","entity_id","components"],"title":"TradeTraversalPathSegment"},"supplyChain_TradeTraversalPath":{"type":"object","properties":{"source_entity_id":{"type":"string","description":"Root entity ID"},"path":{"type":"array","items":{"$ref":"#/components/schemas/supplyChain_TradeTraversalPathSegment"},"description":"Upstream paths beginning with the T1-T2 edge"}},"required":["source_entity_id","path"],"title":"TradeTraversalPath"},"supplyChain_TradeTraversalEntity":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"risk_factors":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}}},"required":["id","type","label","risk_factors","countries"],"title":"TradeTraversalEntity"},"supplyChain_TradeTraversalData":{"type":"object","properties":{"paths":{"type":"array","items":{"$ref":"#/components/schemas/supplyChain_TradeTraversalPath"}},"entities":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/supplyChain_TradeTraversalEntity"}}},"required":["paths","entities"],"title":"TradeTraversalData"},"supplyChain_UpstreamTradeTraversalResponse":{"type":"object","properties":{"status":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"filters":{"$ref":"#/components/schemas/supplyChain_TradeTraversalFilters"},"data":{"$ref":"#/components/schemas/supplyChain_TradeTraversalData"},"explored_count":{"type":"integer","description":"Number of hops explored in the traversal"},"partial_results":{"type":"boolean","description":"True if the traversal returned partial results"}},"required":["filters","data","explored_count","partial_results"],"title":"UpstreamTradeTraversalResponse"},"projectEntity_ProjectEntityRiskSummaryFilters":{"type":"object","properties":{"risk_factor":{"type":"array","items":{"type":"string"},"description":"Filter by risk factor IDs"},"risk_category":{"type":"array","items":{"type":"string"},"description":"Filter by risk category IDs"}},"title":"ProjectEntityRiskSummaryFilters"},"projectEntity_ShareInformation":{"type":"object","properties":{"percentage":{"type":"number","format":"double"},"num_shares":{"type":"integer"},"monetary_value":{"type":"integer"}},"title":"ShareInformation"},"projectEntity_ProjectEntityRiskSummaryNetworkPath":{"type":"object","properties":{"sayari_entity_id":{"type":"string"},"sayari_entity_label":{"type":"string"},"relationship_type":{"type":"string"},"relationship_status":{"type":"string"},"former":{"type":"boolean"},"first_observed":{"type":"string"},"last_observed":{"type":"string"},"start_date":{"type":"string"},"shares":{"$ref":"#/components/schemas/projectEntity_ShareInformation"}},"required":["sayari_entity_id","sayari_entity_label","relationship_type","relationship_status","former","first_observed","last_observed"],"title":"ProjectEntityRiskSummaryNetworkPath"},"projectEntity_ProjectEntityRiskSummaryRiskFactor":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"value":{"$ref":"#/components/schemas/projectEntity_StringOrNumber"},"level":{"$ref":"#/components/schemas/sharedTypes_RiskLevel"},"risk_categories":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectRiskCategory"}},"source_entity_ids":{"type":"array","items":{"type":"string"}},"network_paths":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskSummaryNetworkPath"}}},"metadata":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_StringOrNumber"}}}},"risk_intelligence":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/projectEntity_StringOrNumber"}}}},"required":["id","label","value","level","risk_categories","source_entity_ids","network_paths","metadata","risk_intelligence"],"title":"ProjectEntityRiskSummaryRiskFactor"},"projectEntity_ProjectEntityRiskSummaryData":{"type":"object","properties":{"project_entity_id":{"type":"string"},"project_id":{"type":"string"},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskSummaryRiskFactor"}}},"required":["project_entity_id","project_id","risk_factors"],"title":"ProjectEntityRiskSummaryData"},"projectEntity_ProjectEntityRiskSummaryResponseFilters":{"type":"object","properties":{"risk_factor":{"type":"array","items":{"type":"string"}},"risk_category":{"type":"array","items":{"type":"string"}}},"title":"ProjectEntityRiskSummaryResponseFilters"},"projectEntity_ProjectEntityRiskSummaryResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskSummaryData"},"filters":{"$ref":"#/components/schemas/projectEntity_ProjectEntityRiskSummaryResponseFilters"}},"required":["data","filters"],"title":"ProjectEntityRiskSummaryResponse"},"projectEntity_RiskCategoriesSummary":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"risk_factors":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"}}},"required":["id","label","risk_factors"],"title":"RiskCategoriesSummary"},"projectEntity_ProjectEntitySupplyChainUpstream":{"type":"object","properties":{"components":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"risk_categories":{"type":"array","items":{"$ref":"#/components/schemas/projectEntity_RiskCategoriesSummary"}}},"required":["components","countries","risk_categories"],"title":"ProjectEntitySupplyChainUpstream"},"projectEntity_ProjectEntitySupplyChainSummaryResponseData":{"type":"object","properties":{"project_id":{"type":"string"},"project_entity_id":{"type":"string"},"upstream":{"$ref":"#/components/schemas/projectEntity_ProjectEntitySupplyChainUpstream"}},"required":["project_id","project_entity_id","upstream"],"title":"ProjectEntitySupplyChainSummaryResponseData"},"projectEntity_ProjectEntitySupplyChainSummaryResponse":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/supplyChain_TradeTraversalFilters"},"data":{"$ref":"#/components/schemas/projectEntity_ProjectEntitySupplyChainSummaryResponseData"}},"required":["filters","data"],"title":"ProjectEntitySupplyChainSummaryResponse"},"record_RecordReferences":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"next":{"type":"boolean"},"offset":{"type":"integer"},"data":{"description":"Any type"}},"required":["limit","size","next","offset","data"],"title":"RecordReferences"},"record_GetRecordResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a record in the database"},"label":{"type":"string"},"source":{"type":"string","description":"The unique identifier for a source in the database"},"publication_date":{"type":"string","description":"The date the record was published"},"acquisition_date":{"type":"string","description":"The date Sayari acquired this record"},"references_count":{"type":"integer","description":"Number of times this record is referenced"},"record_url":{"type":"string","description":"The url to download the record from Sayari"},"source_url":{"type":"string","description":"The url to access to original source"},"document_urls":{"type":"array","items":{"type":"string"}},"matches":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"country":{"$ref":"#/components/schemas/generatedTypes_Country"},"page":{"type":"number","format":"double"},"page_count":{"type":"number","format":"double"},"references":{"$ref":"#/components/schemas/record_RecordReferences"}},"required":["id","label","source","acquisition_date","references_count","record_url","references"],"description":"OK","title":"GetRecordResponse"},"resolution_ProfileEnum":{"type":"string","enum":["corporate","suppliers","search","screen"],"title":"ProfileEnum"},"resolution_ResolutionResponseFields":{"type":"object","properties":{"name":{"type":"array","items":{"type":"string"}},"identifier":{"type":"array","items":{"type":"string"}},"profile":{"type":"string"},"country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity country - must be ISO (3166) Trigram i.e., USA. See complete list [here](/sayari-library/ontology/enumerated-types#country)"},"address":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity."},"date_of_birth":{"type":"array","items":{"type":"string"}},"contact":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Entities"},"description":"[Entity type](/sayari-library/ontology/entities)"}},"title":"ResolutionResponseFields"},"resolution_MatchQuality":{"type":"string","enum":["high","medium","low"],"description":"Represents the quality of the field match","title":"MatchQuality"},"resolution_MatchExplanation":{"type":"object","properties":{"matched":{"type":"string"},"uploaded":{"type":"string"},"name_custom_tf_idf_score":{"type":"number","format":"double"},"high_quality_match_name":{"type":"boolean"},"scores":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"n_common_term_matches":{"type":"integer"},"n_uncommon_term_matches":{"type":"integer"},"match_quality":{"$ref":"#/components/schemas/resolution_MatchQuality"}},"title":"MatchExplanation"},"resolution_MatchStrength":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"title":"MatchStrength"},"resolution_ResolutionResult":{"type":"object","properties":{"profile":{"type":"string"},"score":{"type":"number","format":"double"},"entity_id":{"type":"string"},"label":{"type":"string"},"type":{"$ref":"#/components/schemas/generatedTypes_Entities"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"psa_id":{"type":"number","format":"double"},"addresses":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"sources":{"type":"array","items":{"type":"string"}},"typed_matched_queries":{"type":"array","items":{"type":"string"}},"matched_queries":{"type":"array","items":{"type":"string"}},"highlight":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"explanation":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/resolution_MatchExplanation"}}},"match_strength":{"$ref":"#/components/schemas/resolution_MatchStrength"}},"required":["profile","score","entity_id","label","type","identifiers","addresses","countries","sources","typed_matched_queries","matched_queries","highlight","explanation","match_strength"],"title":"ResolutionResult"},"resolution_ResolutionResponse":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/resolution_ResolutionResponseFields"},"data":{"type":"array","items":{"$ref":"#/components/schemas/resolution_ResolutionResult"}}},"required":["fields","data"],"title":"ResolutionResponse"},"sharedErrors_NotAcceptableResponse":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}},"required":["status","message","success"],"description":"Request made in an unacceptable state due to an invalid Accept header.","title":"NotAcceptableResponse"},"resolution_ResolutionBody":{"type":"object","properties":{"name":{"type":"array","items":{"type":"string"},"description":"Entity name"},"identifier":{"$ref":"#/components/schemas/generatedTypes_BothIdentifierTypes","description":"Entity identifier. Can be from either the [Identifier Type](/sayari-library/ontology/enumerated-types#identifier-type) or [Weak Identifier Type](/sayari-library/ontology/enumerated-types#weak-identifier-type) enums."},"address":{"type":"array","items":{"type":"string"},"description":"Entity address"},"city":{"type":"string","description":"Entity city that contains the provided city name."},"state":{"type":"string","description":"Entity state that contains the provided state name."},"country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity country - must be ISO (3166) Trigram i.e., `USA`. See complete list [here](/sayari-library/ontology/enumerated-types#country)"},"date_of_birth":{"type":"array","items":{"type":"string"},"description":"Entity date of birth"},"contact":{"type":"array","items":{"type":"string"},"description":"Entity contact"},"type":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Entities"},"description":"[Entity type](/sayari-library/ontology/entities). If multiple values are passed for any field, the endpoint will match entities with ANY of the values."},"profile":{"$ref":"#/components/schemas/resolution_ProfileEnum","description":"Specifies the search algorithm to use. `corporate` (default) is optimized for accurate entity attribute matching, ideal for business verification. `suppliers` is tailored for matching entities with trade data, suitable for supply chain use cases. `search` mimics /search/entity behavior, best for name-only matches."},"name_min_percentage":{"type":"integer","description":"Adding this param enables an alternative matching logic. It will set a minimum percentage of tokens needed to match with user input to be considered a \"hit\". Accepts integers from 0 to 100 inclusive."},"name_min_tokens":{"type":"integer","description":"Adding this param enables an alternative matching logic. It sets the minimum number of matching tokens the resolved hits need to have in common with the user input to be considered a \"hit\". Accepts non-negative integers."},"tags":{"type":"array","items":{"type":"string"},"description":"An array of tag labels to associate with each resolved entity"},"minimum_score_threshold":{"type":"integer","description":"Specifies the minimum score required to pass, which controls the strictness of the matching threshold. The default value is 77, and tuned for general use-case accuracy. Increase the value for stricter matching, reduce to loosen."},"search_fallback":{"type":"boolean","description":"Enables a name search fallback when either the corporate or supplier profiles fails to find a match. When invoked, the fallback will make a call similar to /search/entity on name only. By default set to false."},"cutoff_threshold":{"type":"integer","description":"Specifies the window of similar results returned in the match group. Increase for fewer multiple matches, decrease to open the aperture and allow for more matches. Default is .8"},"candidate_pool_size":{"type":"integer","description":"Specifies the maximum number of entity candidates considered during search. Default is 50. Higher values increase match pool size but also increase latency."},"skip_post_process":{"type":"boolean","description":"Bypasses the post-processing setps and re-ranking. Useful for debugging. By default set to false, set to true to enable."},"enable_llm_clean":{"type":"boolean","description":"Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to true if not supplied. Set to false to disable LLM cleaning."}},"title":"ResolutionBody"},"resolution_ResolutionPersistedResponseFields":{"type":"object","properties":{"name":{"type":"array","items":{"type":"string"}},"identifier":{"type":"array","items":{"type":"string"}},"profile":{"type":"string"},"country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity country - must be ISO (3166) Trigram i.e., USA. See complete list [here](/sayari-library/ontology/enumerated-types#country)"},"address":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity."},"date_of_birth":{"type":"array","items":{"type":"string"}},"contact":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Entities"},"description":"[Entity type](/sayari-library/ontology/entities)"},"custom_{field name}":{"$ref":"#/components/schemas/baseTypes_CustomFieldValue"},"custom_name":{"type":"string"},"custom_identifier":{"type":"string"}},"title":"ResolutionPersistedResponseFields"},"resolution_ResolutionPersistedResult":{"type":"object","properties":{"profile":{"type":"string"},"score":{"type":"number","format":"double"},"entity_id":{"type":"string"},"label":{"type":"string"},"type":{"$ref":"#/components/schemas/generatedTypes_Entities"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"psa_id":{"type":"number","format":"double"},"addresses":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"sources":{"type":"array","items":{"type":"string"}},"typed_matched_queries":{"type":"array","items":{"type":"string"}},"matched_queries":{"type":"array","items":{"type":"string"}},"highlight":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"explanation":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/resolution_MatchExplanation"}}},"match_strength":{"$ref":"#/components/schemas/resolution_MatchStrength"},"saved_entity_id":{"type":"string"}},"required":["profile","score","entity_id","label","type","identifiers","addresses","countries","sources","typed_matched_queries","matched_queries","highlight","explanation","match_strength","saved_entity_id"],"title":"ResolutionPersistedResult"},"resolution_ResolutionPersistedResponse":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/resolution_ResolutionPersistedResponseFields"},"data":{"type":"array","items":{"$ref":"#/components/schemas/resolution_ResolutionPersistedResult"}}},"required":["fields","data"],"title":"ResolutionPersistedResponse"},"resolution_ResolutionUploadBody":{"type":"object","properties":{"filename":{"type":"string"},"enable_llm_clean":{"type":"boolean","description":"Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to true if not supplied. Set to false to disable LLM cleaning."},"data":{"type":"array","items":{"$ref":"#/components/schemas/resolution_ResolutionBody"}}},"required":["filename","data"],"title":"ResolutionUploadBody"},"resolution_ResolutionUploadResponse":{"type":"object","properties":{"file":{"type":"string"},"uploaded":{"type":"string"},"count":{"type":"integer"}},"required":["file","uploaded","count"],"title":"ResolutionUploadResponse"},"resource_ResourceType":{"type":"string","enum":["entity"],"title":"ResourceType"},"resource_SaveEntityRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/resource_ResourceType"},"project":{"type":"string","description":"The project identifier."},"entity_id":{"type":"string","description":"The entity identifier."},"custom_fields":{"description":"<Warning>This property is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> custom user key/value pairs (key must be prefixed with \"custom_\" and value must be \"string\" type)"}},"required":["type","project","entity_id","custom_fields"],"title":"SaveEntityRequest"},"resource_EntityResponseData":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/resource_ResourceType"},"id":{"type":"string"},"project":{"type":"string"},"label":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"updated_by":{"type":"string"},"version":{"type":"integer"},"entity_id":{"type":"string"},"tag_ids":{"type":"array","items":{"type":"string"}},"case_status":{"type":"string"}},"required":["type","id","project","label","created","updated","updated_by","version","entity_id","tag_ids","case_status"],"title":"EntityResponseData"},"resource_SaveEntityResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/resource_EntityResponseData"}},"required":["data"],"title":"SaveEntityResponse"},"resource_DeleteResourceResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/resource_EntityResponseData"}},"required":["data"],"title":"DeleteResourceResponse"},"screen_ScreenResponseRequest":{"type":"object","properties":{"project_id":{"type":"string"},"project_entity_id":{"type":"string"},"org_id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"release_name":{"type":"string"}},"required":["project_id","project_entity_id"],"title":"ScreenResponseRequest"},"screen_ScreenResponseAttributeValue":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"title":"ScreenResponseAttributeValue"},"screen_ScreenResponseAttribute":{"type":"object","properties":{"match_resolution":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/screen_ScreenResponseAttributeValue"}}},"required":["match_resolution","values"],"title":"ScreenResponseAttribute"},"screen_ScreenResponseMatch":{"type":"object","properties":{"name":{"type":"string"},"similarity_score":{"type":"number","format":"double"},"confidence_score":{"type":"number","format":"double"},"explanation":{"type":"string"}},"required":["name","similarity_score"],"title":"ScreenResponseMatch"},"screen_WatchlistAttributeValue":{"type":"object","additionalProperties":{"description":"Any type"},"description":"A single watchlist attribute record. All fields are string, number, boolean, or null. Most records contain a \"value\" field with the primary string value plus attribute-specific fields (e.g. name records include \"context\", \"language\", \"translated\", \"transliterated\", \"from_date\", \"to_date\", \"date\", \"extra\"; address records include the full Libpostal field set: \"city\", \"state\", \"country\", \"postcode\", \"road\", \"house\", \"house_number\", \"unit\", \"x\", \"y\", \"near\", \"level\", \"building\", \"suburb\", \"island\", \"po_box\", \"entrance\", \"staircase\", \"category\", \"world_region\", \"city_district\", \"metro_station\", \"country_region\", \"state_district\", \"precision_code\", plus date and extra fields). The \"extra\" field, when present, is an array of WatchlistKeyValue pairs containing supplemental metadata (e.g. source attribution).","title":"WatchlistAttributeValue"},"screen_WatchlistKeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"description":"Key-value pair used in the extra field of attribute records.","title":"WatchlistKeyValue"},"screen_WatchlistRiskIntelligenceValue":{"type":"object","properties":{"list":{"type":"string","description":"Name of the sanctions or risk list (e.g. \"OFAC Specially Designated Nationals (SDN) List\")."},"type":{"type":"string","description":"Risk category (e.g. \"sanctions\", \"export_controls\", \"pep\")."},"score":{"type":"number","format":"double","description":"Risk score, if provided by the source list."},"reason":{"type":"string","description":"Reason for designation or listing."},"program":{"type":"string","description":"Sanctions program or sub-program name (e.g. \"CUBA\", \"IRAN\")."},"authority":{"type":"string","description":"Issuing authority (e.g. \"OFAC\", \"Department of the Commerce - International Trade Administration\")."},"from_date":{"type":"string","description":"Date the listing took effect (ISO 8601 date string)."},"to_date":{"type":"string","description":"Date the listing was removed, if applicable."},"date":{"type":"string","description":"Generic date field for sources that do not distinguish from/to dates."},"extra":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistKeyValue"},"description":"Supplemental metadata as key-value pairs (e.g. license requirements, federal register notices)."}},"description":"A single risk intelligence record. Unlike other attribute records, this type does NOT contain a \"value\" field. Risk label information is in the \"list\" and \"program\" fields.","title":"WatchlistRiskIntelligenceValue"},"screen_WatchlistEntityMatch":{"type":"object","properties":{"entity_reference_id":{"type":"string","description":"Unique identifier for the watchlist entity."},"type":{"type":"string","description":"Entity type (e.g. \"company\", \"person\", \"vessel\")."},"additional_information":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Miscellaneous information not covered by other attribute types. Records typically contain \"value\" and optional \"type\" and \"extra\" fields."},"address":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Physical location descriptions parsed via the Libpostal ontology. Each record contains \"value\" (full address string) plus structured sub-fields: \"city\", \"state\", \"country\", \"postcode\", \"road\", \"house\", \"house_number\", \"unit\", \"x\", \"y\", \"near\", \"level\", \"building\", \"suburb\", \"island\", \"po_box\", \"entrance\", \"staircase\", \"category\", \"world_region\", \"city_district\", \"metro_station\", \"country_region\", \"state_district\", \"precision_code\", \"date\", \"from_date\", \"to_date\", \"language\", \"translated\", \"transliterated\", and \"extra\" (array of WatchlistKeyValue with source attribution)."},"business_purpose":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Text or code (NAICS, NACE, ISIC, etc.) describing what the entity is legally permitted to do or produce."},"company_type":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Legal entity type in a given jurisdiction (e.g. \"LLC\", \"Sociedad Anonima\")."},"contact":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Contact information such as phone numbers, email addresses, or URLs."},"country":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Country affiliation through residence, nationality, registration, etc."},"date_of_birth":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Birth date of a person. Records typically contain a \"value\" field with the date string."},"finances":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Financial figures such as share capital (deprecated — use financials)."},"financials":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Financial information at a point in time (e.g. revenue, assets)."},"gender":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Gender of a person."},"generic":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Placeholder attribute for data that does not fit any other attribute type."},"identifier":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"ID numbers that uniquely identify an entity when value and type are both considered (e.g. registration number, tax ID)."},"measurement":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Numerical measurement of an entity dimension using a standard unit."},"monetary_value":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Financial value of an asset (e.g. FOB, CIF values)."},"name":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Entity name records. Each record contains at minimum a \"value\" field with the name string."},"person_status":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Key life events for a person, usually temporal."},"position":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Title or designation associated with a relationship (e.g. \"Secretary of the Board\")."},"risk_intelligence":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistRiskIntelligenceValue"},"description":"Risk or sanctions program data. Records contain structured fields (list, type, program, authority, from_date, to_date, score, reason, extra) — there is no \"value\" field on these records."},"risk_factors":{"type":"array","items":{"type":"string"},"description":"Risk factor umbrella values mapped from Risk Intelligence"},"shares":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Shareholding information."},"status":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Status of the entity (e.g. active, dissolved)."},"translated_name":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Translated or transliterated name records."},"weak_identifier":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Identifiers that are not unique on their own and require additional context to disambiguate."},"risk_event":{"type":"array","items":{"$ref":"#/components/schemas/screen_WatchlistAttributeValue"},"description":"Risk events associated with the entity — ESG controversies, enforcement actions, adverse media, etc. Records may contain fields such as \"category\", \"subcategory\", \"event_type\", \"title\", \"source_url\", \"credibility\", \"event_stage\", \"penalty_and_restriction\", and \"dismissal_and_clearance\"."}},"required":["entity_reference_id","type"],"description":"The watchlist entity associated with a screening match, as stored at ingestion time. All attribute fields follow the Sayari ontology: each is an array of attribute records (WatchlistAttributeValue). All known attribute fields are always present in the response — fields with no data are returned as null rather than omitted. Empty arrays may also be returned for attributes with no values.","title":"WatchlistEntityMatch"},"screen_ScreenResponseItem":{"type":"object","properties":{"reference_id":{"type":"string"},"org_id":{"type":"string"},"type":{"type":"string"},"release_name":{"type":"string"},"name_matches":{"type":"array","items":{"$ref":"#/components/schemas/screen_ScreenResponseMatch"}},"entity_match":{"$ref":"#/components/schemas/screen_WatchlistEntityMatch"},"risk_factor_keys":{"type":"array","items":{"type":"string"},"description":"Risk factor granular key mapped from Risk Intelligence"}},"required":["reference_id","org_id","release_name","name_matches"],"title":"ScreenResponseItem"},"screen_ScreenResponse":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/screen_ScreenResponseRequest"},"project_entity_attributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/screen_ScreenResponseAttribute"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/screen_ScreenResponseItem"}}},"required":["request","project_entity_attributes","data"],"title":"ScreenResponse"},"sharedErrors_ForbiddenResponse":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}},"required":["status","message","success"],"description":"User does not have the required role to access this resource.","title":"ForbiddenResponse"},"sharedTypes_SearchField":{"type":"string","enum":["name","identifier","address","business_purpose","date_of_birth","contact"],"title":"SearchField"},"search_SourceId":{"type":"string","description":"The unique identifier for a source in the database","title":"SourceId"},"search_FilterList":{"type":"object","properties":{"source":{"type":"array","items":{"$ref":"#/components/schemas/search_SourceId"},"description":"List of source IDs to filter by."},"source_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"List of source countries to filter by. Must be specified as trigrams, e.g. ATF."},"country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"List of countries to filter by."},"state":{"type":"array","items":{"type":"string"},"description":"List of states or provinces to filter by."},"city":{"type":"array","items":{"type":"string"},"description":"List of cities to filter by."},"entity_type":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Entities"},"description":"List of entity types to filter by."},"bounds":{"type":"array","items":{"type":"string"},"description":"Pipe-delimited bounding box coordinates (north,west,south,east). E.g., '\"46.12|-76|45|-75\"'."},"risk":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"List of risk factors to filter by."},"risk_category":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskCategory"},"description":"List of risk categories to filter by. An entity matches if it has any risk factor belonging to one of the specified categories."}},"description":"Filter your search on the following attributes.","title":"FilterList"},"search_Coordinates":{"type":"object","properties":{"lat":{"type":"number","format":"double"},"lng":{"type":"number","format":"double"},"address":{"type":"string"}},"required":["address"],"title":"Coordinates"},"sharedTypes_EntityMatches":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"An explanation of why this entity was returned as the result of a query.","title":"EntityMatches"},"search_SearchResults":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"label":{"type":"string","description":"Display name of the entity"},"degree":{"type":"integer","description":"Number of outgoing relationships"},"closed":{"type":"boolean","description":"True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation."},"entity_url":{"type":"string","description":"Convenience URL to the entity in the API."},"pep":{"type":"boolean","description":"True if the entity has the [\"Politically Exposed Person (PEP)\" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false."},"psa_id":{"type":"string"},"psa_count":{"type":"integer","description":"Number of entities that are Possibly the Same As (PSA) the entity."},"sanctioned":{"type":"boolean","description":"True if the entity has the [\"Sanctioned\" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false."},"type":{"$ref":"#/components/schemas/generatedTypes_Entities","description":"The [entity type](/sayari-library/ontology/entities)."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity [country](/sayari-library/ontology/enumerated-types#country)"},"source_count":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_SourceCountInfo"},"description":"Number of records associated with the entity, grouped by source."},"addresses":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)"},"trade_count":{"type":"object","additionalProperties":{"type":"integer"}},"date_of_birth":{"type":"string","description":"Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)"},"relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"user_relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"related_entities_count":{"type":"integer"},"user_related_entities_count":{"type":"integer"},"user_record_count":{"type":"integer"},"reference_id":{"type":"string"},"logistics_entity":{"type":"boolean"},"registration_date":{"$ref":"#/components/schemas/sharedTypes_EntityRegistrationDate"},"translated_label":{"$ref":"#/components/schemas/sharedTypes_EntityTranslatedLabel"},"hs_code":{"$ref":"#/components/schemas/sharedTypes_EntityHSCode"},"shipment_arrival":{"$ref":"#/components/schemas/sharedTypes_ShipmentArrival"},"shipment_departure":{"$ref":"#/components/schemas/sharedTypes_ShipmentDeparture"},"company_type":{"$ref":"#/components/schemas/sharedTypes_CompanyType"},"latest_status":{"$ref":"#/components/schemas/sharedTypes_Status"},"risk":{"$ref":"#/components/schemas/sharedTypes_EntityRisk","description":"[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity."},"attributes":{"$ref":"#/components/schemas/generatedTypes_AttributeDetails","description":"Detailed information about the entity's [attributes](/sayari-library/ontology/attributes)."},"relationships":{"$ref":"#/components/schemas/sharedTypes_EntityRelationships","description":"Detailed information about the entity's [relationships](/sayari-library/ontology/relationships)."},"possibly_same_as":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAs"},"referenced_by":{"$ref":"#/components/schemas/sharedTypes_ReferencedBy"},"coordinates":{"type":"array","items":{"$ref":"#/components/schemas/search_Coordinates"}},"matches":{"$ref":"#/components/schemas/sharedTypes_EntityMatches"}},"required":["id","label","degree","closed","entity_url","pep","psa_count","sanctioned","type","identifiers","countries","source_count","addresses","trade_count","relationship_count","user_relationship_count","attribute_count","user_attribute_count","related_entities_count","user_related_entities_count","user_record_count","risk","coordinates","matches"],"title":"SearchResults"},"search_EntitySearchResponse":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/search_SearchResults"}}},"required":["limit","size","offset","next","data"],"description":"OK","title":"EntitySearchResponse"},"search_RecordSearchResponse":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RecordDetails"}}},"required":["limit","size","offset","next","data"],"description":"OK","title":"RecordSearchResponse"},"trade_TradeFilterList":{"type":"object","properties":{"buyer_id":{"type":"array","items":{"type":"string"},"description":"Exact match against the entity_id of the buyer. The buyer is the receiver_of shipments."},"supplier_id":{"type":"array","items":{"type":"string"},"description":"Exact match against the entity_id of the supplier. The supplier is the shipper_of shipments."},"buyer_name":{"type":"array","items":{"type":"string"},"description":"Buyers whose name contains the provided string."},"supplier_name":{"type":"array","items":{"type":"string"},"description":"Shipper whose name contains the provided string."},"buyer_risk":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"Buyer with an exact match for the provided [risk factor](/sayari-library/ontology/risk-factors)."},"supplier_risk":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Risk"},"description":"Shipper with an exact match for the provided [risk factor](/sayari-library/ontology/risk-factors)."},"buyer_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Buyer with an exact match for the provided [country code](/sayari-library/ontology/enumerated-types#country)."},"buyer_city":{"type":"array","items":{"type":"string"},"description":"Buyer city location"},"buyer_state":{"type":"array","items":{"type":"string"},"description":"Buyer state location"},"supplier_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Supplier with an exact match for the provided [country code](/sayari-library/ontology/enumerated-types#country)."},"supplier_city":{"type":"array","items":{"type":"string"},"description":"Supplier city location"},"supplier_state":{"type":"array","items":{"type":"string"},"description":"Supplier state location"},"departure_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Shipment departs from a country with an exact match for the provided [country code](/sayari-library/ontology/enumerated-types#country)."},"departure_state":{"type":"array","items":{"type":"string"},"description":"Shipment departs from a state that contains the provided state name."},"departure_city":{"type":"array","items":{"type":"string"},"description":"Shipment departs from a city that contains the provided city name."},"arrival_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Shipment arrives at a country with an exact match for the provided [country code](/sayari-library/ontology/enumerated-types#country)."},"arrival_state":{"type":"array","items":{"type":"string"},"description":"Shipment arrives at a state that contains the provided state name."},"arrival_city":{"type":"array","items":{"type":"string"},"description":"Shipment arrives at a city that contains the provided city name."},"hs_code":{"type":"array","items":{"type":"string"},"description":"The shipment HS code starts with the provided HS code."},"hs_description":{"type":"array","items":{"type":"string"},"description":"The HS description contains the provided string."},"product_origin":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Product Origin with an exact match for the provided [country code](/sayari-library/ontology/enumerated-types#country)."},"supplier_purpose":{"type":"array","items":{"type":"string"},"description":"The supplier purpose contains the provided string."},"buyer_purpose":{"type":"array","items":{"type":"string"},"description":"The buyer purpose contains the provided string."},"arrival_date":{"type":"string","description":"The arrival date is within the provided range. Supports exact dates (YYYY-MM-DD) \nor date ranges (YYYY-MM | YYYY-MM). If an exact date is used it will be treated as the minimum date, with no maximum date specified. \nExample: \"2024-01|2024-10\" or \"2024-01-30\"."},"departure_date":{"type":"string","description":"The departure date is within the provided range. Supports exact dates (YYYY-MM-DD) \nIf an exact date is used it will be treated as the minimum date, with no maximum date specified. \nor date ranges (YYYY-MM | YYYY-MM). Example: \"2024-01|2024-10\" or \"2024-01-30\"."},"shipment_identifier":{"type":"array","items":{"type":"string"},"description":"The shipment identifier starts with the provided string."},"transit_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Countries through which a shipment passes for the provided [country code](/sayari-library/ontology/enumerated-types#country)."},"weight":{"type":"array","items":{"type":"string"},"description":"The shipment weight is within the provided range."},"sources":{"type":"array","items":{"type":"string"},"description":"An exact match for the provided sources."}},"description":"Filter your search on the following attributes.","title":"TradeFilterList"},"trade_SourceOrDestinationEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"type":{"type":"string"},"names":{"type":"array","items":{"type":"string"}},"risks":{"type":"object","additionalProperties":{"description":"Any type"},"description":"[Risks](/sayari-library/ontology/risk-factors)"},"business_purpose":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_BusinessPurposeProperties"},"description":"[Business Purpose](/sayari-library/ontology/attributes#business-purpose)"},"address":{"type":"array","items":{"description":"Any type"},"description":"[Address](/sayari-library/ontology/attributes#address)"},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"[Country](/sayari-library/ontology/attributes#country)"}},"required":["id","type","names","risks","business_purpose","address","countries"],"title":"SourceOrDestinationEntity"},"trade_ShipmentAddress":{"type":"object","properties":{"x":{"type":"number","format":"double"},"y":{"type":"number","format":"double"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"value":{"type":"string"}},"title":"ShipmentAddress"},"trade_MonetaryValue":{"type":"object","properties":{"value":{"type":"number","format":"double"},"currency":{"$ref":"#/components/schemas/generatedTypes_Currency"},"context":{"type":"string"}},"required":["value"],"title":"MonetaryValue"},"trade_Weight":{"type":"object","properties":{"value":{"type":"number","format":"double"},"unit":{"type":"string"},"type":{"type":"string"}},"required":["value","unit","type"],"title":"Weight"},"trade_ShipmentIdentifier":{"type":"object","properties":{"value":{"type":"string"},"type":{"$ref":"#/components/schemas/generatedTypes_BothIdentifierTypes"}},"required":["value","type"],"title":"ShipmentIdentifier"},"trade_DataSource":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a source in the database"},"label":{"type":"string"}},"required":["id","label"],"title":"DataSource"},"trade_hs_code_info":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"imputed":{"type":"boolean"}},"required":["code","description"],"title":"hs_code_info"},"trade_Shipment":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"buyer":{"type":"array","items":{"$ref":"#/components/schemas/trade_SourceOrDestinationEntity"}},"supplier":{"type":"array","items":{"$ref":"#/components/schemas/trade_SourceOrDestinationEntity"}},"arrival_date":{"type":"array","items":{"type":"string"}},"departure_date":{"type":"array","items":{"type":"string"}},"departure_address":{"$ref":"#/components/schemas/trade_ShipmentAddress"},"arrival_address":{"$ref":"#/components/schemas/trade_ShipmentAddress"},"shipper_address":{"$ref":"#/components/schemas/trade_ShipmentAddress"},"receiver_address":{"$ref":"#/components/schemas/trade_ShipmentAddress"},"arrival_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"departure_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"transit_country":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"product_origin":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"monetary_value":{"type":"array","items":{"$ref":"#/components/schemas/trade_MonetaryValue"}},"weight":{"type":"array","items":{"$ref":"#/components/schemas/trade_Weight"}},"identifier":{"type":"array","items":{"$ref":"#/components/schemas/trade_ShipmentIdentifier"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/trade_DataSource"}},"hs_codes":{"type":"array","items":{"$ref":"#/components/schemas/trade_hs_code_info"}},"product_descriptions":{"type":"array","items":{"type":"string"}},"record":{"type":"string","description":"The unique identifier for a record in the database"}},"required":["id","type","buyer","supplier","arrival_country","departure_country","transit_country","countries","product_origin","monetary_value","weight","identifier","sources","hs_codes","product_descriptions","record"],"title":"Shipment"},"trade_ShipmentSearchResponse":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/trade_Shipment"}}},"required":["limit","size","offset","next","data"],"description":"OK","title":"ShipmentSearchResponse"},"trade_hsCode":{"type":"object","properties":{"key":{"type":"string"},"doc_count":{"type":"integer"},"value":{"type":"string"},"value_simple":{"type":"string"}},"required":["key","doc_count","value"],"title":"hsCode"},"trade_SupplierMetadata":{"type":"object","properties":{"latestShipmentDate":{"type":"string"},"shipments":{"type":"integer"},"hsCodes":{"type":"array","items":{"$ref":"#/components/schemas/trade_hsCode"}}},"required":["shipments","hsCodes"],"title":"SupplierMetadata"},"trade_SupplierOrBuyer":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the entity"},"label":{"type":"string","description":"Display name of the entity"},"degree":{"type":"integer","description":"Number of outgoing relationships"},"closed":{"type":"boolean","description":"True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation."},"entity_url":{"type":"string","description":"Convenience URL to the entity in the API."},"pep":{"type":"boolean","description":"True if the entity has the [\"Politically Exposed Person (PEP)\" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false."},"psa_id":{"type":"string"},"psa_count":{"type":"integer","description":"Number of entities that are Possibly the Same As (PSA) the entity."},"sanctioned":{"type":"boolean","description":"True if the entity has the [\"Sanctioned\" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false."},"type":{"$ref":"#/components/schemas/generatedTypes_Entities","description":"The [entity type](/sayari-library/ontology/entities)."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_Identifier"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"},"description":"Entity [country](/sayari-library/ontology/enumerated-types#country)"},"source_count":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/sharedTypes_SourceCountInfo"},"description":"Number of records associated with the entity, grouped by source."},"addresses":{"type":"array","items":{"type":"string"},"description":"List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)"},"trade_count":{"type":"object","additionalProperties":{"type":"integer"}},"date_of_birth":{"type":"string","description":"Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)"},"relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"user_relationship_count":{"$ref":"#/components/schemas/sharedTypes_RelationshipCount"},"attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_count":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"user_attribute_counts":{"type":"object","additionalProperties":{"type":"integer"},"description":"Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)"},"related_entities_count":{"type":"integer"},"user_related_entities_count":{"type":"integer"},"user_record_count":{"type":"integer"},"reference_id":{"type":"string"},"logistics_entity":{"type":"boolean"},"registration_date":{"$ref":"#/components/schemas/sharedTypes_EntityRegistrationDate"},"translated_label":{"$ref":"#/components/schemas/sharedTypes_EntityTranslatedLabel"},"hs_code":{"$ref":"#/components/schemas/sharedTypes_EntityHSCode"},"shipment_arrival":{"$ref":"#/components/schemas/sharedTypes_ShipmentArrival"},"shipment_departure":{"$ref":"#/components/schemas/sharedTypes_ShipmentDeparture"},"company_type":{"$ref":"#/components/schemas/sharedTypes_CompanyType"},"latest_status":{"$ref":"#/components/schemas/sharedTypes_Status"},"risk":{"$ref":"#/components/schemas/sharedTypes_EntityRisk","description":"[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity."},"attributes":{"$ref":"#/components/schemas/generatedTypes_AttributeDetails","description":"Detailed information about the entity's [attributes](/sayari-library/ontology/attributes)."},"relationships":{"$ref":"#/components/schemas/sharedTypes_EntityRelationships","description":"Detailed information about the entity's [relationships](/sayari-library/ontology/relationships)."},"possibly_same_as":{"$ref":"#/components/schemas/sharedTypes_PossiblySameAs"},"referenced_by":{"$ref":"#/components/schemas/sharedTypes_ReferencedBy"},"metadata":{"$ref":"#/components/schemas/trade_SupplierMetadata"}},"required":["id","label","degree","closed","entity_url","pep","psa_count","sanctioned","type","identifiers","countries","source_count","addresses","trade_count","relationship_count","user_relationship_count","attribute_count","user_attribute_count","related_entities_count","user_related_entities_count","user_record_count","risk","metadata"],"title":"SupplierOrBuyer"},"trade_SupplierSearchResponse":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/trade_SupplierOrBuyer"}}},"required":["limit","size","offset","next","data"],"description":"OK","title":"SupplierSearchResponse"},"trade_BuyerSearchResponse":{"type":"object","properties":{"limit":{"type":"integer"},"size":{"$ref":"#/components/schemas/baseTypes_QualifiedCount"},"offset":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/trade_SupplierOrBuyer"}}},"required":["limit","size","offset","next","data"],"description":"OK","title":"BuyerSearchResponse"},"traversal_TraversalRelationshipData":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/sharedTypes_RelationshipInfo"}},"former":{"type":"boolean"},"start_date":{"type":"string"},"last_observed":{"type":"string"},"end_date":{"type":"string"}},"required":["values"],"title":"TraversalRelationshipData"},"traversal_TraversalPath":{"type":"object","properties":{"field":{"type":"string"},"entity":{"$ref":"#/components/schemas/sharedTypes_EntityDetails"},"relationships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/traversal_TraversalRelationshipData"}}},"required":["field","entity","relationships"],"title":"TraversalPath"},"traversal_TraversalData":{"type":"object","properties":{"source":{"type":"string"},"target":{"$ref":"#/components/schemas/sharedTypes_EntityDetails"},"path":{"type":"array","items":{"$ref":"#/components/schemas/traversal_TraversalPath"}}},"required":["source","target","path"],"title":"TraversalData"},"traversal_TraversalResponse":{"type":"object","properties":{"min_depth":{"type":"integer"},"max_depth":{"type":"integer"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Relationships"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_Country"}},"types":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"psa":{"type":"boolean"},"offset":{"type":"integer"},"limit":{"type":"integer"},"next":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/traversal_TraversalData"}},"sanctioned":{"type":"boolean"},"pep":{"type":"boolean"},"explored_count":{"type":"integer"},"partial_results":{"type":"boolean"}},"required":["min_depth","max_depth","relationships","countries","types","name","psa","offset","limit","next","data","explored_count","partial_results"],"description":"OK","title":"TraversalResponse"},"traversal_TraversalRiskCategory":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/generatedTypes_RiskCategory"}},{"type":"string"}],"title":"TraversalRiskCategory"},"traversal_ShortestPathData":{"type":"object","properties":{"source":{"type":"string"},"target":{"$ref":"#/components/schemas/sharedTypes_EntityDetails"},"path":{"type":"array","items":{"$ref":"#/components/schemas/traversal_TraversalPath"}}},"required":["source","target","path"],"title":"ShortestPathData"},"traversal_ShortestPathResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/traversal_ShortestPathData"}}},"required":["entities","data"],"description":"OK","title":"ShortestPathResponse"},"metadata_UserInfo":{"type":"object","properties":{"id":{"type":"string","description":"Currently logged in user ID"},"groupDisplayNames":{"type":"string","description":"Name of the sayari organization tied to credentials"},"roles":{"type":"string","description":"Licenses associated with the organization"}},"required":["id"],"title":"UserInfo"},"metadata_MetadataResponse":{"type":"object","properties":{"version":{"type":"string","description":"Currently deployed version of the application."},"master_release":{"type":"string","description":"Currently deployed main data release."},"watchlist_release":{"type":"string","description":"Currently deployed watchlist release."},"user":{"$ref":"#/components/schemas/metadata_UserInfo"}},"required":["version","master_release","watchlist_release","user"],"title":"MetadataResponse"},"projectEntityAttributes_ProjectEntityAttributeValue":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}},"required":["id","value"],"title":"ProjectEntityAttributeValue"},"projectEntityAttributes_ProjectEntityAttribute":{"type":"object","properties":{"field":{"type":"string"},"match_resolution":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/projectEntityAttributes_ProjectEntityAttributeValue"}}},"required":["field","match_resolution","values"],"title":"ProjectEntityAttribute"},"projectEntityAttributes_ProjectEntityAttributesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/projectEntityAttributes_ProjectEntityAttribute"}}},"required":["data"],"title":"ProjectEntityAttributesResponse"},"projectEntityAttributes_CreateProjectEntityAttributeRequest":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"match_resolution":{"type":"boolean"}},"required":["field","value","match_resolution"],"title":"CreateProjectEntityAttributeRequest"},"projectEntityAttributes_CreateProjectEntityAttributeResponseData":{"type":"object","properties":{"id":{"type":"string"},"field":{"type":"string"},"value":{"type":"string"},"match_resolution":{"type":"boolean"}},"required":["id","field","value","match_resolution"],"title":"CreateProjectEntityAttributeResponseData"},"projectEntityAttributes_CreateProjectEntityAttributeResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/projectEntityAttributes_CreateProjectEntityAttributeResponseData"}},"required":["data"],"title":"CreateProjectEntityAttributeResponse"},"projectEntityAttributes_UpdateProjectEntityAttributeRequest":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"match_resolution":{"type":"boolean"}},"required":["field","value","match_resolution"],"title":"UpdateProjectEntityAttributeRequest"},"projectEntityAttributes_UpdateProjectEntityAttributeResponseData":{"type":"object","properties":{"id":{"type":"string"},"field":{"type":"string"},"value":{"type":"string"},"match_resolution":{"type":"boolean"}},"required":["id","field","value","match_resolution"],"title":"UpdateProjectEntityAttributeResponseData"},"projectEntityAttributes_UpdateProjectEntityAttributeResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/projectEntityAttributes_UpdateProjectEntityAttributeResponseData"}},"required":["data"],"title":"UpdateProjectEntityAttributeResponse"},"projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotData":{"type":"object","properties":{"snapshot_id":{"type":"string"},"label":{"type":"string"},"release_tag":{"type":"string"},"partial_results":{"type":"boolean"},"explored_count":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["snapshot_id","label","release_tag","partial_results","explored_count","created_at","updated_at"],"title":"ProjectEntitySupplyChainSnapshotData"},"projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotData"}}},"required":["data"],"title":"ProjectEntitySupplyChainSnapshotsResponse"},"projectEntitySupplyChainSnapshots_SupplyChainNode":{"type":"object","properties":{"id":{"type":"string"},"entity_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"risk_factors":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}}},"required":["id","entity_id","label","type","risk_factors","countries"],"title":"SupplyChainNode"},"projectEntitySupplyChainSnapshots_SupplyChainEdge":{"type":"object","properties":{"id":{"type":"string"},"src_id":{"type":"string"},"dst_id":{"type":"string"},"departure_countries":{"type":"array","items":{"type":"string"}},"arrival_countries":{"type":"array","items":{"type":"string"}},"hs_code":{"type":"string"},"min_date":{"type":"string"},"max_date":{"type":"string"}},"required":["id","src_id","dst_id","departure_countries","arrival_countries","hs_code","min_date","max_date"],"title":"SupplyChainEdge"},"projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotDetailData":{"type":"object","properties":{"snapshot_id":{"type":"string"},"label":{"type":"string"},"release_tag":{"type":"string"},"partial_results":{"type":"boolean"},"explored_count":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_SupplyChainNode"}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_SupplyChainEdge"}}},"required":["snapshot_id","label","release_tag","partial_results","explored_count","created_at","updated_at","nodes","edges"],"title":"ProjectEntitySupplyChainSnapshotDetailData"},"projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotByIdResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/projectEntitySupplyChainSnapshots_ProjectEntitySupplyChainSnapshotDetailData"}},"required":["data"],"title":"ProjectEntitySupplyChainSnapshotByIdResponse"},"projectEntitySupplyChainSnapshots_CreateProjectEntitySupplyChainSnapshotRequest":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"],"title":"CreateProjectEntitySupplyChainSnapshotRequest"},"projectEntitySupplyChainSnapshots_CreateProjectEntitySupplyChainSnapshotResponse":{"type":"object","properties":{"snapshot_id":{"type":"string"}},"required":["snapshot_id"],"title":"CreateProjectEntitySupplyChainSnapshotResponse"}},"securitySchemes":{"OAuthScheme":{"type":"http","scheme":"bearer","description":"OAuth 2.0 authentication"}}}}