Commet
  • Pricing
Log InTry out
Add a payout bank account POSTComplete payout verification POSTRequest a payout POST
System status
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Complete payout verification

Provision the organization's payout account in a single call with the full KYC + bank payload. Uploads the identity document, persists the destination bank, and creates the connected account through the org's payout provider. The account starts `pending_verification` and flips to `verified` via the provider's webhook. Idempotent: returns the existing account if the org already has one.

POST
/payouts/verification

Provision the organization's payout account in a single call with the full KYC + bank payload. Uploads the identity document, persists the destination bank, and creates the connected account through the org's payout provider. The account starts pending_verification and flips to verified via the provider's webhook. Idempotent: returns the existing account if the org already has one.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payouts/verification" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "businessType": "individual",    "businessUrl": "http://example.com",    "documentUrl": "http://example.com",    "bank": {      "accountNumber": "string",      "accountHolderName": "string"    }  }'
{  "success": true,  "data": {    "providerAccountId": "string",    "status": "pending_verification",    "transfersEnabled": true,    "alreadyExists": true,    "businessType": "individual",    "country": "string",    "object": "payout_account",    "livemode": true  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Add a payout bank account POST

Add an additional destination bank account to the organization's existing payout account. Country and currency are resolved from the organization. The full account number is never returned — only `last4`.

Request a payout POST

Withdraw available balance to the organization's verified payout account. `amount` is in cents (USD, minimum 1000 = $10). The payout is created in `pending` and settles to `paid` asynchronously as provider webhooks arrive.

email*string
Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
businessType*string

Value in

  • "individual"
  • "company"
businessUrl*string
Formaturi
documentUrl*string
Formaturi
bank*
individual?
company?