Creators · Treasury
Creates a payee onboarding link.
POST
https://api.pozy.ai/v1/payees/{payeeId}/onboarding-linkEnabled on requestcreatePayeeOnboardingLink
Guide: Pay creators
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the money resource group disabled get 403 resource_group_disabled. Authentication
This endpoint is enabled per workspace. Until it is, calls return 403 feature_not_available. Email support@pozy.ai to turn it on.
Path parameters
| Name | Type | Notes |
|---|---|---|
payeeIdrequired | string |
Example
curl -X POST "https://api.pozy.ai/v1/payees/6e2802af63395e8f1a4ddc25/onboarding-link" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/payees/6e2802af63395e8f1a4ddc25/onboarding-link", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/payees/6e2802af63395e8f1a4ddc25/onboarding-link",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
urlstring (URL)expiresAtstring (date-time)
200 response
{
"url": "https://pozy.ai/media/example-1.jpg",
"expiresAt": "2026-10-02T09:00:00.000Z"
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.