API Reference
  1. Company
  2. Cards

Create a card

post
https://{hostname}/api/v1/cards

Issues a new card. Two flavors, based on your company's configuration:

  • Business Card (cardholderType: BUSINESS) — the company is the cardholder. Send a minimal user block: firstName, lastName, email.
  • Authorized User Card (cardholderType: AUTHORIZED_USER) — the card is issued to a person. Send the full user block: firstName, lastName, email, phone, address, birthdate, title.

Pass userId instead of user to attach the card to an existing user. New users are provisioned as Cardholders — to set a different role, create the user via the user API first.

Requires Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The type of cardholder. Must match your company's configuration.

Allowed:
string

A display name for the card.

string
enum
required

The card form factor.

Allowed:
policy
object

The spending controls applied to a card. At least one spending limit (transaction, daily, monthly, or total) must be specified when creating a card.

string | null

An optional note associated with the card.

user
object
required

Provision a new cardholder for this card. Mutually exclusive with userId.

uuid

The ID of an existing user on your company. Mutually exclusive with user.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?