v2.accounts

Create a hosted verification link (live platform key)

Complete currently due and future verification requirements, including proof_of_liveness, using provider-hosted capture. Platform must authenticate its seller before requesting/redirecting to the link. URLs must be HTTPS without credentials. Fresh link every call: do not cache or replay. Sandbox responds 409 and never creates real verification links. Creating a link, opening it, canceling or returning does not approve the account. Retrieve GET /accounts/{id} (up to 60-second status cache) or listen for cooud.account.updated. Legacy POST /files purpose proof_of_liveness is only an upload, not completed liveness verification.

post/accounts/{id}/onboarding_link

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/accounts/{id}/onboarding_link
  • Auth: HTTP bearer

Path parameters

idstring required

Connected account id (cooud_acct_<ULID> — the seller's store).

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Request body

refresh_urlstring uri required

HTTPS platform route that authenticates the seller and requests a new link when the previous link is expired or consumed.

return_urlstring uri required

HTTPS platform route after leaving capture. Returning does not prove completion; retrieve account requirements and observe cooud.account.updated.

Response

Fresh single-use link; Cache-Control: no-store. No verification status is changed by creating or returning from this link. For a Cooud LLC account (platforms Cooud enabled for it) the link is of the seller's Cooud LLC (Stripe Express) account; the seller authenticates with Stripe and gives the bank account there.

object'account_onboarding_link' required
accountstring required
urlstring uri required

Sensitive single-use link. Redirect the authenticated seller immediately; never log or email it.

expires_atinteger required
createdinteger required
livemodetrue required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.