ESG

ESG Case

Get properties of an ESG case by its id

GET
https://api.textreveal.com/v3/esg/cases/{case_id}

Request

Parameters

  • case_id*uuid

    Unique identifier of the case

  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "categories", "entity_id", "dashboard_url", "last_activity", "score", "start_date", "sub_categories", "summary", "title", "related_events_count", "related_documents_count", "translated_title", "translated_summary"]Values: "id", "categories", "entity_id", "dashboard_url", "last_activity", "score", "start_date", "sub_categories", "summary", "title", "related_events_count", "related_documents_count", "ungc_classification", "ungc_principles", "translated_title", "translated_summary"
  • translatelanguage-code

    In which language to translate the results.

    Default translated fields are: title, summary.

    If empty, translated_ fields won't be returned.

    Example: french

Response

Response - 200

Properties of the case

  • iduuid

    Unique identifier of the case.

    Example: "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"
  • categories(string (enum))[]

    List of categories assigned to the case.

    Values: "E", "S", "G"
  • entity_iduuid

    Permanent ID of the related entity.

    Example: "f337e172-528e-4808-b46e-be1ad6db7fbb"
  • dashboard_urluri | null

    Link to the case in SESAMm's Dashboard.

    Example: "https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"
  • last_activitydate-time

    Last activity detected on the case. Corresponds to the date of the newest document associated to the case.

    Example: "2025-11-07T08:35:37.658Z"
  • scoreinteger

    Intensity score.

    Range: [1, 5]
  • start_datedate-time

    Case start date. Corresponds to the date of the oldest document associated to the case.

    Example: "2025-10-06T04:55:21.713Z"
  • sub_categoriesstring[]

    List of sub-categories assigned to the case.

    Example: ["Climate Change"]
  • summarystring | null

    Summary of the case.

    Example: "string"
  • titlestring

    Title of the case.

    Example: "string"
  • ungc_classificationstring | null (enum)

    Maximum UNGC classification of the events related to the case.

    Values: "violator", "watchlist", "low risk"
  • ungc_principles(string (enum))[]

    List of UNGC principles of the events related to the case.

    Values: "Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.", "Principle 2: Businesses should make sure that they are not complicit in human rights abuses.", "Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.", "Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.", "Principle 5: Businesses should uphold the effective abolition of child labour.", "Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.", "Principle 7: Businesses should support a precautionary approach to environmental challenges.", "Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.", "Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.", "Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."
  • translated_titlestring | null

    Translated version of title field. See translate query parameter.

    Example: "string"
  • translated_summarystring | null

    Translated version of summary field. See translate query parameter.

    Example: "string"
Response
{
  "id": "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9",
  "categories": [
    "E"
  ],
  "entity_id": "f337e172-528e-4808-b46e-be1ad6db7fbb",
  "dashboard_url": "https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9",
  "last_activity": "2025-11-07T08:35:37.658Z",
  "score": 2,
  "start_date": "2025-10-06T04:55:21.713Z",
  "sub_categories": [
    "Climate Change",
    "Water Pollution"
  ],
  "summary": "string",
  "title": "string",
  "related_events_count": 8,
  "related_documents_count": 43,
  "ungc_classification": "violator",
  "ungc_principles": [
    "Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.",
    "Principle 2: Businesses should make sure that they are not complicit in human rights abuses."
  ],
  "translated_title": "string",
  "translated_summary": "string"
}