Get a source-aware public/private company terminal

GET

https://api.sureshake.com/v2/entities/{id}/company-terminal

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- entityId
  string
  required
  format: uuid
- entityName
  string
  required
- entitySlug
  string
  required
- profileMode
  public_reference
  or
  private_company
  or
  unclassified_company
  required
- viewerScope
  public
  or
  granted
  or
  owner
  or
  admin
  required
- identity
  object
  required
  companyMarketStatus
  public
  or
  private
  or null
  required
  primaryExchange
  string
  or null
  required
  primaryTicker
  string
  or null
  required
  sureshakeTicker
  string
  or null
  required
  cik
  string
  or null
  required
  secName
  string
  or null
  required
  sic
  string
  or null
  required
  sicDescription
  string
  or null
  required
  fiscalYearEnd
  string
  or null
  required
  issuerStatus
  candidate
  or
  active
  or
  inactive
  or
  delisted
  or null
  required
  isActiveOperatingCompany
  boolean
  required
  listingStatus
  active
  or
  inactive
  or
  delisted
  or null
  required
  claimStatus
  string
  or null
  required
  referenceLabel
  string
  required
  regulationCategory
  optional
  exchange_listed
  or
  regulation_cf
  or null
- summary
  object
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  asOf
  string
  or null
  required
  metrics
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  state
  available
  or
  missing
  or
  permissioned
  or
  derived
  required
  value
  or null
  required
  Any of the following:
  number
  string
  boolean
  displayValue
  string
  or null
  required
  unit
  string
  or null
  required
  periodEnd
  string
  or null
  required
  deltaValue
  number
  or null
  required
  deltaDisplay
  string
  or null
  required
  source
  object
  or null
  required
  kind
  regulator
  or
  company
  or
  sureshake_report
  or
  derived
  or
  market_provider
  required
  provider
  string
  required
  label
  string
  required
  url
  string
  or null
  required
  format: uri
  accessedAt
  string
  or null
  required
  format: date-time
  accessionNumber
  optional
  string
  or null
  note
  optional
  string
  or null
  verificationStatus
  optional
  source_verified
  or
  asserted
  or
  computed
  or
  historical_verified
  explanation
  optional
  string
  or null
  highlights
  array of
  string
  required
  dataQualityLabel
  string
  required
  maskedMetrics
  optional
  array of
  object
  key
  string
  required
  label
  string
  required
  value
  object
  required
  masked
  true
  required
  source
  string
  required
  minLength: 1
  asOf
  string
  or null
  required
- financialHealth
  object
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  overallSignal
  great
  or
  good
  or
  watch
  or
  risk
  or
  unavailable
  required
  headline
  string
  required
  explanation
  string
  required
  signals
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  signal
  great
  or
  good
  or
  watch
  or
  risk
  or
  unavailable
  required
  grade
  A
  or
  B
  or
  C
  or
  D
  or
  F
  or null
  required
  headline
  string
  required
  explanation
  string
  required
  metricKeys
  array of
  string
  required
- financials
  object
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  periods
  array of
  object
  required
  id
  string
  required
  format: uuid
  fiscalYear
  integer
  or null
  required
  fiscalPeriod
  string
  required
  baseForm
  string
  required
  periodStart
  string
  or null
  required
  periodEnd
  string
  required
  filedDate
  string
  required
  currency
  string
  required
  sourceAccessionNumber
  string
  required
  sourceUrl
  string
  required
  format: uri
  revision
  integer
  required
  minimum: 0
  coveragePercent
  number
  required
  maximum: 100 · minimum: 0
  incomeStatement
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  displayValue
  string
  or null
  required
  value
  number
  or null
  required
  unit
  string
  or null
  required
  sourceConcept
  string
  or null
  required
  balanceSheet
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  displayValue
  string
  or null
  required
  value
  number
  or null
  required
  unit
  string
  or null
  required
  sourceConcept
  string
  or null
  required
  cashFlowStatement
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  displayValue
  string
  or null
  required
  value
  number
  or null
  required
  unit
  string
  or null
  required
  sourceConcept
  string
  or null
  required
  derivedMetrics
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  displayValue
  string
  or null
  required
  value
  number
  or null
  required
  unit
  string
  or null
  required
  sourceConcept
  string
  or null
  required
  warnings
  array of
  string
  required
  unavailableReason
  string
  or null
  required
