Cardholder file schema

The Cardholder file contains events related to cardholders and the cardholder lifecycle. Each row represents one cardholder event. For file naming, format and conventions, see Working with the files.

Column	Data type	Allowed values / format	Description
`event_type`	string	`cardholder_created`, `cardholder_updated`	Type of cardholder event represented by the row.
`event_created_at`	datetime	ISO 8601 datetime	Date and time when the event occurred or was emitted.
`cardholder_event_id`	string	String	Unique identifier of the cardholder event.
`cardholder_id`	UUID	UUID	Enfuce-generated unique identifier of the cardholder.
`customer_number`	string	1–36 characters; letters, numbers, hyphen	Your external unique identifier for the cardholder.
`locale`	string	RFC 5646 locale code from a fixed list, for example `en-GB`	Cardholder’s language and country code.
`address_address1`	string	1–255 characters; no leading/trailing whitespace	First line of the cardholder address.
`address_address2`	string	Max 255 characters; no leading/trailing whitespace / empty	Second line of the cardholder address.
`address_address3`	string	Max 255 characters; no leading/trailing whitespace / empty	Third line of the cardholder address.
`address_address4`	string	Max 255 characters; no leading/trailing whitespace / empty	Fourth line of the cardholder address.
`address_city`	string	1–255 characters; no leading/trailing whitespace	City of the cardholder address.
`address_country`	string	ISO 3166-1 alpha-3 country code	Country of the cardholder address.
`address_region`	string	Max 32 characters	Region of the cardholder address.
`address_zip_code`	string	1–32 characters; no leading/trailing whitespace	Postal or ZIP code of the cardholder address.
`mobile_number`	string	Starts with `+`, followed by 6 to 15 digits in total, including the country code	Mobile number of the cardholder, including country code.
`first_name`	string	1–256 characters; supported name characters; no leading/trailing whitespace	First name of the cardholder.
`middle_name`	string	1–256 characters; supported name characters; no leading/trailing whitespace	Middle name of the cardholder.
`last_name`	string	1–256 characters; supported name characters; no leading/trailing whitespace	Last name of the cardholder.
`cardholder_created_at`	datetime	ISO 8601 datetime	Date and time when the cardholder was created.
`cardholder_updated_at`	datetime	ISO 8601 datetime	Date and time when the cardholder entity was last updated.
`update_count`	integer	Integer	Version number of the cardholder entity.
`email`	string	Email format; 1–256 characters	Email address of the cardholder.
`tax_id`	string	1–64 characters	Tax identification number used for taxation, regulatory reporting or authority requirements.
`date_of_birth`	date	ISO date, for example `1935-01-15`	Date of birth of the cardholder.
`nationality_1`	string	ISO 3166-1 alpha-3 country code, or `XKX`	First nationality of the cardholder. Duplicate values are not allowed across the three nationality columns.
`nationality_2`	string	ISO 3166-1 alpha-3 country code, or `XKX` / empty	Second nationality of the cardholder. Empty when the cardholder has fewer than two nationalities.
`nationality_3`	string	ISO 3166-1 alpha-3 country code, or `XKX` / empty	Third nationality of the cardholder. Empty when the cardholder has fewer than three nationalities.
`risk_score`	string	`High`, `Med`, `Low`, `Pep`, `Prohibited`	Risk assessment score of the cardholder.
`birth_country`	string	ISO 3166-1 alpha-3 country code; `XKX` may be used for Kosovo	Country of birth of the cardholder.
`identification_number`	string	1–64 characters; letters, numbers, spaces, hyphen, underscore, slash, dot, plus; must start and end with an alphanumeric character	Identification number of the cardholder, such as a social security number, national identity number or company registration number.

Getting Started

Cards

Cardholders

PIN

Digital Wallets

Transaction Lifecycle

Data

Spend Controls

Exchange Rates

Cardholder file schema