Endpoints

Async Job - Request ESG Risk Organizations Scores

post
https://api.clarity.ai/clarity/v1/public/organizations/esg-risk/scores-by-id/async

This endpoint will make a request for an async job to retrieve Clarity.AI ESG Risk scores for given score ids.
You can request the whole scores universe or provide a list of permIds (see: permid.org).Please note: This call will only return the identifier (UUID) for this task. You'll need this value later on further calls to know the status of your job (see Async Job - Get job status) or download your file when ready (see «Async Job - Download result file»)
Check this document for a complete explanation of the flow for these Async jobs endpoints

Body Params
scoreIds
array of strings

Requested Score IDs

scoreIds
permIds
array of strings

List of organizations, identified by permId, to retrieve information from. If this parameter is not present, all available organizations will be returned

permIds
string

Standard Scoring profile ID used to calculate the ESG score, with universe of companies, materiality weights,
relevance threshold

boolean | null
Defaults to false

Include materiality weight for each score in the downloaded file.

Responses

Updated 5 minutes ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 minutes ago