Generated from /openapi.json (OpenAPI 3.1.0, API v0.1.0). Base URL: https://api.rivecard.com.
| Method |
Path |
Auth |
Summary |
GET |
/v1/health |
none |
Liveness + database check |
| Method |
Path |
Auth |
Summary |
GET |
/v1/auth/providers |
none |
Sign-in methods available on auth.rivecard.com |
POST |
/v1/auth/email/start |
none |
Email a one-time sign-in code |
POST |
/v1/auth/email/verify |
none |
Exchange the emailed code for a session |
POST |
/v1/auth/passkeys/login/options |
none |
Start passkey sign-in (discoverable credentials) |
POST |
/v1/auth/passkeys/login/verify |
none |
Finish passkey sign-in |
POST |
/v1/auth/passkeys/register/options |
session |
Start adding a passkey to your account |
POST |
/v1/auth/passkeys/register/verify |
session |
Finish adding a passkey |
GET |
/v1/auth/passkeys |
session |
List your passkeys |
DELETE |
/v1/auth/passkeys/{id} |
session |
Remove a passkey |
GET |
/v1/auth/session |
session |
The current dashboard session (user, memberships, CSRF token) |
POST |
/v1/auth/logout |
session |
Sign out this session |
POST |
/v1/auth/logout_all |
session |
Sign out everywhere (revoke all of your sessions) |
| Method |
Path |
Auth |
Summary |
GET |
/v1/organizations |
session |
Organizations you belong to |
POST |
/v1/organizations |
session |
Create an organization (you become owner) |
GET |
/v1/organization |
API key / OAuth token / session |
The organization the credential belongs to |
| Method |
Path |
Auth |
Summary |
GET |
/v1/members |
API key / OAuth token / session |
Members of the organization |
POST |
/v1/members |
API key / OAuth token / session |
Add a member by email (creates the user if needed; they sign in with a code) |
PATCH |
/v1/members/{id} |
API key / OAuth token / session |
Change a member’s role |
DELETE |
/v1/members/{id} |
API key / OAuth token / session |
Remove a member |
| Method |
Path |
Auth |
Summary |
GET |
/v1/api_keys |
API key / OAuth token / session |
List API keys (secrets are never returned again) |
POST |
/v1/api_keys |
session |
Create an API key (rk_test_… / rk_live_…) — the secret is shown once |
POST |
/v1/api_keys/{id}/revoke |
API key / OAuth token / session |
Revoke an API key immediately |
| Method |
Path |
Auth |
Summary |
GET |
/v1/oauth_clients |
API key / OAuth token / session |
List OAuth clients (client-credentials apps) |
POST |
/v1/oauth_clients |
session |
Create an OAuth client — client_secret is shown once |
POST |
/v1/oauth_clients/{id}/revoke |
API key / OAuth token / session |
Revoke an OAuth client and all its access tokens |
POST |
/v1/oauth/token |
none |
Client-credentials grant → 1 h bearer token |
| Method |
Path |
Auth |
Summary |
POST |
/v1/connect/start |
API key / OAuth token / session |
Email an end user a one-time code to connect them to your organization |
POST |
/v1/connect/verify |
API key / OAuth token / session |
Exchange the end user’s code for user-scoped tokens |
POST |
/v1/connect/refresh |
none |
Rotate an end user’s tokens (refresh tokens are single-use) |
GET |
/v1/connect/me |
end-user token |
The end user an act_… token belongs to |
| Method |
Path |
Auth |
Summary |
GET |
/v1/webhook_endpoints |
API key / OAuth token / session |
List webhook endpoints |
POST |
/v1/webhook_endpoints |
API key / OAuth token / session |
Create a webhook endpoint — the signing secret is shown once |
GET |
/v1/webhook_endpoints/{id} |
API key / OAuth token / session |
Retrieve a webhook endpoint |
PATCH |
/v1/webhook_endpoints/{id} |
API key / OAuth token / session |
Update a webhook endpoint |
DELETE |
/v1/webhook_endpoints/{id} |
API key / OAuth token / session |
Delete a webhook endpoint |
POST |
/v1/webhook_endpoints/{id}/test |
API key / OAuth token / session |
Send a webhook_endpoint.test event to this endpoint |
GET |
/v1/webhook_deliveries |
API key / OAuth token / session |
Delivery log (newest first) |
| Method |
Path |
Auth |
Summary |
GET |
/v1/events |
API key / OAuth token / session |
Events (newest first) |
GET |
/v1/events/{id} |
API key / OAuth token / session |
Retrieve an event |
| Method |
Path |
Auth |
Summary |
POST |
/v1/account_holders |
API key / OAuth token / session |
Create an account holder (the card’s legal owner) and start KYC/KYB with the issuer |
GET |
/v1/account_holders |
API key / OAuth token / session |
List account holders |
GET |
/v1/account_holders/{id} |
API key / OAuth token / session |
Retrieve an account holder |
| Method |
Path |
Auth |
Summary |
GET |
/v1/account_holders/{id}/balance |
API key / OAuth token / session |
Available balance (held by the issuer / sponsor bank, never by Rive Card) |
POST |
/v1/account_holders/{id}/fund |
API key / OAuth token / session |
Move funds to an account holder (simulator: instant test money) |
| Method |
Path |
Auth |
Summary |
POST |
/v1/cards |
API key / OAuth token / session |
Issue a virtual card with spending controls |
GET |
/v1/cards |
API key / OAuth token / session |
List cards |
GET |
/v1/cards/{id} |
API key / OAuth token / session |
Retrieve a card (never includes the card number) |
PATCH |
/v1/cards/{id} |
API key / OAuth token / session |
Update nickname, metadata or controls (amount limits, tx count, MCC/merchant lists, expiry) |
POST |
/v1/cards/{id}/freeze |
API key / OAuth token / session |
Freeze a card (declines everything until unfrozen) |
POST |
/v1/cards/{id}/unfreeze |
API key / OAuth token / session |
Unfreeze a card |
POST |
/v1/cards/{id}/close |
API key / OAuth token / session |
Close a card permanently |
POST |
/v1/cards/{id}/display |
API key / OAuth token / session |
Get a short-lived secure display for the card details |
| Method |
Path |
Auth |
Summary |
GET |
/v1/transactions |
API key / OAuth token / session |
List authorizations (approved and declined) |
GET |
/v1/transactions/{id} |
API key / OAuth token / session |
Retrieve a transaction |
| Method |
Path |
Auth |
Summary |
POST |
/v1/simulate/authorizations |
API key / OAuth token / session |
Test mode: run a card authorization through the real-time decision engine |
| Method |
Path |
Auth |
Summary |
GET |
/v1/audit_events |
API key / OAuth token / session |
Tamper-evident audit trail for the organization (owner/admin) |
AccountHolder · AccountHolderList · ActorType · AddMemberRequest · ApiKey · ApiKeyList · AuditEvent · AuditEventList · AuthProviders · Balance · Card · CardControls · CardDisplay · CardList · ConnectRefreshRequest · ConnectStartRequest · ConnectTokens · ConnectVerifyRequest · CreateAccountHolderRequest · CreateApiKeyRequest · CreateCardRequest · CreateOAuthClientRequest · CreateOrganizationRequest · CreateWebhookEndpointRequest · CreatedApiKey · CreatedOAuthClient · CreatedWebhookEndpoint · DeclineReason · EmailStartRequest · EmailVerifyRequest · EndUser · Environment · Error · Event · EventList · EventType · FundRequest · Health · IssuerName · LoginResult · Member · MemberList · Membership · MembershipList · Merchant · Metadata · OAuthClient · OAuthClientList · OAuthToken · OAuthTokenRequest · Organization · Passkey · PasskeyList · PasskeyOptions · PasskeyVerifyRequest · Role · Session · SimulateAuthorizationRequest · Transaction · TransactionList · UpdateCardRequest · UpdateMemberRequest · UpdateWebhookEndpointRequest · User · WebhookDelivery · WebhookDeliveryList · WebhookEndpoint · WebhookEndpointList