The ESG Commitments API returns a paginated envelope, carrying a list of commitment objects in result.
The response envelope
Returned by both Retrieve ESG commitments and, in reduced form, by Get ESG commitments status.
| Field name (key) | Type | Description |
|---|---|---|
| veridion_id | string | The company identifier from the request path. |
| status | string | The state of the request. One of complete, processing, or not_found. See Retrieve ESG commitments for what each value means and how to respond to it. |
| active_processing_session | string | UUID of the session currently collecting data for this company. Present only while status is processing, and null in every other state. Pass it to ESG processing status. |
| last_computed_at | string | The UTC date and time when the most recent completed collection for this company finished, as an ISO 8601 datetime. Independent of your filters and paging: it describes when the data was produced, not which slice you are viewing. |
| result_count | integer | Total number of commitment rows matching your filters across the whole result set. Not limited to the current page, and not reduced by max_results. |
| result | object array | The commitment rows on the current page. An empty array when nothing has been collected for the company yet. |
| next_cursor | string | Opaque token identifying the next page. Pass it back as cursor to continue. null on the last page. |
| has_more | boolean | Whether more rows match beyond the current page. |
The commitment object
One object per commitment and risk criterion pair, returned as each item of result.
| Field name (key) | Type | Description |
|---|---|---|
| source_url | string | URL of the page the commitment was extracted from, on the company's own web presence. |
| headline | string | Title or heading of the source page. It serves as a brief summary of the primary topic or focus of the content. |
| relevant_text | string | The commitments statement, verbatim, in the original language of the source page. |
| esg_pillar | string | Top level ESG classification. One of Environmental, Social, or Governance. |
| esg_theme | string | The ESG theme within the pillar. See ESG risk taxonomy for the full set of values. |
| esg_risk_criteria | string | The specific risk criterion within the theme, one of the 26 in Veridion's ESG taxonomy. |