> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Partner accounts overview

> Onboard your own customers as connected accounts, check their balances, and run batch payouts on their behalf.

Partner accounts are for vertical SaaS providers and fintech companies that offer MyGigsters to their own customers. As a partner, you onboard each customer as a connected account, hand off identity verification, and move money on their behalf.

## Key concepts

> [card] Partner account
>
> Your top-level organisation profile. You authenticate with your registered email and a private 64-character OAuth key to receive a short-lived JWT Bearer token.

> [card] Connected accounts
>
> The businesses, companies, or sole traders you onboard. Each gets a unique `account_id` and its own multi-currency wallet balances.

> [card] KYC magic links
>
> Pre-authenticated hosted onboarding links. Your customer uploads documents and completes identity verification without seeing your API credentials.

> [card] Sandbox simulation
>
> Instantly simulate a connected account's KYC approval in the demo environment, so you don't wait on manual verification while you build.

## How a partner integration works

**1. Authenticate**

Exchange your email and OAuth key for a JWT Bearer token that lasts five minutes. Rotate your OAuth key at any time.

[Authenticate partner](https://docs.mygigsters.com/api-reference/partner-account/partner-authenticate.md) · [Rotate auth key](https://docs.mygigsters.com/api-reference/partner-account/partner-rotate-auth-key.md)

**2. Create a connected account and start KYC**

Register your customer to get their `account_id`, then generate a magic link so they can complete onboarding themselves.

[Create connected account](https://docs.mygigsters.com/api-reference/partner-account/partner-connected-account.md) · [Get KYC magic link](https://docs.mygigsters.com/api-reference/partner-account/partner-ca-magic-link.md)

**3. Check verification status**

Check the account's live verification state. In the demo environment, fast-track a test account to `ACTIVE` with the simulation endpoint.

[Get connected account status](https://docs.mygigsters.com/api-reference/partner-account/partner-ca-status.md) · [Simulate account status](https://docs.mygigsters.com/api-reference/partner-account/partner-ca-simulate-status.md)

**4. View balances and transactions**

Read the account's multi-currency wallet balances and its transaction ledger, with date filters and pagination.

[Get balances](https://docs.mygigsters.com/api-reference/partner-account/partner-ca-balance.md) · [Get transactions](https://docs.mygigsters.com/api-reference/partner-account/partner-ca-transactions.md)

**5. Run batch payouts**

Submit high-volume batch payouts over NPP or standard bank transfer, then track each line item.

[Batch payout](https://docs.mygigsters.com/api-reference/partner-account/partner-batch-payout.md) · [Batch status](https://docs.mygigsters.com/api-reference/partner-account/partner-batch-status.md)

## Stay in sync

Subscribe to partner webhooks to hear about account and payout events as they happen.

> [card] [Get webhook events](https://docs.mygigsters.com/api-reference/partner-webhooks/partner-webhook-events.md)
>
> See the events you can subscribe to.

> [card] [Subscribe to events](https://docs.mygigsters.com/api-reference/partner-webhooks/partner-webhook-subscribe.md)
>
> Register an endpoint for the events you need.

> [!NOTE]
>
> Partner endpoints are available on API version 1.2.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.