Skip to main content

Design partner support packet

Use this page when onboarding or supporting the first external users on secapi.ai.

What the partner should receive

  • docs root: https://docs.secapi.ai
  • status: https://docs.secapi.ai/status
  • changelog: https://docs.secapi.ai/changelog
  • onboarding: https://secapi.ai/onboarding
  • auth and pricing: https://docs.secapi.ai/auth-and-pricing
  • first-request flows: https://docs.secapi.ai/first-request-flows

Minimum partner checklist

  1. Confirm API health and OAuth discovery
  2. Confirm the org has a live scoped API key
  3. Run one issuer lookup
  4. Run one narrative workflow and one structured workflow
  5. Confirm billing and limits visibility
  6. Confirm the partner can capture Request-Id
  • equity research:
    • entities.resolve
    • filings.latest
    • sections.get
    • facts.get
  • portfolio monitoring:
    • owners.get_13f
    • owners.compare_13f
    • insiders.list
  • compensation review:
    • comp.list
    • comp.compare

Support escalation package

Every escalation should include:
  • org name
  • primary interface used
  • exact ticker, CIK, form, or tool name
  • Request-Id
  • timestamp in UTC
  • whether the issue is blocking onboarding or post-onboarding production use

Success criteria

  • the partner completes one real workflow in their preferred interface
  • the partner has a named operator contact on both sides
  • the partner has the docs and escalation links above
  • the partner can state their next production workflow clearly