- filings
  object
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  latestAnnualFiledAt
  string
  or null
  required
  latestQuarterlyFiledAt
  string
  or null
  required
  rows
  array of
  object
  required
  id
  string
  required
  format: uuid
  form
  string
  required
  baseForm
  string
  required
  filingDate
  string
  required
  reportDate
  string
  or null
  required
  accessionNumber
  string
  required
  filingIndexUrl
  string
  required
  format: uri
  primaryDocumentUrl
  string
  or null
  required
  format: uri
  isAmendment
  boolean
  required
  amendsAccessionNumber
  string
  or null
  required
  status
  active
  or
  superseded
  or
  withdrawn
  required
  description
  string
  or null
  required
- models
  object
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  templates
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  description
  string
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  requiredMetricKeys
  array of
  string
  required
  missingMetricKeys
  array of
  string
  required
  prefilledMetricKeys
  array of
  string
  required
  disclaimer
  string
  required
- marketData
  object
  required
  state
  not_configured
  or
  available
  or
  unavailable
  required
  reason
  string
  or null
  required
  quote
  object
  or null
  required
  price
  number
  required
  currency
  string
  required
  change
  number
  or null
  required
  changePercent
  number
  or null
  required
  previousClose
  number
  or null
  required
  dayHigh
  number
  or null
  required
  dayLow
  number
  or null
  required
  fiftyTwoWeekHigh
  number
  or null
  required
  fiftyTwoWeekLow
  number
  or null
  required
  beta
  number
  or null
  required
  sharesOutstanding
  number
  or null
  required
  marketCapitalization
  number
  or null
  required
  asOf
  string
  required
  fetchedAt
  string
  required
  format: date-time
  stale
  boolean
  required
  delayed
  boolean
  required
  source
  object
  required
  provider
  string
  required
  attribution
  string
  required
  history
  object
  required
  state
  not_configured
  or
  available
  or
  unavailable
  required
  reason
  string
  or null
  required
  points
  array of
  object
  required
  date
  string
  required
  close
  number
  required
  adjustedClose
  number
  or null
  required
  volume
  number
  or null
  required
  asOf
  string
  or null
  required
  source
  object
  or null
  required
  provider
  string
  required
  attribution
  string
  required
  metrics
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  state
  available
  or
  missing
  or
  permissioned
  or
  derived
  required
  value
  or null
  required
  Any of the following:
  number
  string
  boolean
  displayValue
  string
  or null
  required
  unit
  string
  or null
  required
  periodEnd
  string
  or null
  required
  deltaValue
  number
  or null
  required
  deltaDisplay
  string
  or null
  required
  source
  object
  or null
  required
  kind
  regulator
  or
  company
  or
  sureshake_report
  or
  derived
  or
  market_provider
  required
  provider
  string
  required
  label
  string
  required
  url
  string
  or null
  required
  format: uri
  accessedAt
  string
  or null
  required
  format: date-time
  accessionNumber
  optional
  string
  or null
  note
  optional
  string
  or null
  verificationStatus
  optional
  source_verified
  or
  asserted
  or
  computed
  or
  historical_verified
  explanation
  optional
  string
  or null
- peerBenchmarks
  object
  required
  state
  available
  or
  locked
  or
  unavailable
  required
  reason
  string
  or null
  required
  peerSet
  object
  or null
  required
  name
  string
  required
  version
  integer
  required
  minimum: 0
  methodology
  string
  required
  constituentCount
  integer
  required
  minimum: 0
  asOf
  string
  or null
  required
  format: date-time
  categories
  array of
  object
  required
  key
  quote
  or
  value
  or
  size
  or
  growth
  or
  profit
  required
  label
  string
  required
  metrics
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  unit
  string
  required
  companyValue
  number
  or null
  required
  companyDisplay
  string
  or null
  required
  peersValue
  number
  or null
  required
  peersDisplay
  string
  or null
  required
  sectorValue
  number
  or null
  required
  sectorDisplay
  string
  or null
  required
  source
  object
  or null
  required
  kind
  regulator
  or
  company
  or
  sureshake_report
  or
  derived
  or
  market_provider
  required
  provider
  string
  required
  label
  string
  required
  url
  string
  or null
  required
  format: uri
  accessedAt
  string
  or null
  required
  format: date-time
  accessionNumber
  optional
  string
  or null
  note
  optional
  string
  or null
  verificationStatus
  optional
  source_verified
  or
  asserted
  or
  computed
  or
  historical_verified
