Skip to main content

Customer format

Digital issuance requires a customer. Physical card activation accepts an optional customer. When supplied, use this structure:
email must be valid and contact.fullName is required. Optional contact fields are displayName, company, and phone. If you provide address, include line1, city, postalCode, and a two-letter countryCode; line2 and state are optional. Omit address or send null when you do not have one. birthdate uses an ISO 8601 timestamp, such as 1990-06-15T00:00:00Z. The old flat fields name, phoneNumber, zipCode, and city are not the current input format. Put contact data under contact and postal data under address.

Account requirements

Fetch client configuration before showing the issuance form. Missing account-required fields return 400 MISSING_MANDATORY_FIELDS. These account requirements supplement the input schema’s required email and contact fields.

Customer records

GET /customers returns account customer records with nested contact/address data, createdAt, updatedAt, privacyConsentGiven, and stats. Card responses reference a customer through customerEmail; they do not embed a customer object.