Create a cardholder

post

https://api.staging.berkeleypayment.com/rest/v1/instant_issuance/cardholders

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address1

string

required

length between 1 and 40

Street address line 1 (CA: max 30, US: max 40)

address2

string

length ≤ 30

Street address line 2

city

string

required

length between 1 and 100

City (CA: max 100, US: max 20)

country

int64

enum

required

ISO 3166-1 numeric country code. Only Canada (124) and the USA (840) are supported; any other value is rejected with 422.

Allowed:

date_of_birth

string

^\d{4}-\d{2}-\d{2}$

Birth date in yyyy-MM-dd format. Required unless your program is configured to make it optional.

string

length ≤ 50

Email address (RFC 2822). Required unless the program sets allow_optional_email; a virtual card still requires one when the program has virtual redemption notifications enabled.

emboss_line2

string

length ≤ 28

Second line of card emboss text (CA: 3-25 chars, US: max 28)

external_reference

string

length between 1 and 128

Client correlation identifier. When the company-level enforce_unique_external_reference service configuration is on, this field is required and must be unique within the company. Optional otherwise.

external_tag

string

length ≤ 255

User-defined external reference field

first_name

string

required

length between 1 and 50

Cardholder's first name

last_name

string

required

length between 1 and 50

Cardholder's last name

linked_account_id

int64

Linked account ID (shared balance, separate cards)

locale

string

enum

Language/localization preference

Allowed:

middle_name

string

length ≤ 50

Cardholder's middle name

office_id

int64

≥ 1

Office ID. Required when X-Office-External-Id is not supplied; ignored otherwise.

package_code

string

Card art and carrier specification

parent_cardholder_id

int64

Parent cardholder ID for fund transfers

phones

array of objects | null

Typed phone numbers, at most one per type (mobile, work, home). Required for Canadian programs, and on any program that does not set allow_optional_phone.

phones

postal_code

string

required

length ≥ 1

ZIP/postal code. CA format K1A-1A1; US format 12345 or 12345-1234.

program_id

int64

≥ 1

Program for initial account creation. Required when X-Office-External-Id is not supplied; ignored otherwise.

shipping_address

object

Card shipping address. Defaults to cardholder address when omitted.

shipping_method

string

enum

Shipping method for a physical card. Standard method token (standard, courier, express, international). Numeric processor codes are accepted for back-compat and deprecated.

sin

string

SIN (Canada) or SSN (US). Required for U.S. KYC programs.

state

string

required

length between 2 and 2

State or province as 2-character abbreviation

subprogram_code

string

enum

Subprogram designation

Allowed:

Headers

Idempotency-Key

string

length ≤ 255

Optional idempotency key. Replaying within 24h returns the cached response; reusing a key with different parameters returns 400 idempotency_params_error.

X-Office-External-Id

string

length ≤ 255

Office external tag. Resolves the office and its program; when omitted, program_id and office_id are required in the body.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Created

defaultError