- transparencyLadder
  object
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  currentStage
  profile
  or
  source_connected
  or
  verified_report
  or
  reporting_history
  or
  benchmark_ready
  or null
  required
  score
  number
  or null
  required
  maximum: 100 · minimum: 0
  steps
  array of
  object
  required
  key
  profile
  or
  source_connected
  or
  verified_report
  or
  reporting_history
  or
  benchmark_ready
  required
  label
  string
  required
  description
  string
  required
  state
  complete
  or
  current
  or
  next
  or
  locked
  or
  private
  required
  completedAt
  string
  or null
  required
  format: date-time
  actionLabel
  string
  or null
  required
  actionPath
  string
  or null
  required
  nextAction
  string
  or null
  required
- modules
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  description
  string
  required
  reason
  string
  or null
  required
- sources
  array of
  object
  required
  kind
  regulator
  or
  company
  or
  sureshake_report
  or
  derived
  or
  market_provider
  required
  provider
  string
  required
  label
  string
  required
  url
  string
  or null
  required
  format: uri
  accessedAt
  string
  or null
  required
  format: date-time
  accessionNumber
  optional
  string
  or null
  note
  optional
  string
  or null
  verificationStatus
  optional
  source_verified
  or
  asserted
  or
  computed
  or
  historical_verified
- generatedAt
  string
  required
  format: date-time
- disclaimer
  string
  required
- trust
  optional
  object
  state
  sec_filed_reference
  or
  sureshake_verified
  or
  managed_unverified
  or
  reference_profile
  or
  verification_lapsed
  required
  reportingCadence
  monthly
  or
  quarterly
  or
  annual
  or null
  required
  lastVerifiedAt
  string
  or null
  required
  lapseReason
  stale
  or
  connection_failed
  or
  connection_revoked
  or null
  required
  currentMetricVerification
  source_verified
  or
  asserted
  required
  historicalReportsRemainVerified
  true
  required
  secFiled
  boolean
  required
- pageTabs
  optional
  array of
  object
  key
  string
  required
  minLength: 1
  label
  string
  required
  minLength: 1
  type
  system
  or
  composable
  required
  state
  open
  or
  locked
  required
  position
  integer
  required
  minimum: 0
  requestTarget
  optional
  object
  type
  tab
  required
  entityId
  string
  required
  format: uuid
  pageTabId
  string
  required
  format: uuid
- documents
  optional
  object
  reports
  array of
  object
  required
  id
  string
  required
  format: uuid
  title
  string
  required
  description
  string
  or null
  required
  kind
  report
  or
  update
  or
  document
  required
  periodEnd
  string
  or null
  required
  updatedAt
  string
  required
  verified
  boolean
  required
  access
  public
  or
  shared
  or
  private
  required
  publications
  array of
  object
  required
  id
  string
  required
  format: uuid
  title
  string
  required
  description
  string
  or null
  required
  kind
  report
  or
  update
  or
  document
  required
  periodEnd
  string
  or null
  required
  updatedAt
  string
  required
  verified
  boolean
  required
  access
  public
  or
  shared
  or
  private
  required
