{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting started"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Basic Capital's PartnerAPI fully supports onboarding and post-onboarding flows for plan sponsors and employees. This allows partners to embed anything from small summary items to a fully white-labeled experience."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get started, we will schedule a call to provide partners with an API key for our development environment and walk through your needs and integration shape. We will then coordinate to support new partners through testing their integration before going live with production credentials."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The PartnerAPI supports connecting via gRPC by default; this allows partners to auto-generate an SDK in their language of choice, and connect normally via HTTPS proxy. However, we can open a REST API connection for partners upon request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"white-label-employer-company-experience","__idx":1},"children":["White-Label Employer (Company) Experience"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Partner can use Basic Capital's platform to power a fully white-labeled employer experience within their own product. From the end-user's perspective, they never interact with Basic Capital directly -- all company onboarding, plan management, and admin flows are surfaced through the Partner's UI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How it works:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authenticate as a Partner"]},": Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExchangeApiKey"]}," with the Partner API key to receive an auth token. The token expires after 1 hour. The Partner should call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExchangeApiKey"]}," again when the token expires."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Act on a Company"]},": Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer <auth_token>"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Identity-Uuid: <company_uuid>"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Identity-Type: COMPANY"]}," headers on any employer Ingress endpoint call. The platform resolves the Partner's association to that Company."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Manage the employer lifecycle"]},": All standard employer flows (plan setup, HRIS operations, payroll events, loans management, withdrawals, etc.) are available to Partners using the same Ingress endpoints the Basic Capital employer dashboard uses."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key headers for company-scoped calls:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer <partner_jwt>"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Identity-Uuid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<company_uuid>"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Identity-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPANY"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The employee's direct login (via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SharedAuthIngressService.Login"]},") continues to work unchanged."]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"White-Label Employer (Company) Experience","id":"white-label-employer-company-experience","depth":3}],"frontmatter":{"title":"Getting started","seo":{"title":"Getting started"}},"lastModified":"2026-09-11T17:59:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}