Shared
Shared
Shared
$sharedAccount Financial Account Type
Type of account financial account
ShowShow
Address
ShowShow
Valid deliverable address (no PO boxes).
Name of city.
Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character format. Only USA is currently supported for all workflows. KYC_EXEMPT supports CAN additionally.
Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234. KYC_EXEMPT supports Canadian postal codes.
Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2 two-character format. KYC_EXEMPT supports Canadian province codes.
Unit or apartment number (if applicable).
Carrier
ShowShow
QR code url to display on the card carrier
Currency
3-character alphabetic ISO 4217 currency
Document
Describes the document and the required document image uploads required to re-run KYC
ShowShow
Globally unique identifier for the document.
Globally unique identifier for the account holder.
Type of documentation to be submitted for verification of an account holder
Hide ParametersShow Parameters
Globally unique identifier for an entity.
Represents a single image of the document to upload.
Hide ParametersShow Parameters
Globally unique identifier for the document upload.
A list of status reasons associated with a KYB account holder that have been satisfied by the document upload
When the document upload was created
Type of image to upload.
Hide ParametersShow Parameters
A list of status reasons associated with a KYB account holder that have not been satisfied by the document upload
Status of an account holder's document upload.
Hide ParametersShow Parameters
Reasons for document image upload status.
Hide ParametersShow Parameters
When the document upload was last updated
URL to upload document image to.
Note that the upload URLs expire after 7 days. If an upload URL expires, you can
refresh the URLs by retrieving the document upload from GET /account_holders/{account_holder_token}/documents.
Instance Financial Account Type
Type of instance financial account
ShowShow
Shipping Address
ShowShow
Valid USPS routable address.
City
Uppercase ISO 3166-1 alpha-3 three character abbreviation.
Customer's first name. This will be the first name printed on the physical card. The combined length of first_name and last_name may not exceed 25 characters.
Customer's surname (family name). This will be the last name printed on the physical card. The combined length of first_name and last_name may not exceed 25 characters.
Postal code (formerly zipcode). For US addresses, either five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a limit of 24 characters for other countries.
Unit number (if applicable).
Email address to be contacted for expedited shipping process purposes. Required if shipping_method is EXPEDITED.
Text to be printed on line two of the physical card. Use of this field requires additional permissions.
Cardholder's phone number in E.164 format to be contacted for expedited shipping process purposes. Required if shipping_method is EXPEDITED.