Skip to content

Team and access

Invite someone to the whole merchant account or to a single shop. Use a login session with merchant-owner access; a shop API key cannot manage the team. To share your whole Invoise account, wallet and card included, add an account member instead.

Terminal window
curl -X POST 'https://platform.invoise.me/api/v1/merchants/{merchant_id}/invites' \
-H 'Authorization: Bearer <session-token>' \
-H 'Idempotency-Key: <saved-unique-key>' \
-H 'Content-Type: application/json' \
-d '{"provider":"email","subject":"[email protected]","role":"developer","shop_id":"<shop-id>"}'

Use viewer for reading, developer for integration work, or owner for administration. Set shop_id to limit the invitation to one shop. Omitting it or setting it to null grants access across the merchant.

To invite an agent or anyone who signs in with a wallet, send "provider":"wallet" with their EVM address as subject. They accept after signing in with that wallet.

Check the role and scope before sending. The selected shop must be active and belong to that merchant; an invalid shop does not fall back to merchant-wide access.

The recipient signs in and accepts with POST /api/v1/invites/{id}/accept. Send an idempotency key on this request too. Before accepting, GET /api/v1/invites/{id} shows the merchant, shop, role and who invited, with status open, accepted, used, revoked, expired or unavailable. An invitation stays open for 7 days by default.

By default a merchant can have up to 10 members and pending invitations together. Beyond that, both inviting and accepting return 400 team_limit_reached; Invoise staff can raise the limit. See Limits.

Request Purpose
GET /api/v1/merchants/{merchant_id}/team list grants and invitations.
DELETE /api/v1/merchants/{merchant_id}/invites/{id} revoke a pending invitation.
DELETE /api/v1/merchants/{merchant_id}/grants/{id} remove existing access.
POST /api/v1/merchants/{merchant_id}/leave leave a merchant you joined.

Changes require the appropriate owner session and idempotency key. If MFA is enabled, a sensitive operation may ask for a fresh code.

Leaving needs only your own session. It is refused for the merchant you created (own_merchant), for its last owner (last_merchant_owner), and while one of its shops pays into your Invoise wallet (wallet_in_use, with the shop names in error.details).

An account member works in your whole Invoise account: the wallet, the card, referrals and every merchant you own. A team member above gets a role in one merchant or one shop and never sees your wallet or card. Account members are managed in the dashboard under Profile → Access.

Role Can
Viewer (viewer) See the wallet, the card, referrals and your merchants. Changes nothing.
Editor (editor) What a viewer can, and work in the shops as a developer: invoices, addresses, API keys, webhooks. Shop settings stay with the owner.
Owner (owner) Everything you can: withdraw, change wallet protection and automatic withdrawals, the card, shop settings and the account’s members.

A viewer or an editor never withdraws, signs, changes wallet protection, issues or closes the card or manages members. A co-owner still needs the wallet’s code, password or recovery key to sign, but give the role only to someone you trust like yourself. When your account has 2FA, a member confirms sensitive changes with a second factor of their own, so they need 2FA too (403 account_mfa_required).

In Profile → Access press Invite, enter an email and choose a role. The invitation is valid for 7 days; inviting the same email again renews it and changes its role. An account can have up to 20 members and invitations together.

Only a user who proved that email can accept: by signing in with a code sent to it, or with a Google account whose email Google verified. An email typed at sign-up with a wallet counts only after the first sign-in with a code sent to it. The invitee finds the invitation in notifications and under Profile → Access → Invitations and presses Accept or Decline; someone without an Invoise account gets it by email. A member needs no merchant of their own.

Accounts shared with you are in the account menu under Accounts, and My account brings you back. Every page of someone else’s account shows a bar with the account and your role, and Back to my account. Profile → Access → Shared with you lists them too, with Open and a button to leave the account. If the owner’s account is blocked or deleted, its members lose access.

The owner changes a member’s role or presses Remove access, or Revoke invitation for a pending one. When a member leaves or is removed, the API keys they made in your shops are revoked; the same happens when their role becomes Viewer. You get a security notice for every change: check what the member may have set up, such as webhooks, team members, the delegate and automatic withdrawals.

The dashboard calls these with your session; a shop API key cannot use them.

Request Purpose
GET /api/v1/account/members list members and invitations, with status pending, active or expired.
POST /api/v1/account/members invite: {"email":"[email protected]","role":"viewer"}.
PATCH /api/v1/account/members/{id} change the role: {"role":"editor"}.
DELETE /api/v1/account/members/{id} revoke an invitation or remove a member.
GET /api/v1/accounts accounts you are a member of, and invitations to you.
POST /api/v1/accounts/invites/{id}/accept accept an invitation.
DELETE /api/v1/accounts/invites/{id} decline an invitation.
DELETE /api/v1/accounts/{owner_id} leave an account.

To act in someone else’s account, send X-Invoise-Account: <owner_id>, the id from GET /api/v1/accounts; with it a co-owner also manages that account’s members. The event stream GET /api/v1/live and export.csv downloads, which cannot carry a header, take ?account=<owner_id> instead. Your own profile, sign-in, notifications and memberships ignore it. A request outside your role returns 403 with account_access_denied, account_read_only or account_owner_only. Invitation errors return 400: invalid_email, invalid_role, account_invite_self, account_member_exists, account_member_limit, account_member_not_found, invite_unavailable.

If Invoise staff block a merchant, its unpaid invoices are cancelled with reason merchant_blocked, its deposit addresses are disabled and its API keys stop working. Members see the reason in the dashboard.

A blocked user can still sign in, read their wallet, card and notifications, withdraw from the wallet and close their card. Other requests return 403 account_disabled with the reason in error.details.

Invoise sends account, payment and security notices, such as incoming payments, wallet withdrawals, security changes, card operations and invitations, by email and, once you connect it, Telegram. Choose the channels in your profile.

Download GET /api/v1/shops/{shop_id}/export.csv with shop read access. Use it for accounting exports, not as a payment notification.