- dividends
  optional
  object
  state
  available
  or
  partial
  or
  permissioned
  or
  locked
  or
  unavailable
  or
  not_applicable
  required
  cadence
  quarterly
  or
  semiannual
  or
  annual
  or
  irregular
  or
  none
  or null
  required
  metrics
  array of
  object
  required
  key
  string
  required
  label
  string
  required
  state
  available
  or
  missing
  or
  permissioned
  or
  derived
  required
  value
  or null
  required
  Any of the following:
  number
  string
  boolean
  displayValue
  string
  or null
  required
  unit
  string
  or null
  required
  periodEnd
  string
  or null
  required
  deltaValue
  number
  or null
  required
  deltaDisplay
  string
  or null
  required
  source
  object
  or null
  required
  kind
  regulator
  or
  company
  or
  sureshake_report
  or
  derived
  or
  market_provider
  required
  provider
  string
  required
  label
  string
  required
  url
  string
  or null
  required
  format: uri
  accessedAt
  string
  or null
  required
  format: date-time
  accessionNumber
  optional
  string
  or null
  note
  optional
  string
  or null
  verificationStatus
  optional
  source_verified
  or
  asserted
  or
  computed
  or
  historical_verified
  explanation
  optional
  string
  or null
  rows
  array of
  object
  required
  periodId
  string
  required
  format: uuid
  fiscalYear
  integer
  or null
  required
  fiscalPeriod
  string
  required
  baseForm
  string
  required
  periodEnd
  string
  required
  filedDate
  string
  required
  currency
  string
  required
  perShareDeclared
  number
  or null
  required
  perSharePaid
  number
  or null
  required
  totalCashPaid
  number
  or null
  required
  sourceAccessionNumber
  string
  required
  sourceUrl
  string
  required
  format: uri
  unavailableReason
  string
  or null
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": { "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "entityName": "string", "entitySlug": "string", "profileMode": "public_reference", "viewerScope": "public", "trust": { "state": "sec_filed_reference", "reportingCadence": "monthly", "lastVerifiedAt": "string", "lapseReason": "stale", "currentMetricVerification": "source_verified", "historicalReportsRemainVerified": true, "secFiled": true }, "pageTabs": [ { "key": "string", "label": "string", "type": "system", "state": "open", "position": 0, "requestTarget": { "type": "tab", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "pageTabId": "af46ed88-e486-4d9f-a1f6-5c67cf59e571" } } ], "documents": { "reports": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "kind": "report", "periodEnd": "string", "updatedAt": "string", "verified": true, "access": "public" } ], "publications": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "kind": "report", "periodEnd": "string", "updatedAt": "string", "verified": true, "access": "public" } ] }, "identity": { "companyMarketStatus": "public", "primaryExchange": "string", "primaryTicker": "string", "sureshakeTicker": "string", "cik": "string", "secName": "string", "sic": "string", "sicDescription": "string", "fiscalYearEnd": "string", "issuerStatus": "candidate", "regulationCategory": "exchange_listed", "isActiveOperatingCompany": true, "listingStatus": "active", "claimStatus": "string", "referenceLabel": "string" }, "summary": { "state": "available", "asOf": "string", "metrics": [ { "key": "string", "label": "string", "state": "available", "value": 0, "displayValue": "string", "unit": "string", "periodEnd": "string", "deltaValue": 0, "deltaDisplay": "string", "source": { "kind": "regulator", "provider": "string", "label": "string", "url": "http://example.com", "accessedAt": "2019-08-24T14:15:22Z", "accessionNumber": "string", "note": "string", "verificationStatus": "source_verified" }, "explanation": "string" } ], "maskedMetrics": [ { "key": "string", "label": "string", "value": { "masked": true, "source": "string", "asOf": "string" } } ], "highlights": [ "string" ], "dataQualityLabel": "string" }, "financialHealth": { "state": "available", "overallSignal": "great", "headline": "string", "explanation": "string", "signals": [ { "key": "string", "label": "string", "signal": "great", "grade": "A", "headline": "string", "explanation": "string", "metricKeys": [ "string" ] } ] }, "financials": { "state": "available", "periods": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fiscalYear": 0, "fiscalPeriod": "string", "baseForm": "string", "periodStart": "string", "periodEnd": "string", "filedDate": "string", "currency": "string", "sourceAccessionNumber": "string", "sourceUrl": "http://example.com", "revision": 0, "coveragePercent": 100, "incomeStatement": [ { "key": "string", "label": "string", "displayValue": "string", "value": 0, "unit": "string", "sourceConcept": "string" } ], "balanceSheet": [ { "key": "string", "label": "string", "displayValue": "string", "value": 0, "unit": "string", "sourceConcept": "string" } ], "cashFlowStatement": [ { "key": "string", "label": "string", "displayValue": "string", "value": 0, "unit": "string", "sourceConcept": "string" } ], "derivedMetrics": [ { "key": "string", "label": "string", "displayValue": "string", "value": 0, "unit": "string", "sourceConcept": "string" } ], "warnings": [ "string" ] } ], "unavailableReason": "string" }, "filings": { "state": "available", "latestAnnualFiledAt": "string", "latestQuarterlyFiledAt": "string", "rows": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "form": "string", "baseForm": "string", "filingDate": "string", "reportDate": "string", "accessionNumber": "string", "filingIndexUrl": "http://example.com", "primaryDocumentUrl": "http://example.com", "isAmendment": true, "amendsAccessionNumber": "string", "status": "active", "description": "string" } ] }, "dividends": { "state": "available", "cadence": "quarterly", "metrics": [ { "key": "string", "label": "string", "state": "available", "value": 0, "displayValue": "string", "unit": "string", "periodEnd": "string", "deltaValue": 0, "deltaDisplay": "string", "source": { "kind": "regulator", "provider": "string", "label": "string", "url": "http://example.com", "accessedAt": "2019-08-24T14:15:22Z", "accessionNumber": "string", "note": "string", "verificationStatus": "source_verified" }, "explanation": "string" } ], "rows": [ { "periodId": "7cc85576-6d6b-4609-a8e6-020187b27a09", "fiscalYear": 0, "fiscalPeriod": "string", "baseForm": "string", "periodEnd": "string", "filedDate": "string", "currency": "string", "perShareDeclared": 0, "perSharePaid": 0, "totalCashPaid": 0, "sourceAccessionNumber": "string", "sourceUrl": "http://example.com" } ], "unavailableReason": "string" }, "models": { "state": "available", "templates": [ { "key": "string", "label": "string", "description": "string", "state": "available", "requiredMetricKeys": [ "string" ], "missingMetricKeys": [ "string" ], "prefilledMetricKeys": [ "string" ], "disclaimer": "string" } ] }, "marketData": { "state": "not_configured", "reason": "string", "quote": { "price": 0, "currency": "string", "change": 0, "changePercent": 0, "previousClose": 0, "dayHigh": 0, "dayLow": 0, "fiftyTwoWeekHigh": 0, "fiftyTwoWeekLow": 0, "beta": 0, "sharesOutstanding": 0, "marketCapitalization": 0, "asOf": "string", "fetchedAt": "2019-08-24T14:15:22Z", "stale": true, "delayed": true, "source": { "provider": "string", "attribution": "string" } }, "history": { "state": "not_configured", "reason": "string", "points": [ { "date": "string", "close": 0, "adjustedClose": 0, "volume": 0 } ], "asOf": "string", "source": { "provider": "string", "attribution": "string" } }, "metrics": [ { "key": "string", "label": "string", "state": "available", "value": 0, "displayValue": "string", "unit": "string", "periodEnd": "string", "deltaValue": 0, "deltaDisplay": "string", "source": { "kind": "regulator", "provider": "string", "label": "string", "url": "http://example.com", "accessedAt": "2019-08-24T14:15:22Z", "accessionNumber": "string", "note": "string", "verificationStatus": "source_verified" }, "explanation": "string" } ] }, "peerBenchmarks": { "state": "available", "reason": "string", "peerSet": { "name": "string", "version": 0, "methodology": "string", "constituentCount": 0 }, "asOf": "2019-08-24T14:15:22Z", "categories": [ { "key": "quote", "label": "string", "metrics": [ { "key": "string", "label": "string", "unit": "string", "companyValue": 0, "companyDisplay": "string", "peersValue": 0, "peersDisplay": "string", "sectorValue": 0, "sectorDisplay": "string" } ] } ], "source": { "kind": "regulator", "provider": "string", "label": "string", "url": "http://example.com", "accessedAt": "2019-08-24T14:15:22Z", "accessionNumber": "string", "note": "string", "verificationStatus": "source_verified" } }, "transparencyLadder": { "state": "available", "currentStage": "profile", "score": 100, "steps": [ { "key": "profile", "label": "string", "description": "string", "state": "complete", "completedAt": "2019-08-24T14:15:22Z", "actionLabel": "string", "actionPath": "string" } ], "nextAction": "string" }, "modules": [ { "key": "string", "label": "string", "state": "available", "description": "string", "reason": "string" } ], "sources": [ { "kind": "regulator", "provider": "string", "label": "string", "url": "http://example.com", "accessedAt": "2019-08-24T14:15:22Z", "accessionNumber": "string", "note": "string", "verificationStatus": "source_verified" } ], "generatedAt": "2019-08-24T14:15:22Z", "disclaimer": "string" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }