ERIP
API ReferencePublicCompanies

/v1/Companies/{companyId}/detail

GET/v1/Companies/{companyId}/detail

Authorization

ApiKey Bearer
X-Api-Key<token>

Provide your API key in the X-Api-Key header.

In: header

AuthorizationBearer <token>

Enter a JWT token obtained from /v1/auth/login.

In: header

Path Parameters

companyId*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/Companies/string/detail"
{
  "id": "string",
  "lei": "string",
  "name": "string",
  "countryCode": "string",
  "countryName": "string",
  "registrationNumber": "string",
  "jurisdictionSource": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "status": "Active",
  "industry": "Industrials",
  "revenueRange": "Micro",
  "incorporationDate": "2019-08-24",
  "fiscalYearEnd": "2019-08-24",
  "mostRecentQuarter": "2019-08-24",
  "addresses": [
    {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string",
      "isPrimary": true
    }
  ],
  "quarterlySnapshots": [
    {
      "quarterEnd": "2019-08-24",
      "currencyCode": "string",
      "revenue": 0,
      "ebitda": 0,
      "interestExpense": 0,
      "totalCash": 0,
      "totalDebt": 0,
      "currentAssets": 0,
      "currentLiabilities": 0,
      "accountsReceivable": 0,
      "cashStartOfQuarter": 0,
      "operatingCashFlow": 0,
      "leveredFreeCashFlow": 0,
      "capEx": 0,
      "principalRepayments": 0,
      "sharesOutstanding": 0,
      "interestCoverage": 0,
      "leverageRatio": 0,
      "currentRatio": 0,
      "averageMonthlyNetBurn": 0,
      "dscr": 0,
      "daysOutstanding": 0,
      "ebitdaMargin": 0,
      "cashRunwayMonths": 0
    }
  ],
  "ownerships": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "parentCompanyId": "string",
      "childCompanyId": "string",
      "ownershipPercentage": 0.1,
      "effectiveFrom": "2019-08-24T14:15:22Z",
      "effectiveTo": "2019-08-24T14:15:22Z"
    }
  ],
  "covenants": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "string",
      "covenantType": "FixedChargeCoverage",
      "description": "string",
      "thresholdDirection": "Minimum",
      "thresholdValue": 0.1,
      "status": "Compliant",
      "currentValue": 0,
      "lastTestedAt": "2019-08-24T14:15:22Z",
      "lenderName": "string",
      "facilityReference": "string",
      "effectiveFrom": "2019-08-24T14:15:22Z",
      "effectiveTo": "2019-08-24T14:15:22Z",
      "headroomPercent": 0
    }
  ],
  "events": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "string",
      "eventType": "FilingIngested",
      "occurredAt": "2019-08-24T14:15:22Z",
      "detectedAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "sourceReference": "string"
    }
  ],
  "riskSignals": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "string",
      "sourceReference": "string",
      "signalType": "CovenantBreach",
      "severity": "Low",
      "detectedAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "excerpt": "string",
      "confidenceScore": 0.1,
      "filingSection": "string",
      "modelVersion": "string"
    }
  ],
  "sentiments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "string",
      "source": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "series": [
        {
          "date": "2019-08-24",
          "value": 0.1,
          "description": "string"
        }
      ]
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}