Skip to main content
GET
/
v1
/
proponent-forensics
List proponent risk analyses
curl --request GET \
  --url https://vcm-fyi-api.fly.dev/v1/proponent-forensics/ \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "total_entries": 123,
    "current_page": 123,
    "total_pages": 123,
    "next_page": "<string>"
  },
  "data": [
    {
      "id": 123,
      "proponent_key": "<string>",
      "lookup_type": "<string>",
      "proponent_names": "<string>",
      "project_ids": "<string>",
      "project_count": 123,
      "total_issued": 123,
      "countries": "<string>",
      "registries": "<string>",
      "run_date": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "overall_risk_rating": "<string>",
      "investment_recommendation": "<string>",
      "governance_risk": "<string>",
      "financial_risk": "<string>",
      "legal_risk": "<string>",
      "social_risk": "<string>",
      "institutional_risk": "<string>",
      "pillars_json": "<string>",
      "primary_concern": "<string>",
      "key_mitigation": "<string>",
      "comparable_proponents": "<string>",
      "raw_json": "<string>",
      "error_type": "<string>",
      "error_message": "<string>"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

proponent_key
string | null

Filter by proponent key

risk_rating
string | null

Filter by overall risk rating (LOW, MEDIUM, HIGH, CRITICAL)

recommendation
string | null

Filter by investment recommendation

country
string | null

Filter by country (in countries array)

registry
string | null

Filter by registry (in registries array)

min_issued
integer | null

Minimum total issued credits

status
string | null

Filter by status (success, partial, failed)

current_page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:100

Items per page

Required range: 1 <= x <= 200
sort
string[]

Sorting: field_name or +field_name (asc), -field_name (desc)

Response

Paginated list of proponent risk analyses with pillar scores

Paginated response for proponent forensics.

pagination
Pagination · object
required
data
ProponentForensicsResponse · object
required

Response model for proponent forensics endpoint.