Introduction

The Talentir API adds payouts to your product. You create a payout, and Talentir does the rest: it verifies the recipient, issues the invoice, moves the money, and carries the liability. You do not build banking integrations or a ledger.

There are two ways to pay. Pick the one that matches what you know about the recipient.

Pay with a payout link

You know the recipient's email address and nothing else. Create a payout for that email and hand the recipient a Talentir-hosted link. The recipient signs in with a one-time code, enters their own bank account or PayPal, and claims the money. It is a hosted checkout page in reverse: Talentir collects the payment details and runs verification, so your product never stores them.

1. POST /payouts with recipient: { "type": "email", "email": "jane@example.com" } and andThen: "approve_and_send_claim_link". Talentir emails the link.
2. Or mint the link yourself with POST /sessions and type: "payout_claim", then redirect the recipient to it from your product. The page can carry your own branding.
3. payout.completed arrives on your webhook when the money has left.

Start with Pay with a payout link.

Pay through the API only

You already hold the recipient's details, or you collect them in your own form. Save the recipient as a counterparty, then push payouts to the saved bank account, PayPal, or crypto wallet. No link, no recipient sign-in, no Talentir screen.

1. GET /countries returns the tax fields a counterparty in each country needs, and which combinations are accepted. GET /payment-method-types returns the rails with the currencies and assets they settle in. Build your form from them instead of hardcoding fields.
2. POST /counterparties saves the recipient.
3. POST /payouts with recipient: { "type": "counterparty", "counterpartyId": "counterparty_…" } and andThen: "approve_and_pay" creates, approves, and pays in one request.
4. payout.completed or payout.failed arrives on your webhook.

Start with Pay directly.

Both ways use the same payout resource, so you can mix them: push money to recipients you know, and send a link to everyone else.

Also in the API

• Hosted sessions for payout approval, business verification (KYB), and spending allowance, optionally under your white-label branding.
• Webhooks with signed, real-time events for payout and counterparty changes.
• Team information: your team and its members, and your accounts with balances and deposit instructions.

API versions

v2 (/api/v2) is the current API and the one these docs describe. v1 (/api/v1) still works but will be sunset, so build new integrations on v2 and see Migrate from v1 to v2 for existing ones.

Changes without a new version

Talentir can make these changes to v2 at any time, without notice:

• Add endpoints.
• Add fields to response objects, webhook events, and error details.
• Add optional fields to request bodies, and optional query parameters.
• Add values to enums that the reference marks as open, such as status or paymentMethod.type, and add event types.

Build your client so that these changes do not break it:

• Ignore response fields that you do not know. The schemas in the reference and in /api/v2/spec.json list the fields that exist today and mark objects as closed (additionalProperties: false). A response can have more fields, so do not validate responses strictly against these schemas.
• Treat an unknown value of an open enum as a fallback case.

Base URLs

Replace v2 with v1 for the legacy API.

The sandbox is a standalone environment with its own persistent database. Sign up self-service; your teams, API keys, and webhooks stay put between visits. All external providers (banking, PayPal, blockchain, compliance screening) are simulated: no real money moves, and payouts settle instantly and synchronously. Business verification (KYB) completes with one click, wallets are simulated, and every payout method has a passing and a failing test scenario (see Pay with a payout link).

How to use these docs

• Each endpoint page has a Test button that opens the Scalar API client for the endpoint.
• The machine-readable specifications live at /api/v1/spec.json and /api/v2/spec.json. Agent-readable page dumps are at /llms.txt and /llms-full.txt.