get https://api.clarity.ai/clarity/v1/api/v1/company-brief/linkout/
Redirects to a widget URL using Base64 encoded JSON containing token, ISIN, and language (equity only AND certain companies covered by the reports).
JSON Structure
The Base64 encoded JSON should contain:
{
"token": "jwt_token",
"isin": "ISIN_CODE",
"lang": "en-US",
"modules": ["ESG_RISK", "CONTROVERSIES"]
}
Authentication Token
How to get JWT token:
- API Login: POST
/oauth/token
with API key/secret credentials - The token is returned in the response under the
token
field - Include the token in the
Authorization: Bearer <token>
header for authenticated requests
Valid ISINs (equity only and certain companies covered by the reports)
Requirements:
- Equity securities only - Only equity instruments (EQUITY type) are supported
- Company coverage - The company must be covered by our ESG Risk assessment reports
Coverage Requirements:
- The ISIN must be mapped to a valid organization ID in our system
- The company must be covered by our ESG Risk assessment
- Non-equity securities and uncovered companies will return 404 errors
Language Support
Supported Language Codes:
en
- English (generic)en-US
- English (United States)de
- German (generic)de-DE
- German (Germany)de-CH
- German (Switzerland)es
- Spanish (generic)es-ES
- Spanish (Spain)fr
- French (generic)fr-FR
- French (France)
Modules Support
Available Module Types:
ESG_RISK
- ESG Risk assessment moduleCONTROVERSIES
- Controversies and incidents moduleCLIMATE
- Climate and carbon footprint module
Module Array Requirements:
- Optional parameter - can be omitted entirely
- If provided, must be an array of strings
- Empty arrays or arrays with only empty strings are treated as no modules specified
- Order of modules is preserved in the final request