Design partner support packet
Use this page when onboarding or supporting the first external users onsecapi.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
- Confirm API health and OAuth discovery
- Confirm the org has a live scoped API key
- Run one issuer lookup
- Run one narrative workflow and one structured workflow
- Confirm billing and limits visibility
- Confirm the partner can capture
Request-Id
Recommended starter workflows
- equity research:
entities.resolvefilings.latestsections.getfacts.get
- portfolio monitoring:
owners.get_13fowners.compare_13finsiders.list
- compensation review:
comp.listcomp.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