Note
A user can simultaneously be a child of a business and a parent of other users if the user is not configured to use the parent’s account balances and the user’s children are configured to use the parent’s account balances. For more information on account holders, see About Account Holders.
A user can simultaneously be a child of a business and a parent of other users if the user is not configured to use the parent’s account balances and the user’s children are configured to use the parent’s account balances. For more information on account holders, see About Account Holders.
Create business
Action:POSTEndpoint:
/businesses
Create a business. The initial status of a newly created business depends on the Know Your Customer (KYC) requirements of the program or associated account holder group.
| KYC Required | Initial Business State | Business Active on Creation | Business Limitations |
|---|---|---|---|
| Always | UNVERIFIED | No | Cannot load funds. |
| Conditionally | LIMITED | No | Restricted by rules in accountholdergroups.pre_kyc_controls. |
| Never | ACTIVE | Required | None. |
/businesstransitions endpoint. For more information on status changes, see Create Business Transition.
For information about configuring the required fields for KYC verification, see Perform KYC.
Request body
| Fields | Description |
|---|---|
| account_holder_group_token string Optional | Existing account holder group token that associates the specified account holder group with the business. Send a GET request to /accountholdergroups to retrieve account holder group tokens.Allowable Values: 36 char max |
| active boolean Optional | Specifies if the business is in the ACTIVE state on the Marqeta platform.Allowable Values: true, falseDefault value: true |
| attestation_consent boolean Optional | Indicates that the attester agrees that the information provided is correct and truthful. This field is required for KYC verification (US-based accounts only). Allowable Values: true, false |
| attestation_date datetime Optional | Timestamp of the attestation. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| attester_name string Optional | Name of the attester for KYC verification. This field is required for KYC verification (US-based accounts only). Allowable Values: 64 char max |
| attester_title string Optional | Title of the attester for KYC verification. Allowable Values: 64 char max |
| beneficial_owner1 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner1.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner1.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner1.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner1.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner1.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner1.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner1.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner1.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner1.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner1.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner1.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner1.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner1.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner1.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner1.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner2.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner2.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner2.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner2.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner2.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner2.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner2.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner2.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner2.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner2.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner2.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner2.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner2.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner2.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner3.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner3.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner3.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner3.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner3.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner3.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner3.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner3.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner3.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner3.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner3.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner3.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner3.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner3.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner4.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner4.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner4.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner4.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner4.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner4.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner4.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner4.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner4.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner4.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner4.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner4.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner4.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner4.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| business_name_dba string Optional | Fictitious business name (“Doing Business As” or DBA). This field is required for KYC verification (US-based accounts only). If your business does not use a fictitious business name, enter your legal business name again in this field. Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_name_legal string Optional | Legal name of business. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_type string Optional | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). Allowable Values: 255 char max |
| date_established datetime Optional | Date when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| duns_number string Optional | Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
| general_business_description string Optional | Required for KYC verification (US-based cardholders only). Business description must adhere to the NAICS standard, as defined by the United States Census Bureau. You must provide at least the description; NAICS codes are optional. For example, Used Car Dealers or 44112 - Used Car Dealers.This field is returned if it exists in the resource. Allowable Values: 255 char max |
| history string Optional | History of the business. Allowable Values: 255 char max |
| identifications array of objects Optional | One or more objects containing identifications associated with the business. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| in_current_location_since datetime Optional | Date on which the business office opened in its current location. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| incorporation object Optional | Contains information about the organizational structure of the business. This object is required for KYC verification (US-based accounts only). Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| incorporation.address_registered_under object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| incorporation.address_registered_under.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| incorporation.address_registered_under.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| incorporation.address_registered_under.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| incorporation.address_registered_under.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| incorporation.address_registered_under.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| incorporation.address_registered_under.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| incorporation.address_registered_under.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| incorporation.incorporation_type string Optional | Organizational structure of the business, such as corporation or sole proprietorship. This field is required for KYC verification (US-based accounts only). Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, COOPERATIVE, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| incorporation.is_public boolean Optional | A value of true indicates that the business is publicly held.Allowable Values: true, falseDefault value: false |
| incorporation.is_regulated_entity boolean Optional | A value of true indicates that the business is a regulated entity.Allowable Values: true, false |
| incorporation.name_registered_under string Optional | Name under which the business is registered. Allowable Values: 255 char max |
| incorporation.state_of_incorporation string Optional | State, province, territory, or federation where the business is incorporated. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max Valid state, provincial, territorial, or federal abbreviation required for KYC verification ( CA for California or CAN for Canada, for example); 255 char max otherwise |
| incorporation.stock_symbol string Optional | Business stock symbol. Allowable Values: 255 char max |
| international_office_locations string Optional | Locations of the business’ offices outside the US. Allowable Values: 255 char max |
| ip_address string Optional | IP address of the business. Allowable Values: 39 char max |
| metadata object Optional | Associates any additional metadata you provide with the business. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1" |
| notes string Optional | Any additional information pertaining to the business. Allowable Values: 255 char max |
| office_location object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| office_location.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| office_location.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| office_location.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| office_location.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| office_location.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| office_location.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| office_location.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| password string Optional | Password for the business account on the Marqeta platform. Allowable Values: 1–255 chars - Must contain at least one numeral - Must contain at least one lowercase letter - Must contain at least one uppercase letter - Must contain at least one of these symbols: @``#``$``%``!``^``&``*``(``)\\``_``+``~``-``=``[``]``\{``},``;``:``'``"``.``/``<``>``?` |
| phone string Optional | 10-digit telephone number of business. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact object Optional | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| primary_contact.department string Optional | Business department of the primary contact. Allowable Values: 255 char max |
| primary_contact.email string Optional | Email address of the primary contact. Allowable Values: 255 char max |
| primary_contact.extension string Optional | Phone extension of the primary contact. Allowable Values: 255 char max |
| primary_contact.fax string Optional | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.full_name string Optional | Full name of the primary contact. Allowable Values: 255 char max |
| primary_contact.mobile string Optional | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.phone string Optional | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.title string Optional | Title of the primary contact. Allowable Values: 255 char max |
| proprietor_is_beneficial_owner boolean Optional | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is required for KYC verification if the business proprietor or officer is also a beneficial owner. Allowable Values: true, falseDefault value: false |
| proprietor_or_officer object Optional | Contains information about the proprietor or officer of the business. This object is required for KYC verification of proprietors or officers of privately held businesses in the United States. This object is not required for publicly held businesses. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| proprietor_or_officer.alternative_names string Optional | Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.birth_place string Optional | Country of birth of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.dob datetime Optional | Business proprietor or officer’s date of birth. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| proprietor_or_officer.email string Optional | Email address of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.first_name string Required | First name of business proprietor or officer. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| proprietor_or_officer.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| proprietor_or_officer.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| proprietor_or_officer.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| proprietor_or_officer.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| proprietor_or_officer.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| proprietor_or_officer.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| proprietor_or_officer.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| proprietor_or_officer.identifications array of objects Optional | One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid array of one or more identifications objects |
| proprietor_or_officer.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| proprietor_or_officer.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| proprietor_or_officer.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| proprietor_or_officer.last_name string Required | Last name of business proprietor or officer. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.middle_name string Optional | Middle name of business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.nationality string Optional | Nationality of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.phone string Optional | Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 Do not insert a 1 before the area code. |
| proprietor_or_officer.ssn string Optional | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. Allowable Values: Nine digits, no delimiters. 123456789, for example. |
| proprietor_or_officer.title string Optional | Title of business proprietor or officer. Allowable Values: 255 char max |
| taxpayer_id string Optional | Taxpayer identifier of the business. Allowable Values: 255 char max |
| token string Optional | Unique identifier of the business resource. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
| website string Optional | URL of the business’ website. Allowable Values: 255 char max |
Sample request body
JSON
{
"token": "my_business_02",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"notes": "My notes",
"password": "My_passw0rd",
"phone": "5105551212",
"website": "https://my_business_02.com",
"history": "My_business_history",
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B Street",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"incorporation_type": "LLC"
},
"ip_address": "67.120.28.118,",
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"in_current_location_since": "2010-04-15T00:01:00Z",
"date_established": "2010-04-15T00:01:00Z",
"general_business_description": "44112 - Used Car Dealers",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"identifications": [
{
"type": "BUSINESS_TAX_ID",
"value": "123456789"
}
],
"duns_number": "987654321",
"primary_contact": {
"title": "Dr",
"department": "My_department",
"phone": "5105551212",
"extension": "11",
"fax": "5105551222",
"email": "dr.me@my.business.com",
"full_name": "First Middle Last",
"mobile": "5105551213"
},
"proprietor_or_officer": {
"title": "Mr",
"dob": "1985-01-08T00:00:00Z",
"phone": "5105551211",
"email": "mr.myself@my.business.com",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My Alternative Name",
"ssn": "5555",
"home": {
"address1": "123 B Street",
"address2": "Apt A",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"beneficial_owner1": {
"title": "Ms",
"dob": "1982-07-23T05:36:00Z",
"ssn": "123456789",
"phone": "5105551212",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"home": {
"address1": "123 B Street",
"address2": "Apt A",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"beneficial_owner2": {
"title": "Ms",
"dob": "1973-11-11T11:11:11Z",
"ssn": "234567891",
"phone": "5105551213",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"home": {
"address1": "4321 Grove Street",
"address2": "Suite 123",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"beneficial_owner3": {
"title": "Ms",
"dob": "1981-02-14T15:16:17Z",
"ssn": "345678912",
"phone": "5105551214",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"home": {
"address1": "789 Pulgas Ave",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"beneficial_owner4": {
"title": "Dr",
"dob": "1954-03-07T15:16:17Z",
"ssn": "456789123",
"phone": "5105551215",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"home": {
"address1": "16 Poplar Street",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"attester_name": "Jane Smith",
"attester_title": "Chief Executive Officer",
"attestation_date": "2025-03-03T00:01:00Z"
}
Response body
| Fields | Description |
|---|---|
| account_holder_group_token string Conditionally returned | Associates the specified account holder group with the business. This field is returned if it exists in the resource. Allowable Values: 36 char max |
| active boolean Conditionally returned | Specifies if the business is in the ACTIVE state on the Marqeta platform.This field is returned if it exists in the resource. Allowable Values: true, false |
| attestation_consent boolean Conditionally returned | Indicates that the attester agrees that the information provided is correct and truthful. This field is returned if it exists in the resource. Allowable Values: true, false |
| attestation_date datetime Conditionally returned | Timestamp of the attestation. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| attester_name string Conditionally returned | Name of the attester for KYC verification. This field is returned if it exists in the resource. Allowable Values: 64 char max |
| attester_title string Conditionally returned | Title of the attester for KYC verification. This field is returned if it exists in the resource. Allowable Values: 64 char max |
| authentication object Conditionally returned | Contains metadata about the business’s email verification and password updates. Allowable Values: email_verified, email_verified_time, last_password_update_channel, last_password_update_time |
| authentication.email_verified boolean Conditionally returned | Specifies whether the email address has been verified. Allowable Values: true, false |
| authentication.email_verified_time datetime Conditionally returned | Date and time when the email address was verified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| authentication.last_password_update_channel string Conditionally returned | Specifies the channel through which the password was last changed. Allowable Values: USER_CHANGE, USER_RESET |
| authentication.last_password_update_time datetime Conditionally returned | Date and time when the password was last changed. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| beneficial_owner1 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner1.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner1.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner1.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner1.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner1.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner1.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner1.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner1.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner1.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner1.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner1.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner1.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner1.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner2.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner2.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner2.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner2.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner2.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner2.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner2.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner2.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner2.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner2.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner2.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner2.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner2.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner3.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner3.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner3.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner3.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner3.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner3.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner3.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner3.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner3.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner3.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner3.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner3.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner3.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner4.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner4.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner4.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner4.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner4.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner4.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner4.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner4.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner4.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner4.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner4.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner4.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner4.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| business_name_dba string Conditionally returned | Fictitious business name (“Doing Business As” or DBA). This field is returned if it exists in the resource. Allowable Values: 255 char max |
| business_name_legal string Conditionally returned | Legal name of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| business_type string Conditionally returned | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). This field is returned if it exists in the resource. Allowable Values: 255 char max |
| created_time datetime Returned | Date and time when the business was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| date_established datetime Conditionally returned | Date and time when the business was established. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| duns_number string Conditionally returned | Data Universal Numbering System (DUNS) number of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| general_business_description string Conditionally returned | General description of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| history string Conditionally returned | History of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing identifications associated with the business. Objects are returned if they exist in the resource. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| in_current_location_since datetime Conditionally returned | Date on which the business office opened in its current location. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| incorporation object Conditionally returned | Contains information about the organizational structure of the business. Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| incorporation.address_registered_under object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| incorporation.address_registered_under.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| incorporation.address_registered_under.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| incorporation.address_registered_under.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| incorporation.incorporation_type string Conditionally returned | Organizational structure of the business (corporation or sole proprietorship, for example). This field is returned if it exists in the resource. Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| incorporation.is_public boolean Conditionally returned | A value of true indicates that the business is publicly held.This field is returned if it exists in the resource. Allowable Values: true, false |
| incorporation.is_regulated_entity boolean Conditionally returned | A value of true indicates that the business is a regulated entity.This field is returned if it exists in the resource. Allowable Values: true, false |
| incorporation.name_registered_under string Conditionally returned | Name under which the business is registered. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| incorporation.state_of_incorporation string Conditionally returned | State, province, territory, or federation where the business is incorporated. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| incorporation.stock_symbol string Conditionally returned | Stock symbol associated with the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| international_office_locations string Conditionally returned | Locations of the business’ offices outside the US. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| ip_address string Conditionally returned | IP address of the business. This field is returned if it exists in the resource. Allowable Values: 39 char max |
| last_modified_time datetime Returned | Date and time when the business was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| metadata object Conditionally returned | Associates any additional metadata you provide with the business. Metadata is returned if it exists in the resource. Allowable Values: Existing metadata object |
| notes string Conditionally returned | Any additional information pertaining to the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| office_location object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| office_location.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| office_location.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| office_location.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| password string Conditionally returned | Password for the business account on the Marqeta platform. This field is returned if it exists in the resource. Allowable Values: 1–255 chars |
| phone string Conditionally returned | 10-digit telephone number of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| primary_contact object Conditionally returned | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| primary_contact.department string Conditionally returned | Business department of the primary contact. Allowable Values: 255 char max |
| primary_contact.email string Conditionally returned | Email address of the primary contact. Allowable Values: 255 char max |
| primary_contact.extension string Conditionally returned | Phone extension of the primary contact. Allowable Values: 255 char max |
| primary_contact.fax string Conditionally returned | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.full_name string Conditionally returned | Full name of the primary contact. Allowable Values: 255 char max |
| primary_contact.mobile string Conditionally returned | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.phone string Conditionally returned | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.title string Conditionally returned | Title of the primary contact. Allowable Values: 255 char max |
| proprietor_is_beneficial_owner boolean Conditionally returned | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is returned if it exists in the resource. Allowable Values: true, false |
| proprietor_or_officer object Conditionally returned | Contains information about the proprietor or officer of the business. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| proprietor_or_officer.alternative_names string Conditionally returned | Alternate names of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.birth_place string Conditionally returned | Country of birth of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| proprietor_or_officer.dob datetime Conditionally returned | Business proprietor or officer’s date of birth. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| proprietor_or_officer.email string Conditionally returned | Email address of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.first_name string Conditionally returned | First name of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| proprietor_or_officer.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| proprietor_or_officer.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| proprietor_or_officer.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| proprietor_or_officer.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| proprietor_or_officer.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| proprietor_or_officer.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| proprietor_or_officer.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| proprietor_or_officer.last_name string Conditionally returned | Last name of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.middle_name string Conditionally returned | Middle name of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.nationality string Conditionally returned | Nationality of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| proprietor_or_officer.phone string Conditionally returned | Telephone number of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| proprietor_or_officer.ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| proprietor_or_officer.title string Conditionally returned | Title of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| status string Conditionally returned | Specifies the state of the business on the Marqeta platform. This field is returned if it exists in the resource. Allowable Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| taxpayer_id string Conditionally returned | Taxpayer identifier of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business resource. This field is always returned. Allowable Values: 1–36 chars |
| website string Conditionally returned | URL of the business’ website. This field is returned if it exists in the resource. Allowable Values: 255 char max |
Sample response body
JSON
{
"token": "my_business_02",
"active": true,
"notes": "My notes",
"ip_address": "67.120.28.118",
"password": "My_passw0rd",
"phone": "5105551212",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A Street",
"address2": "Suite 123",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"in_current_location_since": "2010-04-15T00:01:00Z",
"website": "https://my_business_02.com",
"date_established": "2010-04-15T00:01:00Z",
"general_business_description": "44112 - Used Car Dealers",
"history": "My_business_history",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"identifications": [
{
"type": "BUSINESS_TAX_ID",
"value": "123456789"
}
],
"duns_number": "987654321",
"primary_contact": {
"full_name": "First Middle Last",
"title": "Dr",
"department": "My_department",
"phone": "5105551212",
"extension": "11",
"fax": "5105551222",
"mobile": "5105551213",
"email": "dr.me@my.business.com"
},
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B Street",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"incorporation_type": "LLC"
},
"proprietor_or_officer": {
"title": "Mr",
"dob": "1985-01-08T00:00:00Z",
"phone": "5105551211",
"email": "mr.myself@my.business.com",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My Alternative Name",
"ssn": "5555",
"home": {
"address1": "123 B Street",
"address2": "Apt A",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"created_time": "2025-01-13T23:29:10Z",
"last_modified_time": "2025-01-13T23:29:10Z",
"deposit_account": {
"x-mq-internal": true,
"token": "420df02a-6aef-42bf-be7b-0d080ebf7573",
"account_number": "12342126720827265",
"routing_number": "293748000"
},
"status": "ACTIVE"
}
List businesses
Action:GETEndpoint:
/businesses
To return an array of all businesses, send a GET request to the /businesses endpoint.
To narrow your result set to businesses that match a particular legal or fictitious name, include the appropriate parameters from the following query parameters table. This endpoint also supports field filtering and sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of business resources to retrieve. Allowable Values: 1-10 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| business_name_dba string Optional | Fictitious or “doing business as (DBA)” name of the business. Allowable Values: Existing DBA name of the business |
| business_name_legal string Optional | Legal name of the business. Allowable Values: Existing legal name of the business |
| search_type string Optional | Specifies the search type for the query. Allowable Values: query_then_fetch, dfs_query_then_fetch |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -lastModifiedTime |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | Array of business objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more business objects |
| data[].account_holder_group_token string Conditionally returned | Existing account holder group token that associates the specified account holder group with the business. Send a GET request to /accountholdergroups to retrieve account holder group tokens.Allowable Values: 36 char max |
| data[].active boolean Conditionally returned | Specifies if the business is in the ACTIVE state on the Marqeta platform.Allowable Values: true, falseDefault value: true |
| data[].attestation_consent boolean Conditionally returned | Indicates that the attester agrees that the information provided is correct and truthful. This field is required for KYC verification (US-based accounts only). Allowable Values: true, false |
| data[].attestation_date datetime Conditionally returned | Timestamp of the attestation. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| data[].attester_name string Conditionally returned | Name of the attester for KYC verification. This field is required for KYC verification (US-based accounts only). Allowable Values: 64 char max |
| data[].attester_title string Conditionally returned | Title of the attester for KYC verification. Allowable Values: 64 char max |
| data[].beneficial_owner1 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| data[].beneficial_owner1.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner1.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner1.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| data[].beneficial_owner1.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner1.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].beneficial_owner1.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].beneficial_owner1.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].beneficial_owner1.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].beneficial_owner1.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].beneficial_owner1.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].beneficial_owner1.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].beneficial_owner1.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].beneficial_owner1.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| data[].beneficial_owner1.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner1.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].beneficial_owner1.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner1.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner1.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner1.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner1.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| data[].beneficial_owner1.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| data[].beneficial_owner1.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner1.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner2 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| data[].beneficial_owner2.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner2.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner2.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| data[].beneficial_owner2.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner2.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].beneficial_owner2.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].beneficial_owner2.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].beneficial_owner2.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].beneficial_owner2.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].beneficial_owner2.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].beneficial_owner2.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].beneficial_owner2.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].beneficial_owner2.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| data[].beneficial_owner2.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner2.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].beneficial_owner2.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner2.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner2.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner2.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner2.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| data[].beneficial_owner2.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| data[].beneficial_owner2.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner2.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner3 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| data[].beneficial_owner3.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner3.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner3.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| data[].beneficial_owner3.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner3.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].beneficial_owner3.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].beneficial_owner3.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].beneficial_owner3.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].beneficial_owner3.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].beneficial_owner3.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].beneficial_owner3.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].beneficial_owner3.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].beneficial_owner3.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| data[].beneficial_owner3.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner3.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].beneficial_owner3.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner3.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner3.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner3.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner3.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| data[].beneficial_owner3.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| data[].beneficial_owner3.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner3.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner4 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| data[].beneficial_owner4.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner4.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner4.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| data[].beneficial_owner4.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner4.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].beneficial_owner4.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].beneficial_owner4.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].beneficial_owner4.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].beneficial_owner4.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].beneficial_owner4.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].beneficial_owner4.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].beneficial_owner4.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].beneficial_owner4.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| data[].beneficial_owner4.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].beneficial_owner4.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].beneficial_owner4.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner4.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].beneficial_owner4.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| data[].beneficial_owner4.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].beneficial_owner4.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| data[].beneficial_owner4.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| data[].beneficial_owner4.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| data[].beneficial_owner4.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| data[].business_name_dba string Conditionally returned | Fictitious business name (“Doing Business As” or DBA). This field is required for KYC verification (US-based accounts only). If your business does not use a fictitious business name, enter your legal business name again in this field. Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| data[].business_name_legal string Conditionally returned | Legal name of business. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| data[].business_type string Conditionally returned | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). Allowable Values: 255 char max |
| data[].date_established datetime Conditionally returned | Date when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| data[].duns_number string Conditionally returned | Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
| data[].general_business_description string Conditionally returned | Required for KYC verification (US-based cardholders only). Business description must adhere to the NAICS standard, as defined by the United States Census Bureau. You must provide at least the description; NAICS codes are optional. For example, Used Car Dealers or 44112 - Used Car Dealers.This field is returned if it exists in the resource. Allowable Values: 255 char max |
| data[].history string Conditionally returned | History of the business. Allowable Values: 255 char max |
| data[].identifications array of objects Conditionally returned | One or more objects containing identifications associated with the business. Allowable Values: Valid array of one or more identifications objects |
| data[].identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| data[].in_current_location_since datetime Conditionally returned | Date on which the business office opened in its current location. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| data[].incorporation object Conditionally returned | Contains information about the organizational structure of the business. This object is required for KYC verification (US-based accounts only). Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| data[].incorporation.address_registered_under object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].incorporation.address_registered_under.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].incorporation.address_registered_under.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].incorporation.address_registered_under.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].incorporation.address_registered_under.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].incorporation.address_registered_under.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].incorporation.address_registered_under.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].incorporation.address_registered_under.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].incorporation.incorporation_type string Conditionally returned | Organizational structure of the business, such as corporation or sole proprietorship. This field is required for KYC verification (US-based accounts only). Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, COOPERATIVE, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| data[].incorporation.is_public boolean Conditionally returned | A value of true indicates that the business is publicly held.Allowable Values: true, falseDefault value: false |
| data[].incorporation.is_regulated_entity boolean Conditionally returned | A value of true indicates that the business is a regulated entity.Allowable Values: true, false |
| data[].incorporation.name_registered_under string Conditionally returned | Name under which the business is registered. Allowable Values: 255 char max |
| data[].incorporation.state_of_incorporation string Conditionally returned | State, province, territory, or federation where the business is incorporated. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max Valid state, provincial, territorial, or federal abbreviation required for KYC verification ( CA for California or CAN for Canada, for example); 255 char max otherwise |
| data[].incorporation.stock_symbol string Conditionally returned | Business stock symbol. Allowable Values: 255 char max |
| data[].international_office_locations string Conditionally returned | Locations of the business’ offices outside the US. Allowable Values: 255 char max |
| data[].ip_address string Conditionally returned | IP address of the business. Allowable Values: 39 char max |
| data[].metadata object Conditionally returned | Associates any additional metadata you provide with the business. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1" |
| data[].notes string Conditionally returned | Any additional information pertaining to the business. Allowable Values: 255 char max |
| data[].office_location object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].office_location.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].office_location.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].office_location.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].office_location.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].office_location.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].office_location.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].office_location.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].password string Conditionally returned | Password for the business account on the Marqeta platform. Allowable Values: 1–255 chars - Must contain at least one numeral - Must contain at least one lowercase letter - Must contain at least one uppercase letter - Must contain at least one of these symbols: @``#``$``%``!``^``&``*``(``)\\``_``+``~``-``=``[``]``\{``},``;``:``'``"``.``/``<``>``?` |
| data[].phone string Conditionally returned | 10-digit telephone number of business. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| data[].primary_contact object Conditionally returned | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| data[].primary_contact.department string Conditionally returned | Business department of the primary contact. Allowable Values: 255 char max |
| data[].primary_contact.email string Conditionally returned | Email address of the primary contact. Allowable Values: 255 char max |
| data[].primary_contact.extension string Conditionally returned | Phone extension of the primary contact. Allowable Values: 255 char max |
| data[].primary_contact.fax string Conditionally returned | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| data[].primary_contact.full_name string Conditionally returned | Full name of the primary contact. Allowable Values: 255 char max |
| data[].primary_contact.mobile string Conditionally returned | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| data[].primary_contact.phone string Conditionally returned | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| data[].primary_contact.title string Conditionally returned | Title of the primary contact. Allowable Values: 255 char max |
| data[].proprietor_is_beneficial_owner boolean Conditionally returned | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is required for KYC verification if the business proprietor or officer is also a beneficial owner. Allowable Values: true, falseDefault value: false |
| data[].proprietor_or_officer object Conditionally returned | Contains information about the proprietor or officer of the business. This object is required for KYC verification of proprietors or officers of privately held businesses in the United States. This object is not required for publicly held businesses. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| data[].proprietor_or_officer.alternative_names string Conditionally returned | Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
| data[].proprietor_or_officer.birth_place string Conditionally returned | Country of birth of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].proprietor_or_officer.dob datetime Conditionally returned | Business proprietor or officer’s date of birth. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| data[].proprietor_or_officer.email string Conditionally returned | Email address of the business proprietor or officer. Allowable Values: 255 char max |
| data[].proprietor_or_officer.first_name string Returned | First name of business proprietor or officer. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].proprietor_or_officer.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| data[].proprietor_or_officer.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| data[].proprietor_or_officer.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| data[].proprietor_or_officer.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| data[].proprietor_or_officer.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| data[].proprietor_or_officer.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| data[].proprietor_or_officer.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| data[].proprietor_or_officer.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| data[].proprietor_or_officer.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid array of one or more identifications objects |
| data[].proprietor_or_officer.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].proprietor_or_officer.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].proprietor_or_officer.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| data[].proprietor_or_officer.last_name string Returned | Last name of business proprietor or officer. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| data[].proprietor_or_officer.middle_name string Conditionally returned | Middle name of business proprietor or officer. Allowable Values: 255 char max |
| data[].proprietor_or_officer.nationality string Conditionally returned | Nationality of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].proprietor_or_officer.phone string Conditionally returned | Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 Do not insert a 1 before the area code. |
| data[].proprietor_or_officer.ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. Allowable Values: Nine digits, no delimiters. 123456789, for example. |
| data[].proprietor_or_officer.title string Conditionally returned | Title of business proprietor or officer. Allowable Values: 255 char max |
| data[].taxpayer_id string Conditionally returned | Taxpayer identifier of the business. Allowable Values: 255 char max |
| data[].token string Conditionally returned | Unique identifier of the business resource. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
| data[].website string Conditionally returned | URL of the business’ website. Allowable Values: 255 char max |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": true,
"data": [
{
"token": "my_business_01",
"active": true,
"notes": "My notes",
"password": "My_passw0rd",
"phone": "5105551215",
"website": "https://my_business.com",
"history": "My_business_history",
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B Street",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"incorporation_type": "LLC"
},
"ip_address": "67.120.28.118",
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A Street",
"address2": "Suite 123",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"in_current_location_since": "2010-04-15T00:01:00Z",
"date_established": "2010-04-15T00:01:00Z",
"general_business_description": "44112 - Used Car Dealers",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"identifications": [
{
"type": "BUSINESS_TAX_ID",
"value": "123456789"
}
],
"duns_number": "123456789",
"primary_contact": {
"title": "Dr",
"department": "My_department",
"phone": "5105551215",
"extension": "11",
"fax": "5105551216",
"email": "dr_me@my_business.com",
"full_name": "First Middle Last",
"mobile": "5105551217"
},
"proprietor_or_officer": {
"title": "Mr",
"dob": "1985-01-08T00:00:00Z",
"phone": "5105551211",
"email": "mr.myself@my.business.com",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My Alternative Name",
"ssn": "5555",
"home": {
"address1": "123 B Street",
"address2": "Apt A",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"created_time": "2024-10-18T21:17:03Z",
"last_modified_time": "2024-10-19T22:48:02Z",
"status": "ACTIVE"
}
]
}
Search businesses
Action:POSTEndpoint:
/businesses/lookup
To search for one or more businesses, send a POST request to the /businesses/lookup endpoint. Include in the message body any parameters by which you want to query. This endpoint supports field filtering and pagination.
Request body
| Fields | Description |
|---|---|
| dda string Required | Deposit account number of the business. Allowable Values: 17 char max Send a GET request to /directdeposits/accounts/{business_token} to retrieve the deposit account number for a specific business.Send a GET request to /businesses to retrieve business tokens. |
Sample request body
JSON
{
"dda": "2129923205648"
}
Response body
| Fields | Description |
|---|---|
| account_holder_group_token string Conditionally returned | Existing account holder group token that associates the specified account holder group with the business. Send a GET request to /accountholdergroups to retrieve account holder group tokens.Allowable Values: 36 char max |
| active boolean Conditionally returned | Specifies if the business is in the ACTIVE state on the Marqeta platform.Allowable Values: true, falseDefault value: true |
| attestation_consent boolean Conditionally returned | Indicates that the attester agrees that the information provided is correct and truthful. This field is required for KYC verification (US-based accounts only). Allowable Values: true, false |
| attestation_date datetime Conditionally returned | Timestamp of the attestation. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| attester_name string Conditionally returned | Name of the attester for KYC verification. This field is required for KYC verification (US-based accounts only). Allowable Values: 64 char max |
| attester_title string Conditionally returned | Title of the attester for KYC verification. Allowable Values: 64 char max |
| beneficial_owner1 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner1.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner1.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner1.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner1.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner1.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner1.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner1.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner1.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner1.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner1.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner1.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner1.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner1.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner1.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner1.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner2.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner2.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner2.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner2.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner2.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner2.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner2.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner2.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner2.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner2.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner2.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner2.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner2.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner2.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner3.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner3.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner3.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner3.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner3.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner3.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner3.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner3.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner3.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner3.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner3.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner3.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner3.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner3.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner4.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner4.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner4.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner4.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner4.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner4.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner4.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner4.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner4.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner4.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner4.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner4.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner4.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner4.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| business_name_dba string Conditionally returned | Fictitious business name (“Doing Business As” or DBA). This field is required for KYC verification (US-based accounts only). If your business does not use a fictitious business name, enter your legal business name again in this field. Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_name_legal string Conditionally returned | Legal name of business. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_type string Conditionally returned | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). Allowable Values: 255 char max |
| date_established datetime Conditionally returned | Date when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| duns_number string Conditionally returned | Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
| general_business_description string Conditionally returned | Required for KYC verification (US-based cardholders only). Business description must adhere to the NAICS standard, as defined by the United States Census Bureau. You must provide at least the description; NAICS codes are optional. For example, Used Car Dealers or 44112 - Used Car Dealers.This field is returned if it exists in the resource. Allowable Values: 255 char max |
| history string Conditionally returned | History of the business. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing identifications associated with the business. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| in_current_location_since datetime Conditionally returned | Date on which the business office opened in its current location. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| incorporation object Conditionally returned | Contains information about the organizational structure of the business. This object is required for KYC verification (US-based accounts only). Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| incorporation.address_registered_under object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| incorporation.address_registered_under.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| incorporation.address_registered_under.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| incorporation.address_registered_under.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| incorporation.address_registered_under.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| incorporation.address_registered_under.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| incorporation.address_registered_under.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| incorporation.address_registered_under.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| incorporation.incorporation_type string Conditionally returned | Organizational structure of the business, such as corporation or sole proprietorship. This field is required for KYC verification (US-based accounts only). Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, COOPERATIVE, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| incorporation.is_public boolean Conditionally returned | A value of true indicates that the business is publicly held.Allowable Values: true, falseDefault value: false |
| incorporation.is_regulated_entity boolean Conditionally returned | A value of true indicates that the business is a regulated entity.Allowable Values: true, false |
| incorporation.name_registered_under string Conditionally returned | Name under which the business is registered. Allowable Values: 255 char max |
| incorporation.state_of_incorporation string Conditionally returned | State, province, territory, or federation where the business is incorporated. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max Valid state, provincial, territorial, or federal abbreviation required for KYC verification ( CA for California or CAN for Canada, for example); 255 char max otherwise |
| incorporation.stock_symbol string Conditionally returned | Business stock symbol. Allowable Values: 255 char max |
| international_office_locations string Conditionally returned | Locations of the business’ offices outside the US. Allowable Values: 255 char max |
| ip_address string Conditionally returned | IP address of the business. Allowable Values: 39 char max |
| metadata object Conditionally returned | Associates any additional metadata you provide with the business. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1" |
| notes string Conditionally returned | Any additional information pertaining to the business. Allowable Values: 255 char max |
| office_location object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| office_location.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| office_location.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| office_location.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| office_location.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| office_location.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| office_location.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| office_location.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| password string Conditionally returned | Password for the business account on the Marqeta platform. Allowable Values: 1–255 chars - Must contain at least one numeral - Must contain at least one lowercase letter - Must contain at least one uppercase letter - Must contain at least one of these symbols: @``#``$``%``!``^``&``*``(``)\\``_``+``~``-``=``[``]``\{``},``;``:``'``"``.``/``<``>``?` |
| phone string Conditionally returned | 10-digit telephone number of business. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact object Conditionally returned | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| primary_contact.department string Conditionally returned | Business department of the primary contact. Allowable Values: 255 char max |
| primary_contact.email string Conditionally returned | Email address of the primary contact. Allowable Values: 255 char max |
| primary_contact.extension string Conditionally returned | Phone extension of the primary contact. Allowable Values: 255 char max |
| primary_contact.fax string Conditionally returned | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.full_name string Conditionally returned | Full name of the primary contact. Allowable Values: 255 char max |
| primary_contact.mobile string Conditionally returned | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.phone string Conditionally returned | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.title string Conditionally returned | Title of the primary contact. Allowable Values: 255 char max |
| proprietor_is_beneficial_owner boolean Conditionally returned | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is required for KYC verification if the business proprietor or officer is also a beneficial owner. Allowable Values: true, falseDefault value: false |
| proprietor_or_officer object Conditionally returned | Contains information about the proprietor or officer of the business. This object is required for KYC verification of proprietors or officers of privately held businesses in the United States. This object is not required for publicly held businesses. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| proprietor_or_officer.alternative_names string Conditionally returned | Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.birth_place string Conditionally returned | Country of birth of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.dob datetime Conditionally returned | Business proprietor or officer’s date of birth. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| proprietor_or_officer.email string Conditionally returned | Email address of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.first_name string Returned | First name of business proprietor or officer. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| proprietor_or_officer.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| proprietor_or_officer.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| proprietor_or_officer.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| proprietor_or_officer.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| proprietor_or_officer.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| proprietor_or_officer.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| proprietor_or_officer.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| proprietor_or_officer.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid array of one or more identifications objects |
| proprietor_or_officer.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| proprietor_or_officer.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| proprietor_or_officer.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| proprietor_or_officer.last_name string Returned | Last name of business proprietor or officer. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.middle_name string Conditionally returned | Middle name of business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.nationality string Conditionally returned | Nationality of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.phone string Conditionally returned | Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 Do not insert a 1 before the area code. |
| proprietor_or_officer.ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. Allowable Values: Nine digits, no delimiters. 123456789, for example. |
| proprietor_or_officer.title string Conditionally returned | Title of business proprietor or officer. Allowable Values: 255 char max |
| taxpayer_id string Conditionally returned | Taxpayer identifier of the business. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business resource. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
| website string Conditionally returned | URL of the business’ website. Allowable Values: 255 char max |
Sample response body
JSON
{
"token": "297aa1a7-f3c9-46eb-9e0a-54f8bce0c189",
"active": true,
"phone": "5105551218",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"account_holder_group_token": "DEFAULT_AHG",
"created_time": "2024-06-20T00:17:48Z",
"last_modified_time": "2024-06-20T00:17:48Z",
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "111 Main St",
"address2": "Suite B",
"city": "Berkeley",
"state": "CA",
"postal_code": "94702",
"country": "USA"
},
"date_established": "2010-01-01T00:01:00Z",
"business_type": "other",
"duns_number": "22344566",
"primary_contact": {
"full_name": "First Middle Last",
"title": "Mr.",
"department": "Accounts Payable",
"phone": "5105551218",
"extension": "234",
"fax": "5105551219",
"mobile": "5105551220",
"email": "me@my.company.com"
},
"incorporation": {
"state_of_incorporation": "CA,",
"incorporation_type": "CORPORATION"
},
"identifications": [
{
"type": "BUSINESS_TAX_ID",
"value": "11-1111111"
}
]
}
Create business director
Action:POSTEndpoint:
/businesses/{business_token}/directors
Create a business director resource.
URL path parameters
| Fields | Description |
|---|---|
| business_token string Required | Unique identifier of the business resource. Allowable Values: Existing business token |
Request body
| Fields | Description |
|---|---|
| active boolean Optional | Indicates whether the business director is active. Allowable Values: true, false |
| address object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Optional | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Optional | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Optional | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Optional | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Optional | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Optional | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Optional | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Optional | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| email string Optional | Email address of the business director. Allowable Values: 1–255 chars |
| first_name string Optional | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Optional | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| last_name string Optional | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Optional | Middle name of the business director. Allowable Values: 40 char max |
| nationality string Optional | Nationality of the business director. Allowable Values: 255 char max |
| phone string Optional | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Optional | Business director’s place of birth. Allowable Values: 255 char max |
| title string Optional | Title of the business director. Allowable Values: 1–255 chars |
| token string Optional | Unique identifier of the business director resource. Allowable Values: 1–36 chars |
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Indicates whether the business director is active. Allowable Values: true, false |
| address object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Conditionally returned | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the business director resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| email string Conditionally returned | Email address of the business director. Allowable Values: 255 char max |
| first_name string Conditionally returned | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| last_modified_time datetime Returned | Date and time when the business director resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_name string Conditionally returned | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Conditionally returned | Middle name of the business director. Allowable Values: 255 char max |
| nationality string Conditionally returned | Nationality of the business director. Allowable Values: 255 char max |
| phone string Conditionally returned | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Conditionally returned | Business director’s place of birth. Allowable Values: 255 char max |
| title string Conditionally returned | Title of the business director. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business director resource. Allowable Values: 36 char max |
List business directors
Action:GETEndpoint:
/businesses/{business_token}/directors
List resources for the directors of a business.
URL path parameters
| Fields | Description |
|---|---|
| business_token string Required | Unique identifier of the business resource. Allowable Values: Existing business token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of business director resources to retrieve. Allowable Values: 1-10 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -createdTime |
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Indicates whether the business director is active. Allowable Values: true, false |
| address object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Conditionally returned | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the business director resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| email string Conditionally returned | Email address of the business director. Allowable Values: 255 char max |
| first_name string Conditionally returned | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| last_modified_time datetime Returned | Date and time when the business director resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_name string Conditionally returned | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Conditionally returned | Middle name of the business director. Allowable Values: 255 char max |
| nationality string Conditionally returned | Nationality of the business director. Allowable Values: 255 char max |
| phone string Conditionally returned | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Conditionally returned | Business director’s place of birth. Allowable Values: 255 char max |
| title string Conditionally returned | Title of the business director. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business director resource. Allowable Values: 36 char max |
Update business director
Action:PUTEndpoint:
/businesses/{business_token}/directors/{token}
Update a business director resource.
URL path parameters
| Fields | Description |
|---|---|
| business_token string Required | Unique identifier of the business resource. Allowable Values: Existing business token |
| token string Required | Unique identifier of the business director resource. Allowable Values: Existing business director token |
Request body
| Fields | Description |
|---|---|
| active boolean Optional | Indicates whether the business director is active. Allowable Values: true, false |
| address object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Optional | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Optional | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Optional | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Optional | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Optional | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Optional | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Optional | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Optional | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| email string Optional | Email address of the business director. Allowable Values: 1–255 chars |
| first_name string Optional | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Optional | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| last_name string Optional | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Optional | Middle name of the business director. Allowable Values: 40 char max |
| nationality string Optional | Nationality of the business director. Allowable Values: 255 char max |
| phone string Optional | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Optional | Business director’s place of birth. Allowable Values: 255 char max |
| title string Optional | Title of the business director. Allowable Values: 1–255 chars |
| token string Optional | Unique identifier of the business director resource. Allowable Values: 1–36 chars |
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Indicates whether the business director is active. Allowable Values: true, false |
| address object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Conditionally returned | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the business director resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| email string Conditionally returned | Email address of the business director. Allowable Values: 255 char max |
| first_name string Conditionally returned | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| last_modified_time datetime Returned | Date and time when the business director resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_name string Conditionally returned | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Conditionally returned | Middle name of the business director. Allowable Values: 255 char max |
| nationality string Conditionally returned | Nationality of the business director. Allowable Values: 255 char max |
| phone string Conditionally returned | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Conditionally returned | Business director’s place of birth. Allowable Values: 255 char max |
| title string Conditionally returned | Title of the business director. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business director resource. Allowable Values: 36 char max |
Retrieve business director
Action:GETEndpoint:
/businesses/{business_token}/directors/{token}
Retrieve a business director resource.
URL path parameters
| Fields | Description |
|---|---|
| business_token string Required | Unique identifier of the business resource. Allowable Values: Existing business token |
| token string Required | Unique identifier of the business director resource. Allowable Values: Existing business director token |
URL query parameters
| Fields | Description |
|---|---|
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Indicates whether the business director is active. Allowable Values: true, false |
| address object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Conditionally returned | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the business director resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| email string Conditionally returned | Email address of the business director. Allowable Values: 255 char max |
| first_name string Conditionally returned | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| last_modified_time datetime Returned | Date and time when the business director resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_name string Conditionally returned | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Conditionally returned | Middle name of the business director. Allowable Values: 255 char max |
| nationality string Conditionally returned | Nationality of the business director. Allowable Values: 255 char max |
| phone string Conditionally returned | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Conditionally returned | Business director’s place of birth. Allowable Values: 255 char max |
| title string Conditionally returned | Title of the business director. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business director resource. Allowable Values: 36 char max |
Retrieve business director tax identifier
Action:GETEndpoint:
/businesses/{business_token}/directors/{token}/identifications
Retrieve the tax identifier of a business director.
URL path parameters
| Fields | Description |
|---|---|
| business_token string Required | Unique identifier of the business resource. Allowable Values: Existing business token |
| token string Required | Unique identifier of the business director resource. Allowable Values: Existing business director token |
URL query parameters
| Fields | Description |
|---|---|
| full_ssn boolean Optional | To return the full identification number, set to true. To return only the last four digits, set to false. If the identifications array contains only the last four digits of the identification number, the /businesses/{business_token}/directors/{token}/identifications endpoint will return only the last four digits regardless of the full_ssn parameter.Allowable Values: true, false |
Response body
| Fields | Description |
|---|---|
| nin string Conditionally returned | National Identification Number (NIN). Allowable Values: 255 char max |
| sin string Conditionally returned | Social Insurance Number (SIN). Allowable Values: 255 char max |
| ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). Allowable Values: 255 char max |
| tin string Conditionally returned | Taxpayer Identification Number (TIN). Allowable Values: 255 char max |
List business children
Action:GETEndpoint:
/businesses/{parent_token}/children
To return an array of all child cardholders of a particular business, send a GET request to the /businesses/{parent_token}/children endpoint. Include the parent_token as a URL path parameter.
This endpoint supports field filtering.
URL path parameters
| Fields | Description |
|---|---|
| parent_token string Required | Unique identifier of the parent business. Allowable Values: Existing business resource token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of child cardholders to retrieve. Allowable Values: 1-10 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -lastModifiedTime |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of user resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | Array of user objects. Objects are returned as appropriate to your query. Allowable Values: One or more user objects |
| data[].account_holder_group_token string Conditionally returned | Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
| data[].active boolean Conditionally returned | Specifies if the cardholder is in the ACTIVE state on the Marqeta platform.Allowable Values: true, false |
| data[].address1 string Conditionally returned | Cardholder’s address. Allowable Values: 255 char max |
| data[].address2 string Conditionally returned | Additional address information for the cardholder. Allowable Values: 255 char max |
| data[].authentication object Conditionally returned | Contains the cardholder’s email address and password information. Allowable Values: email_verified, email_verified_time, last_password_update_channel, last_password_update_time |
| data[].authentication.email_verified boolean Conditionally returned | Specifies whether the email address has been verified. Allowable Values: true, false |
| data[].authentication.email_verified_time datetime Conditionally returned | Date and time when the email address was verified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].authentication.last_password_update_channel string Conditionally returned | Specifies the channel through which the password was last changed. Allowable Values: USER_CHANGE, USER_RESET |
| data[].authentication.last_password_update_time datetime Conditionally returned | Date and time when the password was last changed. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].birth_date string Conditionally returned | Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| data[].birth_place string Conditionally returned | Country where the cardholder was born. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| data[].business_token string Conditionally returned | Unique identifier of the business resource. Allowable Values: Existing business resource token |
| data[].city string Conditionally returned | City where the cardholder resides. Allowable Values: 40 char max |
| data[].company string Conditionally returned | Company name. Allowable Values: 255 char max |
| data[].corporate_card_holder boolean Conditionally returned | Specifies if the cardholder holds a corporate card. Allowable Values: true, false |
| data[].country string Conditionally returned | Country where the cardholder resides. Allowable Values: 40 char max |
| data[].created_time datetime Returned | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].email string Conditionally returned | Valid email address of the cardholder. Allowable Values: 1–255 chars |
| data[].first_name string Conditionally returned | Cardholder’s first name. Allowable Values: 40 char max |
| data[].gender string Conditionally returned | Gender of the cardholder. Allowable Values: F, M |
| data[].honorific string Conditionally returned | Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on. Allowable Values: 10 char max |
| data[].id_card_expiration_date string Conditionally returned | Expiration date of the cardholder’s identification. Allowable Values: Format: yyyy-MM-dd |
| data[].id_card_number string Conditionally returned | Cardholder’s identification card number. Allowable Values: 255 char max |
| data[].identifications array of objects Conditionally returned | One or more objects containing identifications associated with the cardholder. Allowable Values: Valid array of one or more identifications objects |
| data[].identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| data[].identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| data[].identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| data[].ip_address string Conditionally returned | Cardholder’s IP address. Allowable Values: 39 char max |
| data[].last_modified_time datetime Returned | Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].last_name string Conditionally returned | Cardholder’s last name. Allowable Values: 40 char max |
| data[].metadata object Conditionally returned | Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1" |
| data[].middle_name string Conditionally returned | Cardholder’s middle name. Allowable Values: 40 char max |
| data[].nationality string Conditionally returned | Cardholder’s nationality. Allowable Values: 255 char max |
| data[].notes string Conditionally returned | Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
| data[].parent_token string Conditionally returned | Unique identifier of the parent user or business resource. Allowable Values: 1–36 chars |
| data[].passport_expiration_date string Conditionally returned | Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
| data[].passport_number string Conditionally returned | Cardholder’s passport number. Allowable Values: 40 char max |
| data[].password string Conditionally returned | Password to the cardholder’s user account on the Marqeta platform. Allowable Values: 1–255 chars |
| data[].phone string Conditionally returned | Cardholder’s telephone number. Allowable Values: 255 char max |
| data[].postal_code string Conditionally returned | Postal code of the cardholder’s address. Allowable Values: 10 char max |
| data[].ssn string Conditionally returned | Cardholder’s Social Security Number (SSN). Allowable Values: Nine digits only, no delimiters. |
| data[].state string Conditionally returned | State or province where the cardholder resides. Allowable Values: 2 char max |
| data[].status string Conditionally returned | Specifies the status of the cardholder on the Marqeta platform. Allowable Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| data[].title string Conditionally returned | Professional title of the cardholder, such as Chief Comptroller. Allowable Values: 255 char max |
| data[].token string Conditionally returned | Unique identifier of the cardholder. Allowable Values: 1–36 chars |
| data[].uses_parent_account boolean Conditionally returned | Indicates whether the child shares balances with the parent (true), or the child’s balances are independent of the parent (false).Allowable Values: true, false |
| data[].zip string Conditionally returned | United States ZIP code of the cardholder’s address. Allowable Values: 10 char max |
| end_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"token": "my_child_user_01",
"active": true,
"password": "My_passw0rd",
"phone": "510-555-1111",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"gender": "F",
"email": "my_child_user_01@gmail.com",
"address1": "1234 Lake Street",
"city": "Berkeley",
"state": "CA",
"postal_code": "94702",
"country": "US",
"identifications": [
{
"type": "SSN",
"value": "123456789"
}
],
"first_name": "First",
"last_name": "Last",
"birth_date": "1990-01-01",
"parent_token": "my_business_01",
"uses_parent_account": true,
"created_time": "2024-10-20T17:50:36Z",
"last_modified_time": "2024-10-20T17:50:36Z",
"business_token": "my_business_01",
"status": "ACTIVE"
}
]
}
Retrieve business
Action:GETEndpoint:
/businesses/{token}
To retrieve a specific business, send a GET request to the /businesses/{token} endpoint. Include the business token path parameter to specify the business to return.
This endpoint supports field filtering and sorting and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the business resource. Allowable Values: Existing business resource token |
URL query parameters
| Fields | Description |
|---|---|
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
Response body
| Fields | Description |
|---|---|
| account_holder_group_token string Conditionally returned | Associates the specified account holder group with the business. This field is returned if it exists in the resource. Allowable Values: 36 char max |
| active boolean Conditionally returned | Specifies if the business is in the ACTIVE state on the Marqeta platform.This field is returned if it exists in the resource. Allowable Values: true, false |
| attestation_consent boolean Conditionally returned | Indicates that the attester agrees that the information provided is correct and truthful. This field is returned if it exists in the resource. Allowable Values: true, false |
| attestation_date datetime Conditionally returned | Timestamp of the attestation. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| attester_name string Conditionally returned | Name of the attester for KYC verification. This field is returned if it exists in the resource. Allowable Values: 64 char max |
| attester_title string Conditionally returned | Title of the attester for KYC verification. This field is returned if it exists in the resource. Allowable Values: 64 char max |
| authentication object Conditionally returned | Contains metadata about the business’s email verification and password updates. Allowable Values: email_verified, email_verified_time, last_password_update_channel, last_password_update_time |
| authentication.email_verified boolean Conditionally returned | Specifies whether the email address has been verified. Allowable Values: true, false |
| authentication.email_verified_time datetime Conditionally returned | Date and time when the email address was verified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| authentication.last_password_update_channel string Conditionally returned | Specifies the channel through which the password was last changed. Allowable Values: USER_CHANGE, USER_RESET |
| authentication.last_password_update_time datetime Conditionally returned | Date and time when the password was last changed. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| beneficial_owner1 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner1.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner1.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner1.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner1.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner1.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner1.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner1.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner1.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner1.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner1.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner1.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner1.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner1.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner1.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner1.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner2.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner2.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner2.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner2.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner2.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner2.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner2.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner2.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner2.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner2.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner2.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner2.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner2.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner2.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner2.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner3.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner3.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner3.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner3.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner3.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner3.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner3.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner3.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner3.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner3.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner3.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner3.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner3.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner3.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner3.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner4.birth_place string Conditionally returned | Country of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner4.first_name string Conditionally returned | First name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.email string Conditionally returned | Email address of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.dob datetime Conditionally returned | Date of birth of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner4.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| beneficial_owner4.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner4.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| beneficial_owner4.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| beneficial_owner4.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner4.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner4.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| beneficial_owner4.last_name string Conditionally returned | Last name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.middle_name string Conditionally returned | Middle name of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| beneficial_owner4.nationality string Conditionally returned | Nationality of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| beneficial_owner4.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: A number between 1 and 100 |
| beneficial_owner4.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner4.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| beneficial_owner4.title string Conditionally returned | Title of the beneficial owner. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| business_name_dba string Conditionally returned | Fictitious business name (“Doing Business As” or DBA). This field is returned if it exists in the resource. Allowable Values: 255 char max |
| business_name_legal string Conditionally returned | Legal name of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| business_type string Conditionally returned | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). This field is returned if it exists in the resource. Allowable Values: 255 char max |
| created_time datetime Returned | Date and time when the business was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| date_established datetime Conditionally returned | Date and time when the business was established. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| duns_number string Conditionally returned | Data Universal Numbering System (DUNS) number of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| general_business_description string Conditionally returned | General description of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| history string Conditionally returned | History of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing identifications associated with the business. Objects are returned if they exist in the resource. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| in_current_location_since datetime Conditionally returned | Date on which the business office opened in its current location. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| incorporation object Conditionally returned | Contains information about the organizational structure of the business. Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| incorporation.address_registered_under object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| incorporation.address_registered_under.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| incorporation.address_registered_under.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| incorporation.address_registered_under.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| incorporation.address_registered_under.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| incorporation.incorporation_type string Conditionally returned | Organizational structure of the business (corporation or sole proprietorship, for example). This field is returned if it exists in the resource. Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| incorporation.is_public boolean Conditionally returned | A value of true indicates that the business is publicly held.This field is returned if it exists in the resource. Allowable Values: true, false |
| incorporation.is_regulated_entity boolean Conditionally returned | A value of true indicates that the business is a regulated entity.This field is returned if it exists in the resource. Allowable Values: true, false |
| incorporation.name_registered_under string Conditionally returned | Name under which the business is registered. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| incorporation.state_of_incorporation string Conditionally returned | State, province, territory, or federation where the business is incorporated. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| incorporation.stock_symbol string Conditionally returned | Stock symbol associated with the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| international_office_locations string Conditionally returned | Locations of the business’ offices outside the US. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| ip_address string Conditionally returned | IP address of the business. This field is returned if it exists in the resource. Allowable Values: 39 char max |
| last_modified_time datetime Returned | Date and time when the business was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| metadata object Conditionally returned | Associates any additional metadata you provide with the business. Metadata is returned if it exists in the resource. Allowable Values: Existing metadata object |
| notes string Conditionally returned | Any additional information pertaining to the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| office_location object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| office_location.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| office_location.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| office_location.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| office_location.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| password string Conditionally returned | Password for the business account on the Marqeta platform. This field is returned if it exists in the resource. Allowable Values: 1–255 chars |
| phone string Conditionally returned | 10-digit telephone number of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| primary_contact object Conditionally returned | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| primary_contact.department string Conditionally returned | Business department of the primary contact. Allowable Values: 255 char max |
| primary_contact.email string Conditionally returned | Email address of the primary contact. Allowable Values: 255 char max |
| primary_contact.extension string Conditionally returned | Phone extension of the primary contact. Allowable Values: 255 char max |
| primary_contact.fax string Conditionally returned | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.full_name string Conditionally returned | Full name of the primary contact. Allowable Values: 255 char max |
| primary_contact.mobile string Conditionally returned | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.phone string Conditionally returned | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.title string Conditionally returned | Title of the primary contact. Allowable Values: 255 char max |
| proprietor_is_beneficial_owner boolean Conditionally returned | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is returned if it exists in the resource. Allowable Values: true, false |
| proprietor_or_officer object Conditionally returned | Contains information about the proprietor or officer of the business. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| proprietor_or_officer.alternative_names string Conditionally returned | Alternate names of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.birth_place string Conditionally returned | Country of birth of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| proprietor_or_officer.dob datetime Conditionally returned | Business proprietor or officer’s date of birth. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| proprietor_or_officer.email string Conditionally returned | Email address of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.first_name string Conditionally returned | First name of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| proprietor_or_officer.home.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| proprietor_or_officer.home.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| proprietor_or_officer.home.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| proprietor_or_officer.home.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| proprietor_or_officer.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: Valid array of one or more identifications objects |
| proprietor_or_officer.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| proprietor_or_officer.identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| proprietor_or_officer.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| proprietor_or_officer.last_name string Conditionally returned | Last name of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.middle_name string Conditionally returned | Middle name of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| proprietor_or_officer.nationality string Conditionally returned | Nationality of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max ISO 3166 two-character country code |
| proprietor_or_officer.phone string Conditionally returned | Telephone number of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: Format: 510-555-1212 or 5105551212 |
| proprietor_or_officer.ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: Nine digits |
| proprietor_or_officer.title string Conditionally returned | Title of the business proprietor or officer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| status string Conditionally returned | Specifies the state of the business on the Marqeta platform. This field is returned if it exists in the resource. Allowable Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| taxpayer_id string Conditionally returned | Taxpayer identifier of the business. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business resource. This field is always returned. Allowable Values: 1–36 chars |
| website string Conditionally returned | URL of the business’ website. This field is returned if it exists in the resource. Allowable Values: 255 char max |
Sample response body
JSON
{
"token": "my_business_02",
"active": true,
"notes": "My notes",
"ip_address": "67.120.28.118",
"password": "My_passw0rd",
"phone": "5105551212",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"in_current_location_since": "2010-04-15T00:01:00Z",
"website": "https://my_business_02.com",
"date_established": "2010-04-15T00:01:00Z",
"general_business_description": "44112 - Used Car Dealers",
"history": "My_business_history",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"identifications": [
{
"type": "BUSINESS_TAX_ID",
"value": "123456789"
}
],
"duns_number": "123456789",
"primary_contact": {
"full_name": "First Middle Last",
"title": "Dr",
"department": "My_department",
"phone": "5105551212",
"extension": "11",
"fax": "5105551222",
"mobile": "5105551213",
"email": "dr.me@my.business.com"
},
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B Street",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
},
"incorporation_type": "LLC"
},
"proprietor_or_officer": {
"title": "Mr",
"dob": "1985-01-08T00:00:00Z",
"phone": "5105551211",
"email": "mr.myself@my.business.com",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My Alternative Name",
"ssn": "5555",
"home": {
"address1": "123 B Street",
"address2": "Apt A",
"city": "Oakland",
"state": "CA",
"postal_code": "94610",
"country": "US"
}
},
"created_time": "2025-01-13T23:29:10Z",
"last_modified_time": "2025-01-13T23:29:10Z",
"deposit_account": {
"x-mq-internal": true,
"token": "420df02a-6aef-42bf-be7b-0d080ebf7573",
"account_number": "12342126720827265",
"routing_number": "293748000"
},
"status": "ACTIVE"
}
Update business
Action:PUTEndpoint:
/businesses/{token}
To update a business, send a PUT request to /businesses/{token}. Use the token path parameter to specify the business to update. Include the business details to update in JSON format in the body of the request. Only values of parameters in the request are modified; all others are left unchanged.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the business resource Allowable Values: Existing business resource token |
Request body
| Fields | Description |
|---|---|
| account_holder_group_token string Optional | Associates the specified account holder group with the business. Allowable Values: 36 char max Existing account holder group token. Send a GET request to /accountholdergroups to retrieve account holder group tokens. |
| active boolean Optional | Specifies if the business is in the ACTIVE state on the Marqeta platform.Allowable Values: true, false |
| attestation_consent boolean Optional | Indicates that the attester agrees that the information provided is correct and truthful. This field is required for KYC verification (US-based accounts only). Allowable Values: true, false |
| attestation_date datetime Optional | Timestamp of the attestation. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| attester_name string Optional | Name of the attester for KYC verification. This field is required for KYC verification (US-based accounts only). Allowable Values: 64 char max |
| attester_title string Optional | Title of the attester for KYC verification. Allowable Values: 64 char max |
| beneficial_owner1 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner1.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner1.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner1.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner1.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner1.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner1.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner1.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner1.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner1.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner1.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner1.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner1.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner1.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner1.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner1.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner2.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner2.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner2.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner2.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner2.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner2.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner2.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner2.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner2.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner2.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner2.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner2.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner2.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner2.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner3.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner3.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner3.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner3.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner3.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner3.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner3.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner3.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner3.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner3.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner3.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner3.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner3.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner3.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4 object Optional | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner4.birth_place string Optional | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.dob datetime Optional | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.email string Optional | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner4.first_name string Optional | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner4.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner4.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| beneficial_owner4.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner4.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner4.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner4.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner4.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner4.identifications array of objects Optional | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner4.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner4.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.last_name string Optional | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.middle_name string Optional | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4.nationality string Optional | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.ownership_percentage string Optional | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner4.phone string Optional | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner4.ssn string Optional | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.title string Optional | Title of the beneficial owner. Allowable Values: 255 char max |
| business_name_dba string Optional | Fictitious business name (“Doing Business As” or DBA). This field is required for KYC verification (US-based accounts only). If your business does not use a fictitious business name, enter your legal business name again in this field. Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_name_legal string Optional | Legal name of business. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_type string Optional | Indicates the type of business, for example business-to-business (B2B) or business-to-consumer (B2C). Allowable Values: 255 char max |
| date_established datetime Optional | Date when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| duns_number string Optional | Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
| general_business_description string Optional | Required for KYC verification (US-based cardholders only). Business description must adhere to the NAICS standard, as defined by the United States Census Bureau. You must provide at least the description; NAICS codes are optional. For example, Used Car Dealers or 44112 - Used Car Dealers.This field is returned if it exists in the resource. Allowable Values: 255 char max |
| history string Optional | History of the business. Allowable Values: 255 char max |
| identifications array of objects Optional | One or more objects containing identifications associated with the business. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| in_current_location_since datetime Optional | Date on which the business office opened in its current location. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| incorporation object Optional | Contains information about the organizational structure of the business. This object is required for KYC verification (US-based accounts only). Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| incorporation.address_registered_under object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| incorporation.address_registered_under.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| incorporation.address_registered_under.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| incorporation.address_registered_under.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| incorporation.address_registered_under.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| incorporation.address_registered_under.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| incorporation.address_registered_under.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| incorporation.address_registered_under.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| incorporation.incorporation_type string Optional | Organizational structure of the business, such as corporation or sole proprietorship. This field is required for KYC verification (US-based accounts only). Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, COOPERATIVE, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| incorporation.is_public boolean Optional | A value of true indicates that the business is publicly held.Allowable Values: true, falseDefault value: false |
| incorporation.is_regulated_entity boolean Optional | A value of true indicates that the business is a regulated entity.Allowable Values: true, false |
| incorporation.name_registered_under string Optional | Name under which the business is registered. Allowable Values: 255 char max |
| incorporation.state_of_incorporation string Optional | State, province, territory, or federation where the business is incorporated. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max Valid state, provincial, territorial, or federal abbreviation required for KYC verification ( CA for California or CAN for Canada, for example); 255 char max otherwise |
| incorporation.stock_symbol string Optional | Business stock symbol. Allowable Values: 255 char max |
| international_office_locations string Optional | Locations of the business’ offices outside the United States. Allowable Values: 255 char max |
| ip_address string Optional | IP address of the business. Allowable Values: 39 char max |
| metadata object Optional | Associates any additional metadata you provide with the business. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1" |
| notes string Optional | Any additional information pertaining to the business. Allowable Values: 255 char max 255 char max |
| office_location object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| office_location.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| office_location.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| office_location.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| office_location.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| office_location.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| office_location.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| office_location.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| password string Optional | Password for the business account on the Marqeta platform. Allowable Values: 255 char max - Must contain at least one numeral - Must contain at least one lowercase letter - Must contain at least one uppercase letter - Must contain at least one of these symbols: @``#``$``%``!``^``&``*``(``)\\``_``+``~``-``=``[``]``\{``},``;``:``'``"``.``/``<``>``?` |
| phone string Optional | 10-digit telephone number of business. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact object Optional | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| primary_contact.department string Optional | Business department of the primary contact. Allowable Values: 255 char max |
| primary_contact.email string Optional | Email address of the primary contact. Allowable Values: 255 char max |
| primary_contact.extension string Optional | Phone extension of the primary contact. Allowable Values: 255 char max |
| primary_contact.fax string Optional | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.full_name string Optional | Full name of the primary contact. Allowable Values: 255 char max |
| primary_contact.mobile string Optional | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.phone string Optional | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.title string Optional | Title of the primary contact. Allowable Values: 255 char max |
| proprietor_is_beneficial_owner boolean Optional | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is required for KYC verification in the United States if the business proprietor or officer is also a beneficial owner. If the proprietor or business officer is a beneficial owner, use this field to indicate their beneficial ownership. Do not include information about the proprietor or business officer in a beneficial_owner object.Allowable Values: true, falseDefault value: false |
| proprietor_or_officer object Optional | Contains information about the proprietor or officer of the business. This object is required for KYC verification of proprietors or officers of privately held businesses in the United States. This object is not required for publicly held businesses. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| proprietor_or_officer.alternative_names string Optional | Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.birth_place string Optional | Country of birth of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.dob datetime Optional | Business proprietor or officer’s date of birth. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| proprietor_or_officer.email string Optional | Email address of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.first_name string Required | First name of business proprietor or officer. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.home object Optional | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| proprietor_or_officer.home.address1 string Optional | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| proprietor_or_officer.home.address2 string Optional | Additional address information. Allowable Values: 35 char max |
| proprietor_or_officer.home.city string Optional | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| proprietor_or_officer.home.country string Optional | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| proprietor_or_officer.home.postal_code string Optional | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| proprietor_or_officer.home.state string Optional | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| proprietor_or_officer.home.zip string Optional | United States ZIP code of the address. Allowable Values: 20 char max |
| proprietor_or_officer.identifications array of objects Optional | One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid array of one or more identifications objects |
| proprietor_or_officer.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| proprietor_or_officer.identifications[].type string Required | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| proprietor_or_officer.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| proprietor_or_officer.last_name string Required | Last name of business proprietor or officer. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.middle_name string Optional | Middle name of business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.nationality string Optional | Nationality of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.phone string Optional | Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 Do not insert a 1 before the area code. |
| proprietor_or_officer.ssn string Optional | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. Allowable Values: Nine digits, no delimiters. 123456789, for example. |
| proprietor_or_officer.title string Optional | Title of business proprietor or officer. Allowable Values: 255 char max |
| taxpayer_id string Optional | Taxpayer identifier of the business. Allowable Values: 255 char max |
| token string Optional | Unique identifier of the business. Send a GET request to /businesses to retrieve business tokens.Allowable Values: 1–36 chars |
| website string Optional | URL of the business’ website. Allowable Values: 255 char max 255 char max |
Response body
| Fields | Description |
|---|---|
| account_holder_group_token string Conditionally returned | Existing account holder group token that associates the specified account holder group with the business. Send a GET request to /accountholdergroups to retrieve account holder group tokens.Allowable Values: 36 char max |
| active boolean Conditionally returned | Specifies if the business is in the ACTIVE state on the Marqeta platform.Allowable Values: true, falseDefault value: true |
| attestation_consent boolean Conditionally returned | Indicates that the attester agrees that the information provided is correct and truthful. This field is required for KYC verification (US-based accounts only). Allowable Values: true, false |
| attestation_date datetime Conditionally returned | Timestamp of the attestation. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| attester_name string Conditionally returned | Name of the attester for KYC verification. This field is required for KYC verification (US-based accounts only). Allowable Values: 64 char max |
| attester_title string Conditionally returned | Title of the attester for KYC verification. Allowable Values: 64 char max |
| beneficial_owner1 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner1.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner1.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner1.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner1.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner1.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner1.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner1.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner1.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner1.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner1.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner1.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner1.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner1.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner1.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner1.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner1.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner1.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner1.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner1.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner2.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner2.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner2.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner2.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner2.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner2.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner2.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner2.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner2.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner2.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner2.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner2.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner2.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner2.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner2.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner2.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner2.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner2.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner2.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner3.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner3.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner3.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner3.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner3.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner3.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner3.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner3.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner3.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner3.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner3.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner3.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner3.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner3.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner3.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner3.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner3.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner3.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner3.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4 object Conditionally returned | Contains information about the beneficial owner of the business, if applicable. This object is required for KYC verification in the United States if the business is private and has a beneficial owner. This object is not required for publicly held businesses. Do not include information about the proprietor or business officer in a beneficial_owner object. If the proprietor or officer of the business is also a beneficial owner, you must indicate that in the proprietor_is_beneficial_owner field in the body field details of the business.Allowable Values: birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, ownership_percentage, phone, ssn, title |
| beneficial_owner4.birth_place string Conditionally returned | Country of birth of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.dob datetime Conditionally returned | Beneficial owner’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.email string Conditionally returned | Email address of the beneficial owner. Allowable Values: 1–255 chars 255 char max |
| beneficial_owner4.first_name string Conditionally returned | First name of the beneficial owner. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| beneficial_owner4.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| beneficial_owner4.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| beneficial_owner4.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| beneficial_owner4.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| beneficial_owner4.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| beneficial_owner4.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| beneficial_owner4.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| beneficial_owner4.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the beneficial owner. Allowable Values: Valid array of one or more identifications objects |
| beneficial_owner4.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| beneficial_owner4.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| beneficial_owner4.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.last_name string Conditionally returned | Last name of the beneficial owner. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| beneficial_owner4.middle_name string Conditionally returned | Middle name of the beneficial owner. Allowable Values: 255 char max |
| beneficial_owner4.nationality string Conditionally returned | Nationality of the beneficial owner. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| beneficial_owner4.ownership_percentage string Conditionally returned | Ownership percentage of the beneficial owner. Allowable Values: Any number between 1 and 100. Decimal values are supported; do not include a percentage symbol. |
| beneficial_owner4.phone string Conditionally returned | Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
| beneficial_owner4.ssn string Conditionally returned | Nine-digit Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the beneficial owner. Allowable Values: Digits only, do not use separators. For example: 123456789 |
| beneficial_owner4.title string Conditionally returned | Title of the beneficial owner. Allowable Values: 255 char max |
| business_name_dba string Conditionally returned | Fictitious business name (“Doing Business As” or DBA). This field is required for KYC verification (US-based accounts only). If your business does not use a fictitious business name, enter your legal business name again in this field. Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_name_legal string Conditionally returned | Legal name of business. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max 128 char max for KYC verification; 255 char max otherwise |
| business_type string Conditionally returned | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). Allowable Values: 255 char max |
| date_established datetime Conditionally returned | Date when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| duns_number string Conditionally returned | Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
| general_business_description string Conditionally returned | Required for KYC verification (US-based cardholders only). Business description must adhere to the NAICS standard, as defined by the United States Census Bureau. You must provide at least the description; NAICS codes are optional. For example, Used Car Dealers or 44112 - Used Car Dealers.This field is returned if it exists in the resource. Allowable Values: 255 char max |
| history string Conditionally returned | History of the business. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing identifications associated with the business. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| in_current_location_since datetime Conditionally returned | Date on which the business office opened in its current location. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| incorporation object Conditionally returned | Contains information about the organizational structure of the business. This object is required for KYC verification (US-based accounts only). Allowable Values: address_registered_under, incorporation_type, is_public, is_regulated_entity, name_registered_under, state_of_incorporation, stock_symbol |
| incorporation.address_registered_under object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| incorporation.address_registered_under.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| incorporation.address_registered_under.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| incorporation.address_registered_under.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| incorporation.address_registered_under.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| incorporation.address_registered_under.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| incorporation.address_registered_under.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| incorporation.address_registered_under.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| incorporation.incorporation_type string Conditionally returned | Organizational structure of the business, such as corporation or sole proprietorship. This field is required for KYC verification (US-based accounts only). Allowable Values: LLC, CORPORATION, SOLE_PROPRIETORSHIP, PARTNERSHIP, COOPERATIVE, OTHER, FINANCIAL_OR_CREDIT_INSTITUTION, FOUNDATION, ASSOCIATION, CHARITY, TRUST |
| incorporation.is_public boolean Conditionally returned | A value of true indicates that the business is publicly held.Allowable Values: true, falseDefault value: false |
| incorporation.is_regulated_entity boolean Conditionally returned | A value of true indicates that the business is a regulated entity.Allowable Values: true, false |
| incorporation.name_registered_under string Conditionally returned | Name under which the business is registered. Allowable Values: 255 char max |
| incorporation.state_of_incorporation string Conditionally returned | State, province, territory, or federation where the business is incorporated. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max Valid state, provincial, territorial, or federal abbreviation required for KYC verification ( CA for California or CAN for Canada, for example); 255 char max otherwise |
| incorporation.stock_symbol string Conditionally returned | Business stock symbol. Allowable Values: 255 char max |
| international_office_locations string Conditionally returned | Locations of the business’ offices outside the US. Allowable Values: 255 char max |
| ip_address string Conditionally returned | IP address of the business. Allowable Values: 39 char max |
| metadata object Conditionally returned | Associates any additional metadata you provide with the business. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1" |
| notes string Conditionally returned | Any additional information pertaining to the business. Allowable Values: 255 char max |
| office_location object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| office_location.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| office_location.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| office_location.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| office_location.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| office_location.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| office_location.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| office_location.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| password string Conditionally returned | Password for the business account on the Marqeta platform. Allowable Values: 1–255 chars - Must contain at least one numeral - Must contain at least one lowercase letter - Must contain at least one uppercase letter - Must contain at least one of these symbols: @``#``$``%``!``^``&``*``(``)\\``_``+``~``-``=``[``]``\{``},``;``:``'``"``.``/``<``>``?` |
| phone string Conditionally returned | 10-digit telephone number of business. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact object Conditionally returned | Describes the business’ primary contact person. Allowable Values: department, email, extension, fax, full_name, mobile, phone, title |
| primary_contact.department string Conditionally returned | Business department of the primary contact. Allowable Values: 255 char max |
| primary_contact.email string Conditionally returned | Email address of the primary contact. Allowable Values: 255 char max |
| primary_contact.extension string Conditionally returned | Phone extension of the primary contact. Allowable Values: 255 char max |
| primary_contact.fax string Conditionally returned | Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.full_name string Conditionally returned | Full name of the primary contact. Allowable Values: 255 char max |
| primary_contact.mobile string Conditionally returned | Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.phone string Conditionally returned | Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
| primary_contact.title string Conditionally returned | Title of the primary contact. Allowable Values: 255 char max |
| proprietor_is_beneficial_owner boolean Conditionally returned | Indicates that the proprietor or officer of the business is also a beneficial owner. This field is required for KYC verification if the business proprietor or officer is also a beneficial owner. Allowable Values: true, falseDefault value: false |
| proprietor_or_officer object Conditionally returned | Contains information about the proprietor or officer of the business. This object is required for KYC verification of proprietors or officers of privately held businesses in the United States. This object is not required for publicly held businesses. Allowable Values: alternative_names, birth_place, dob, email, first_name, home, identifications, last_name, middle_name, nationality, phone, ssn, title |
| proprietor_or_officer.alternative_names string Conditionally returned | Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.birth_place string Conditionally returned | Country of birth of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.dob datetime Conditionally returned | Business proprietor or officer’s date of birth. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| proprietor_or_officer.email string Conditionally returned | Email address of the business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.first_name string Returned | First name of business proprietor or officer. Allowable Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.home object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| proprietor_or_officer.home.address1 string Conditionally returned | Street name and number of the address. This field is required for KYC verification (US-based accounts only). Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
| proprietor_or_officer.home.address2 string Conditionally returned | Additional address information. Allowable Values: 35 char max |
| proprietor_or_officer.home.city string Conditionally returned | City of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
| proprietor_or_officer.home.country string Conditionally returned | Country of the address. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( US, for example); 40 char max otherwise |
| proprietor_or_officer.home.postal_code string Conditionally returned | Postal code of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
| proprietor_or_officer.home.state string Conditionally returned | State of the address. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-character abbreviation required for KYC verification ( CA for California, for example). Must be uppercase. |
| proprietor_or_officer.home.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 20 char max |
| proprietor_or_officer.identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid array of one or more identifications objects |
| proprietor_or_officer.identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| proprietor_or_officer.identifications[].type string Returned | Type of identification. NOTE: Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the SSN type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the BUSINESS_TAX_ID or BUSINESS_NUMBER type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. 123456789, for example.Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| proprietor_or_officer.identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max NOTE: Digits only, do not use separators. For example: 123456789 |
| proprietor_or_officer.last_name string Returned | Last name of business proprietor or officer. Allowable Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| proprietor_or_officer.middle_name string Conditionally returned | Middle name of business proprietor or officer. Allowable Values: 255 char max |
| proprietor_or_officer.nationality string Conditionally returned | Nationality of the business proprietor or officer. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| proprietor_or_officer.phone string Conditionally returned | Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 Do not insert a 1 before the area code. |
| proprietor_or_officer.ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the business proprietor or officer. Allowable Values: Nine digits, no delimiters. 123456789, for example. |
| proprietor_or_officer.title string Conditionally returned | Title of business proprietor or officer. Allowable Values: 255 char max |
| taxpayer_id string Conditionally returned | Taxpayer identifier of the business. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business resource. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
| website string Conditionally returned | URL of the business’ website. Allowable Values: 255 char max |
Retrieve business identification number
Action:GETEndpoint:
/businesses/{token}/ssn
To retrieve the government-issued identification number of a business’ proprietor, send a GET request to the /businesses/{token}/ssn endpoint. Include the token path parameter to specify the business whose identification number (SSN, ITIN, TIN, NIN, SIN) you want to return. You can indicate whether to return the full number or the last four digits only.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the business resource. Allowable Values: Existing business resource token |
URL query parameters
| Fields | Description |
|---|---|
| full_ssn boolean Optional | To return the full identification number, set to true. To return only the last four digits, set to false. If the proprietor_or_officer.identifications array contains only the last four digits of the identification number, the /businesses/{token}/ssn endpoint will return only the last four digits regardless of the full_ssn parameter.Allowable Values: true, false |
Response body
| Fields | Description |
|---|---|
| nin string Conditionally returned | National Identification Number (NIN). Allowable Values: 255 char max |
| sin string Conditionally returned | Social Insurance Number (SIN). Allowable Values: 255 char max |
| ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). Allowable Values: 255 char max |
| tin string Conditionally returned | Taxpayer Identification Number (TIN). Allowable Values: 255 char max |
Sample response body
JSON
{
"ssn": "5555"
}