Businesses
A business is a type of account holder that cannot directly hold cards, but can have parent/child relationships with card-holding users. A business can monitor and control card use by a specified group of users. Every business has a general purpose account (GPA).
For information on how to create a user that has a child-to-parent hierarchical relationship to the business, see Create User.
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 business parent’s account balances, and the user’s children are configured to use the business parent’s account balances. For more information on account holders, see About Account Holders.
Create business
Copy section link
Action: POST
Endpoint: /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 |
|
No |
Cannot load funds. |
Conditionally |
|
No |
Restricted by rules in |
Never |
|
Required |
None. |
To change or track the history of a business' status, use the /businesstransitions endpoint.
For more information on status changes, see Create Business Transition.
For information on configuring the required fields for KYC verification, see Perform KYC.
Request body
Copy section link
| Fields | Description |
|---|---|
account_holder_group_token
string
|
Associates the specified account holder group with the business. Allowable Values: 36 char max Existing account holder group token Send a |
active
boolean
|
A value of Allowable Values:
Default value:
|
attestation_consent
boolean
|
A value of This field is required for KYC verification (US-based accounts only). Allowable Values:
|
attestation_date
datetime
|
The 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
|
The 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
|
The title of the attester for KYC verification. Allowable Values: 64 char max |
beneficial_owner1
object
|
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 has a beneficial owner.
Do not include information about the proprietor or business officer in a Allowable Values: Valid |
beneficial_owner1.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner1.first_name
string
|
First name of the beneficial owner. Allowable Values: 2–36 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner1.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner1.home.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner1.home.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
beneficial_owner1.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
beneficial_owner1.home.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
beneficial_owner1.home.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
beneficial_owner1.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner1.last_name
string
|
Last name of the beneficial owner. Allowable Values: 2–48 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner1.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner1.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
beneficial_owner1.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2
object
|
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 has a beneficial owner.
Do not include information about the proprietor or business officer in a Allowable Values: Valid |
beneficial_owner2.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner2.first_name
string
|
First name of the beneficial owner. Allowable Values: 2–36 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner2.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner2.home.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner2.home.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
beneficial_owner2.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
beneficial_owner2.home.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
beneficial_owner2.home.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
beneficial_owner2.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner2.last_name
string
|
Last name of the beneficial owner. Allowable Values: 2–48 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner2.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner2.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
beneficial_owner2.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3
object
|
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 has a beneficial owner.
Do not include information about the proprietor or business officer in a Allowable Values: Valid |
beneficial_owner3.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner3.first_name
string
|
First name of the beneficial owner. Allowable Values: 2–36 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner3.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner3.home.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner3.home.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
beneficial_owner3.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
beneficial_owner3.home.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
beneficial_owner3.home.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
beneficial_owner3.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner3.last_name
string
|
Last name of the beneficial owner. Allowable Values: 2–48 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner3.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner3.ssn
string
|
Nine-digit Social Security Number of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
beneficial_owner3.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4
object
|
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 has a beneficial owner.
Do not include information about the proprietor or business officer in a Allowable Values: Valid |
beneficial_owner4.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner4.first_name
string
|
First name of the beneficial owner. Allowable Values: 2–36 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner4.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner4.home.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner4.home.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
beneficial_owner4.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
beneficial_owner4.home.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
beneficial_owner4.home.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
beneficial_owner4.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner4.last_name
string
|
Last name of the beneficial owner. Allowable Values: 2–48 chars for KYC verification (US-based accounts only); 255 char max otherwise |
beneficial_owner4.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner4.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
beneficial_owner4.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
business_name_dba
string
|
Fictitious business name or "Doing Business As" (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
|
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
|
Indicates the type of business (B2B [business-to-business] or B2C [business-to-consumer], for example). Allowable Values: 255 char max |
date_established
datetime
|
Date the business was established. This field is required for KYC verification (US-based accounts only). Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
duns_number
string
|
Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
general_business_description
string
|
General description of the business. Allowable Values: 255 char max |
history
string
|
History of the business. Allowable Values: 255 char max |
identifications
array of objects
|
One or more objects containing identifications associated with the business. Allowable Values: Valid |
identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
identifications[].type
string
|
Form of identification.
Allowable Values:
|
identifications[].value
string
|
Identification number. Allowable Values: 255 char max Nine-digit identification number with no delimiters required for KYC verification (US-based accounts only). For example: 123456789 |
in_current_location_since
datetime
|
The 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
|
Contains information about the organizational structure of the business. This object is required for KYC verification (US-based accounts only). Allowable Values: Valid |
incorporation.address_registered_under
object
|
An address associated with the business. Allowable Values: Valid address information |
incorporation.address_registered_under.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
incorporation.address_registered_under.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
incorporation.address_registered_under.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
incorporation.address_registered_under.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
incorporation.address_registered_under.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
incorporation.address_registered_under.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
incorporation.incorporation_type
string
|
Organizational structure of the business, such as corporation or sole proprietorship. This field is required for KYC verification (US-based accounts only). Allowable Values:
|
incorporation.is_public
boolean
|
A value of Allowable Values:
Default value: |
incorporation.name_registered_under
string
|
Name under which the business is registered. Allowable Values: 255 char max |
incorporation.state_of_incorporation
string
|
State where the business is incorporated. This field is required for KYC verification (US-based accounts only). Allowable Values: 255 char max Valid two-letter state, provincial, or territorial abbreviation required for KYC verification ( |
incorporation.stock_symbol
string
|
Business stock symbol. Allowable Values: 255 char max |
international_office_locations
string
|
The locations of the business' offices outside the US. Allowable Values: 255 char max |
ip_address
string
|
The IP address of the business. Allowable Values: 39 char max |
metadata
object
|
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 |
notes
string
|
Any additional information pertaining to the business. Allowable Values: 255 char max |
office_location
object
|
An address associated with the business. Allowable Values: Valid address information |
office_location.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
office_location.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
office_location.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
office_location.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
office_location.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
office_location.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
password
string
|
Password for the Allowable Values: 1–255 chars
|
phone
string
|
10-digit telephone number of business. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact
object
|
Describes the business' primary contact person. Allowable Values: Valid |
primary_contact.department
string
|
Business department of the primary contact. Allowable Values: 255 char max |
primary_contact.email
string
|
Email address of the primary contact. Allowable Values: 255 char max |
primary_contact.extension
string
|
Phone extension of the primary contact. Allowable Values: 255 char max |
primary_contact.fax
string
|
Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact.full_name
string
|
Full name of the primary contact. Allowable Values: 255 char max |
primary_contact.mobile
string
|
Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact.phone
string
|
Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact.title
string
|
Title of the primary contact. Allowable Values: 255 char max |
proprietor_is_beneficial_owner
boolean
|
A value of This field is required for KYC verification if the business proprietor or officer is also a beneficial owner. Allowable Values:
Default value: |
proprietor_or_officer
object
|
Contains information about the proprietor or officer of the business. This object is required for KYC verification in the United States. Allowable Values: A valid |
proprietor_or_officer.alternative_names
string
|
Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.dob
datetime
|
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
|
Email address of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.first_name
string
|
First name of business proprietor or officer. Allowable Values: 2–36 chars for KYC verification (US-based accounts only); 255 char max otherwise |
proprietor_or_officer.home
object
|
An address associated with the business. Allowable Values: Valid address information |
proprietor_or_officer.home.address1
string
|
Street address of the business proprietor or officer. 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
|
Additional address information. Allowable Values: 35 char max |
proprietor_or_officer.home.city
string
|
City of business proprietor or officer. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
proprietor_or_officer.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max ISO alpha-2 country code required for KYC verification ( |
proprietor_or_officer.home.postal_code
string
|
Business proprietor or officer’s postal code. This field is required for KYC verification (US-based accounts only). Allowable Values: 20 char max |
proprietor_or_officer.home.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max Valid two-letter abbreviation required for KYC verification ( |
proprietor_or_officer.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
proprietor_or_officer.identifications
array of objects
|
One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid |
proprietor_or_officer.identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
proprietor_or_officer.identifications[].type
string
|
Form of identification.
Allowable Values:
|
proprietor_or_officer.identifications[].value
string
|
Identification number. Allowable Values: 255 char max Nine-digit identification number with no delimiters required for KYC verification (US-based accounts only). For example: 123456789 |
proprietor_or_officer.last_name
string
|
Last name of business proprietor or officer. Allowable Values: 2–48 chars for KYC verification (US-based accounts only); 255 char max otherwise |
proprietor_or_officer.middle_name
string
|
Middle name of business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.phone
string
|
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
|
The Social Security Number of the business proprietor or officer. Allowable Values: Nine digits, no delimiters ( |
proprietor_or_officer.title
string
|
Title of business proprietor or officer. Allowable Values: 255 char max |
taxpayer_id
string
|
The taxpayer identifier of the business. Allowable Values: 255 char max |
token
string
|
The 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
|
URL of the business' website. Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
account_holder_group_token
string
|
Associates the specified account holder group with the business. Allowable Values: 36 char max |
active
boolean
|
A value of Allowable Values:
|
attestation_consent
boolean
|
A value of Allowable Values:
|
attestation_date
datetime
|
The timestamp of the attestation. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
attester_name
string
|
The name of the attester for KYC verification. Allowable Values: 64 char max |
attester_title
string
|
The title of the attester for KYC verification. Allowable Values: 64 char max |
authentication
object
|
Contains email address and password information for the business resource. Allowable Values: Valid |
authentication.email_verified
boolean
|
A value of Allowable Values:
|
authentication.email_verified_time
datetime
|
The time and date that the email address was verified. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
authentication.last_password_update_time
datetime
|
The time and date that the password was last changed. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
beneficial_owner1
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner1.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner1.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner1.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner1.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner1.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner1.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner1.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner1.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner1.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner1.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner1.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner2.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner2.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner2.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner2.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner2.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner2.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner2.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner2.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner2.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner2.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner2.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner3.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner3.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner3.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner3.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner3.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner3.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner3.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner3.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner3.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner3.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner3.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner4.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner4.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner4.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner4.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner4.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner4.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner4.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner4.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner4.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner4.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner4.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
business_name_dba
string
|
Fictitious business name or "Doing Business As" (DBA). Allowable Values: 255 char max |
business_name_legal
string
|
Legal name of business. Allowable Values: 255 char max |
business_type
string
|
Indicates the type of business (B2B [business-to-business] or B2C [business-to-consumer], for example). Allowable Values: 255 char max |
created_time
datetime
|
The date and time when the business was created, in UTC ( Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
date_established
datetime
|
The date and time when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
duns_number
string
|
Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
general_business_description
string
|
General description of the business. Allowable Values: 255 char max |
history
string
|
History of the business. Allowable Values: 255 char max |
identifications
array of objects
|
One or more objects containing identifications associated with the business. Allowable Values: Existing |
identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
identifications[].type
string
|
The form of identification. Allowable Values:
|
identifications[].value
string
|
Identification number associated with the form of identification. Allowable Values: 255 char max |
in_current_location_since
datetime
|
The 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
|
Contains information about the organizational structure of the business. Allowable Values: Existing |
incorporation.address_registered_under
object
|
The registered business address. Allowable Values: Existing |
incorporation.address_registered_under.address1
string
|
Street address. Allowable Values: 35 char max |
incorporation.address_registered_under.address2
string
|
Additional address information. Allowable Values: 35 char max |
incorporation.address_registered_under.city
string
|
City. Allowable Values: 35 char max |
incorporation.address_registered_under.country
string
|
Country. Allowable Values: 40 char max |
incorporation.address_registered_under.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
incorporation.address_registered_under.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
incorporation.address_registered_under.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
incorporation.incorporation_type
string
|
Organizational structure of the business (corporation or sole proprietorship, for example). Allowable Values:
|
incorporation.is_public
boolean
|
A value of Allowable Values:
|
incorporation.name_registered_under
string
|
Name under which the business is registered. Allowable Values: 255 char max |
incorporation.state_of_incorporation
string
|
State where the business is incorporated. Allowable Values: 255 char max |
incorporation.stock_symbol
string
|
Stock symbol associated with the business. Allowable Values: 255 char max |
international_office_locations
string
|
The locations of the business' offices outside the US. Allowable Values: 255 char max |
ip_address
string
|
The IP address of the business. Allowable Values: 39 char max |
last_modified_time
datetime
|
The date and time when the business was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
metadata
object
|
Associates any additional metadata you provide with the business. Allowable Values: Existing |
notes
string
|
Any additional information pertaining to the business. Allowable Values: 255 char max |
office_location
object
|
The address of the business office. Allowable Values: Existing |
office_location.address1
string
|
Street address. Allowable Values: 35 char max |
office_location.address2
string
|
Additional address information. Allowable Values: 35 char max |
office_location.city
string
|
City. Allowable Values: 35 char max |
office_location.country
string
|
Country. Allowable Values: 40 char max |
office_location.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
office_location.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
office_location.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
password
string
|
Password for the Allowable Values: 1–255 chars |
phone
string
|
10-digit telephone number of business. Allowable Values: 255 char max |
primary_contact
object
|
Describes the business' primary contact person. Allowable Values: Valid |
primary_contact.department
string
|
Business department of the primary contact. Allowable Values: 255 char max |
primary_contact.email
string
|
Email address of the primary contact. Allowable Values: 255 char max |
primary_contact.extension
string
|
Phone extension of the primary contact. Allowable Values: 255 char max |
primary_contact.fax
string
|
Fax number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact.full_name
string
|
Full name of the primary contact. Allowable Values: 255 char max |
primary_contact.mobile
string
|
Mobile phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact.phone
string
|
Phone number of the primary contact. Allowable Values: 255 char max Format: 510-555-1212 or 5105551212 |
primary_contact.title
string
|
Title of the primary contact. Allowable Values: 255 char max |
proprietor_is_beneficial_owner
boolean
|
A value of Allowable Values:
|
proprietor_or_officer
object
|
Contains information about the proprietor or officer of the business. Allowable Values: Existing |
proprietor_or_officer.alternative_names
string
|
Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.dob
datetime
|
Business proprietor or officer’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
proprietor_or_officer.email
string
|
Email address of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.first_name
string
|
First name of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.home
object
|
The home address of the proprietor or officer. Allowable Values: Existing |
proprietor_or_officer.home.address1
string
|
Street address. Allowable Values: 35 char max |
proprietor_or_officer.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
proprietor_or_officer.home.city
string
|
City. Allowable Values: 35 char max |
proprietor_or_officer.home.country
string
|
Country. Allowable Values: 40 char max |
proprietor_or_officer.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
proprietor_or_officer.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
proprietor_or_officer.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
proprietor_or_officer.identifications
array of objects
|
One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Existing |
proprietor_or_officer.identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
proprietor_or_officer.identifications[].type
string
|
The form of identification. Allowable Values:
|
proprietor_or_officer.identifications[].value
string
|
Identification number associated with the form of identification. Allowable Values: 255 char max |
proprietor_or_officer.last_name
string
|
Last name of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.middle_name
string
|
Middle name of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.phone
string
|
Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 |
proprietor_or_officer.ssn
string
|
Social Security Number of the business proprietor or officer. Allowable Values: 9 char max |
proprietor_or_officer.title
string
|
Title of the business proprietor or officer. Allowable Values: 255 char max |
status
string
|
Specifies the state of the business on the Marqeta platform. Allowable Values:
|
taxpayer_id
string
|
The taxpayer identifier of the business. Allowable Values: 255 char max |
token
string
|
The unique identifier of the business resource. Allowable Values: 1–36 chars |
website
string
|
URL of the business' website. Allowable Values: 255 char max |
List businesses
Copy section link
Action: GET
Endpoint: /businesses
Return an array of all businesses.
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
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of business resources to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
business_name_dba
string
|
The fictitious or "doing business as" (DBA) name of the business. Allowable Values: Existing DBA name of the business |
business_name_legal
string
|
The legal name of the business. Allowable Values: Existing legal name of the business |
search_type
string
|
Specifies the search type for the query. Allowable Values:
|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
An array of business objects. Allowable Values: Valid |
data[].account_holder_group_token
string
|
Associates the specified account holder group with the business. Allowable Values: 36 char max |
data[].active
boolean
|
A value of Allowable Values:
|
data[].attestation_consent
boolean
|
A value of Allowable Values:
|
data[].attestation_date
datetime
|
The timestamp of the attestation. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
data[].attester_name
string
|
The name of the attester for KYC verification. Allowable Values: 64 char max |
data[].attester_title
string
|
The title of the attester for KYC verification. Allowable Values: 64 char max |
data[].beneficial_owner1
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
data[].beneficial_owner1.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
data[].beneficial_owner1.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner1.home
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].beneficial_owner1.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner1.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].beneficial_owner1.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner1.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].beneficial_owner1.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].beneficial_owner1.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
data[].beneficial_owner1.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].beneficial_owner1.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner1.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner1.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
data[].beneficial_owner1.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
data[].beneficial_owner1.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner2
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
data[].beneficial_owner2.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
data[].beneficial_owner2.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner2.home
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].beneficial_owner2.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner2.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].beneficial_owner2.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner2.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].beneficial_owner2.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].beneficial_owner2.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
data[].beneficial_owner2.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].beneficial_owner2.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner2.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner2.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
data[].beneficial_owner2.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
data[].beneficial_owner2.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner3
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
data[].beneficial_owner3.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
data[].beneficial_owner3.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner3.home
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].beneficial_owner3.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner3.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].beneficial_owner3.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner3.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].beneficial_owner3.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].beneficial_owner3.home.state
string
|
State where the business proprietor or officer resides. This field is required for KYC verification (US-based accounts only). Allowable Values: 35 char max |
data[].beneficial_owner3.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].beneficial_owner3.last_name
string
|
Last name of the beneficial owner. Allowable Values: 2–48 chars for KYC verification (US-based accounts only); 255 char max otherwise |
data[].beneficial_owner3.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner3.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
data[].beneficial_owner3.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
data[].beneficial_owner3.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner4
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
data[].beneficial_owner4.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
data[].beneficial_owner4.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner4.home
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].beneficial_owner4.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner4.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].beneficial_owner4.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].beneficial_owner4.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].beneficial_owner4.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].beneficial_owner4.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
data[].beneficial_owner4.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].beneficial_owner4.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner4.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
data[].beneficial_owner4.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
data[].beneficial_owner4.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: Digits only, do not use separators ( |
data[].beneficial_owner4.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
data[].business_name_dba
string
|
Fictitious business name or "Doing Business As" (DBA). Allowable Values: 255 char max |
data[].business_name_legal
string
|
Legal name of business. Allowable Values: 255 char max |
data[].business_type
string
|
Indicates the type of business (B2B [business-to-business] or B2C [business-to-consumer], for example). Allowable Values: 255 char max |
data[].date_established
datetime
|
Date the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
data[].duns_number
string
|
Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
data[].general_business_description
string
|
General description of the business. Allowable Values: 255 char max |
data[].history
string
|
History of the business. Allowable Values: 255 char max |
data[].identifications
array of objects
|
One or more objects containing identifications associated with the business. Allowable Values: Valid |
data[].identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
data[].identifications[].type
string
|
Form of identification. Allowable Values:
|
data[].identifications[].value
string
|
Identification number. Allowable Values: 255 char max |
data[].in_current_location_since
datetime
|
The 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
|
Contains information about the organizational structure of the business. Allowable Values: Valid |
data[].incorporation.address_registered_under
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].incorporation.address_registered_under.address1
string
|
Street address of the business proprietor or officer. Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
data[].incorporation.address_registered_under.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].incorporation.address_registered_under.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].incorporation.address_registered_under.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].incorporation.address_registered_under.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].incorporation.address_registered_under.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
data[].incorporation.address_registered_under.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].incorporation.incorporation_type
string
|
Organizational structure of the business, such as corporation or sole proprietorship. Allowable Values:
|
data[].incorporation.is_public
boolean
|
A value of Allowable Values:
|
data[].incorporation.name_registered_under
string
|
Name under which the business is registered. Allowable Values: 255 char max |
data[].incorporation.state_of_incorporation
string
|
State where the business is incorporated. Allowable Values: 255 char max |
data[].incorporation.stock_symbol
string
|
Business stock symbol. Allowable Values: 255 char max |
data[].international_office_locations
string
|
The locations of the business' offices outside the US. Allowable Values: 255 char max |
data[].ip_address
string
|
The IP address of the business. Allowable Values: 39 char max |
data[].metadata
object
|
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 |
data[].notes
string
|
Any additional information pertaining to the business. Allowable Values: 255 char max |
data[].office_location
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].office_location.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
data[].office_location.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].office_location.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].office_location.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].office_location.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].office_location.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
data[].office_location.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].password
string
|
Password for the Allowable Values: 1–255 chars |
data[].phone
string
|
10-digit telephone number of business. Allowable Values: 255 char max |
data[].primary_contact
object
|
Describes the business' primary contact person. Allowable Values: Valid |
data[].primary_contact.department
string
|
Business department of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.email
string
|
Email address of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.extension
string
|
Phone extension of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.fax
string
|
Fax number of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.full_name
string
|
Full name of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.mobile
string
|
Mobile phone number of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.phone
string
|
Phone number of the primary contact. Allowable Values: 255 char max |
data[].primary_contact.title
string
|
Title of the primary contact. Allowable Values: 255 char max |
data[].proprietor_is_beneficial_owner
boolean
|
A value of Allowable Values:
|
data[].proprietor_or_officer
object
|
Contains information about the proprietor or officer of the business. Allowable Values: A valid |
data[].proprietor_or_officer.alternative_names
string
|
Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
data[].proprietor_or_officer.dob
datetime
|
Business proprietor or officer’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
data[].proprietor_or_officer.email
string
|
Email address of the business proprietor or officer. Allowable Values: 255 char max |
data[].proprietor_or_officer.first_name
string
|
First name of business proprietor or officer. Allowable Values: 255 char max |
data[].proprietor_or_officer.home
object
|
An address associated with the business. Allowable Values: Valid address information |
data[].proprietor_or_officer.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
data[].proprietor_or_officer.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
data[].proprietor_or_officer.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
data[].proprietor_or_officer.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
data[].proprietor_or_officer.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
data[].proprietor_or_officer.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
data[].proprietor_or_officer.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
data[].proprietor_or_officer.identifications
array of objects
|
One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid |
data[].proprietor_or_officer.identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
data[].proprietor_or_officer.identifications[].type
string
|
Form of identification. Allowable Values:
|
data[].proprietor_or_officer.identifications[].value
string
|
Identification number. Allowable Values: 255 char max |
data[].proprietor_or_officer.last_name
string
|
Last name of business proprietor or officer. Allowable Values: 255 char max |
data[].proprietor_or_officer.middle_name
string
|
Middle name of business proprietor or officer. Allowable Values: 255 char max |
data[].proprietor_or_officer.phone
string
|
Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 |
data[].proprietor_or_officer.ssn
string
|
The Social Security Number of the business proprietor or officer. Allowable Values: Nine digits, no delimiters ( |
data[].proprietor_or_officer.title
string
|
Title of business proprietor or officer. Allowable Values: 255 char max |
data[].taxpayer_id
string
|
The taxpayer identifier of the business. Allowable Values: 255 char max |
data[].token
string
|
The unique identifier of the business resource. Allowable Values: 1–36 chars |
data[].website
string
|
URL of the business' website. Allowable Values: 255 char max |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Search businesses
Copy section link
Action: POST
Endpoint: /businesses/lookup
Search for one or more businesses. Include in the message body any parameters by which you want to query. This endpoint supports field filtering and pagination.
Request body
Copy section link
| Fields | Description |
|---|---|
dda
string
|
The deposit account number of the business. Allowable Values: 17 char max Send a Send a |
Response body
Copy section link
| Fields | Description |
|---|---|
account_holder_group_token
string
|
Associates the specified account holder group with the business. Allowable Values: 36 char max |
active
boolean
|
A value of Allowable Values:
|
attestation_consent
boolean
|
A value of Allowable Values:
|
attestation_date
datetime
|
The timestamp of the attestation. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
attester_name
string
|
The name of the attester for KYC verification. Allowable Values: 64 char max |
attester_title
string
|
The title of the attester for KYC verification. Allowable Values: 64 char max |
beneficial_owner1
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
beneficial_owner1.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner1.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner1.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner1.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner1.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner1.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
beneficial_owner1.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
beneficial_owner1.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
beneficial_owner1.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner1.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner1.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: 9 char max |
beneficial_owner1.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
beneficial_owner2.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner2.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner2.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner2.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner2.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner2.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
beneficial_owner2.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
beneficial_owner2.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
beneficial_owner2.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner2.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner2.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: 9 char max |
beneficial_owner2.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
beneficial_owner3.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner3.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner3.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner3.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner3.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner3.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
beneficial_owner3.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
beneficial_owner3.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
beneficial_owner3.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner3.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner3.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: 9 char max |
beneficial_owner3.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Valid |
beneficial_owner4.dob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner4.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.home
object
|
An address associated with the business. Allowable Values: Valid address information |
beneficial_owner4.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner4.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner4.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
beneficial_owner4.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
beneficial_owner4.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
beneficial_owner4.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
beneficial_owner4.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner4.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner4.ssn
string
|
Nine-digit Social Security Number (SSN) of the beneficial owner. Allowable Values: 9 char max |
beneficial_owner4.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
business_name_dba
string
|
Fictitious business name or "Doing Business As" (DBA). Allowable Values: 255 char max |
business_name_legal
string
|
Legal name of business. Allowable Values: 255 char max |
business_type
string
|
Indicates the type of business (B2B [business-to-business] or B2C [business-to-consumer], for example). Allowable Values: 255 char max |
date_established
datetime
|
Date the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
duns_number
string
|
Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
general_business_description
string
|
General description of the business. Allowable Values: 255 char max |
history
string
|
History of the business. Allowable Values: 255 char max |
identifications
array of objects
|
One or more objects containing identifications associated with the business. Allowable Values: Valid |
identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
identifications[].type
string
|
Form of identification. Allowable Values:
|
identifications[].value
string
|
Identification number. Allowable Values: 255 char max |
in_current_location_since
datetime
|
The 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
|
Contains information about the organizational structure of the business. Allowable Values: Valid |
incorporation.address_registered_under
object
|
An address associated with the business. Allowable Values: Valid address information |
incorporation.address_registered_under.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
incorporation.address_registered_under.address2
string
|
Additional address information. Allowable Values: 35 char max |
incorporation.address_registered_under.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
incorporation.address_registered_under.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
incorporation.address_registered_under.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
incorporation.address_registered_under.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
incorporation.address_registered_under.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
incorporation.incorporation_type
string
|
Organizational structure of the business, such as corporation or sole proprietorship. Allowable Values:
|
incorporation.is_public
boolean
|
A value of Allowable Values:
|
incorporation.name_registered_under
string
|
Name under which the business is registered. Allowable Values: 255 char max |
incorporation.state_of_incorporation
string
|
State where the business is incorporated. Allowable Values: 255 char max |
incorporation.stock_symbol
string
|
Business stock symbol. Allowable Values: 255 char max |
international_office_locations
string
|
The locations of the business' offices outside the US. Allowable Values: 255 char max |
ip_address
string
|
The IP address of the business. Allowable Values: 39 char max |
metadata
object
|
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 |
notes
string
|
Any additional information pertaining to the business. Allowable Values: 255 char max |
office_location
object
|
An address associated with the business. Allowable Values: Valid address information |
office_location.address1
string
|
Street address of the business proprietor or officer. Cannot perform KYC if set to a PO Box. Allowable Values: 35 char max |
office_location.address2
string
|
Additional address information. Allowable Values: 35 char max |
office_location.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
office_location.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
office_location.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
office_location.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
office_location.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
password
string
|
Password for the Allowable Values: 1–255 chars |
phone
string
|
10-digit telephone number of business. Allowable Values: 255 char max |
primary_contact
object
|
Describes the business' primary contact person. Allowable Values: Valid |
primary_contact.department
string
|
Business department of the primary contact. Allowable Values: 255 char max |
primary_contact.email
string
|
Email address of the primary contact. Allowable Values: 255 char max |
primary_contact.extension
string
|
Phone extension of the primary contact. Allowable Values: 255 char max |
primary_contact.fax
string
|
Fax number of the primary contact. Allowable Values: 255 char max |
primary_contact.full_name
string
|
Full name of the primary contact. Allowable Values: 255 char max |
primary_contact.mobile
string
|
Mobile phone number of the primary contact. Allowable Values: 255 char max |
primary_contact.phone
string
|
Phone number of the primary contact. Allowable Values: 255 char max |
primary_contact.title
string
|
Title of the primary contact. Allowable Values: 255 char max |
proprietor_is_beneficial_owner
boolean
|
A value of Allowable Values:
|
proprietor_or_officer
object
|
Contains information about the proprietor or officer of the business. Allowable Values: A valid |
proprietor_or_officer.alternative_names
string
|
Alternate names of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.dob
datetime
|
Business proprietor or officer’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
proprietor_or_officer.email
string
|
Email address of the business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.first_name
string
|
First name of business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.home
object
|
An address associated with the business. Allowable Values: Valid address information |
proprietor_or_officer.home.address1
string
|
Street address of the business proprietor or officer. Allowable Values: 35 char max |
proprietor_or_officer.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
proprietor_or_officer.home.city
string
|
City of business proprietor or officer. Allowable Values: 35 char max |
proprietor_or_officer.home.country
string
|
Country where the business proprietor or officer resides. Allowable Values: 40 char max |
proprietor_or_officer.home.postal_code
string
|
Business proprietor or officer’s postal code. Allowable Values: 20 char max |
proprietor_or_officer.home.state
string
|
State where the business proprietor or officer resides. Allowable Values: 35 char max |
proprietor_or_officer.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
proprietor_or_officer.identifications
array of objects
|
One or more objects containing personal identifications of the business proprietor or officer. Allowable Values: Valid |
proprietor_or_officer.identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
proprietor_or_officer.identifications[].type
string
|
Form of identification. Allowable Values:
|
proprietor_or_officer.identifications[].value
string
|
Identification number. Allowable Values: 255 char max |
proprietor_or_officer.last_name
string
|
Last name of business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.middle_name
string
|
Middle name of business proprietor or officer. Allowable Values: 255 char max |
proprietor_or_officer.phone
string
|
Telephone number of the business proprietor or officer. Allowable Values: Format: 510-555-1212 or 5105551212 |
proprietor_or_officer.ssn
string
|
The Social Security Number of the business proprietor or officer. Allowable Values: 9 char max |
proprietor_or_officer.title
string
|
Title of business proprietor or officer. Allowable Values: 255 char max |
taxpayer_id
string
|
The taxpayer identifier of the business. Allowable Values: 255 char max |
token
string
|
The unique identifier of the business resource. Allowable Values: 1–36 chars |
website
string
|
URL of the business' website. Allowable Values: 255 char max |
List business children
Copy section link
Action: GET
Endpoint: /businesses/{parent_token}/children
Return an array of all child cardholders of a particular business.
Include the parent_token as a URL path parameter.
This endpoint supports field filtering.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
parent_token
string
|
The unique identifier of the parent business. Allowable Values: Existing |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of child cardholders to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
An array of cardholder objects. Allowable Values: Valid |
data[].account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
data[].active
boolean
|
A value of Allowable Values:
|
data[].address1
string
|
Cardholder’s street address. Allowable Values: 255 char max |
data[].address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
data[].birth_date
string
|
Cardholder’s birth date. Allowable Values: Format: yyyy-MM-dd |
data[].city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
data[].company
string
|
Company by which the cardholder is employed. Allowable Values: 255 char max |
data[].corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
data[].country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
data[].email
string
|
Cardholder’s email address. Allowable Values: 1–255 chars |
data[].first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
data[].gender
string
|
Cardholder’s gender. Allowable Values:
|
data[].honorific
string
|
Honorific used to address the cardholder (Doctor, for example). Allowable Values: 10 char max |
data[].id_card_expiration_date
string
|
Expiration date of the cardholder’s identification card. Allowable Values: Format: yyyy-MM-dd |
data[].id_card_number
string
|
Cardholder’s identification card number. Allowable Values: 255 char max |
data[].identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: Valid |
data[].identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
data[].identifications[].type
string
|
Form of identification. Allowable Values:
|
data[].identifications[].value
string
|
Identification number. Allowable Values: 255 char max |
data[].ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
data[].last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
data[].metadata
object
|
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 |
data[].middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
data[].nationality
string
|
Cardholder’s nationality. Allowable Values: 255 char max |
data[].notes
string
|
Notes pertaining to the cardholder. Allowable Values: 255 char max |
data[].parent_token
string
|
The Allowable Values: 1–36 chars |
data[].passport_expiration_date
string
|
Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
data[].passport_number
string
|
Cardholder’s passport number. Allowable Values: 40 char max |
data[].password
string
|
Password to the cardholder’s Allowable Values: 255 char max |
data[].phone
string
|
Cardholder’s phone number. Allowable Values: 255 char max |
data[].postal_code
string
|
Postal code of the cardholder’s address. Allowable Values: 10 char max |
data[].ssn
string
|
Cardholder’s Social Security Number. Allowable Values: |
data[].state
string
|
State where the cardholder resides. Allowable Values: 32 char max |
data[].token
string
|
Unique identifier of the cardholder’s Allowable Values: 1–36 chars |
data[].uses_parent_account
boolean
|
A value of Allowable Values:
|
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Retrieve business
Copy section link
Action: GET
Endpoint: /businesses/{token}
Retrieve a specific business.
Include the business token path parameter to specify the business to return.
This endpoint supports field filtering and sorting and pagination.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the Allowable Values: Existing |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
Response body
Copy section link
| Fields | Description |
|---|---|
account_holder_group_token
string
|
Associates the specified account holder group with the business. Allowable Values: 36 char max |
active
boolean
|
A value of Allowable Values:
|
attestation_consent
boolean
|
A value of Allowable Values:
|
attestation_date
datetime
|
The timestamp of the attestation. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
attester_name
string
|
The name of the attester for KYC verification. Allowable Values: 64 char max |
attester_title
string
|
The title of the attester for KYC verification. Allowable Values: 64 char max |
authentication
object
|
Contains email address and password information for the business resource. Allowable Values: Valid |
authentication.email_verified
boolean
|
A value of Allowable Values:
|
authentication.email_verified_time
datetime
|
The time and date that the email address was verified. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
authentication.last_password_update_time
datetime
|
The time and date that the password was last changed. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
beneficial_owner1
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner1.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner1.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner1.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner1.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner1.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner1.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner1.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner1.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner1.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner1.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner1.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner1.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner2.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner2.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner2.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner2.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner2.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner2.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner2.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner2.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner2.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner2.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner2.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner2.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner3.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner3.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner3.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner3.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner3.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner3.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner3.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner3.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner3.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner3.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner3.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner3.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4
object
|
Contains information about the beneficial owner of the business, if applicable. Allowable Values: Existing |
beneficial_owner4.first_name
string
|
First name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.getdob
datetime
|
Date of birth of the beneficial owner. Allowable Values: Format: yyyy-MM-dd |
beneficial_owner4.home
object
|
The home address of the beneficial owner. Allowable Values: Existing |
beneficial_owner4.home.address1
string
|
Street address. Allowable Values: 35 char max |
beneficial_owner4.home.address2
string
|
Additional address information. Allowable Values: 35 char max |
beneficial_owner4.home.city
string
|
City. Allowable Values: 35 char max |
beneficial_owner4.home.country
string
|
Country. Allowable Values: 40 char max |
beneficial_owner4.home.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
beneficial_owner4.home.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
beneficial_owner4.home.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
beneficial_owner4.last_name
string
|
Last name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.middle_name
string
|
Middle name of the beneficial owner. Allowable Values: 255 char max |
beneficial_owner4.phone
string
|
Ten-digit phone number of the beneficial owner. Allowable Values: Format: 510-555-1212 or 5105551212 |
beneficial_owner4.title
string
|
Title of the beneficial owner. Allowable Values: 255 char max |
business_name_dba
string
|
Fictitious business name or "Doing Business As" (DBA). Allowable Values: 255 char max |
business_name_legal
string
|
Legal name of business. Allowable Values: 255 char max |
business_type
string
|
Indicates the type of business (B2B [business-to-business] or B2C [business-to-consumer], for example). Allowable Values: 255 char max |
created_time
datetime
|
The date and time when the business was created, in UTC ( Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
date_established
datetime
|
The date and time when the business was established. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ |
duns_number
string
|
Data Universal Numbering System (DUNS) number of the business. Allowable Values: 255 char max |
general_business_description
string
|
General description of the business. Allowable Values: 255 char max |
history
string
|
History of the business. Allowable Values: 255 char max |
identifications
array of objects
|
One or more objects containing identifications associated with the business. Allowable Values: Existing |
identifications[].expiration_date
string
|
Expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
identifications[].type
string
|
The form of identification. Allowable Values:
|
identifications[].value
string
|
Identification number associated with the form of identification. Allowable Values: 255 char max |
in_current_location_since
datetime
|
The 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
|
Contains information about the organizational structure of the business. Allowable Values: Existing |
incorporation.address_registered_under
object
|
The registered business address. Allowable Values: Existing |
incorporation.address_registered_under.address1
string
|
Street address. Allowable Values: 35 char max |
incorporation.address_registered_under.address2
string
|
Additional address information. Allowable Values: 35 char max |
incorporation.address_registered_under.city
string
|
City. Allowable Values: 35 char max |
incorporation.address_registered_under.country
string
|
Country. Allowable Values: 40 char max |
incorporation.address_registered_under.postal_code
string
|
Postal code of the address. Allowable Values: 20 char max |
incorporation.address_registered_under.state
string
|
State, province, or territory of the address. Allowable Values: 35 char max |
incorporation.address_registered_under.zip
string
|
ZIP code of the address. Allowable Values: 20 char max |
incorporation.incorporation_type
string
|
Organizational structure of the business (corporation or sole proprietorship, for example). Allowable Values:
|
incorporation.is_public
boolean
|
A value of Allowable Values:
|
incorporation.name_registered_under
string
|
Name under which the business is registered. Allowable Values: 255 char max |
incorporation.state_of_incorporation
string
|
State where the business is incorporated. Allowable Values: 255 char max |
incorporation.stock_symbol
string
|
Stock symbol associated with the business. Allowable Values: 255 char max |
international_office_locations
string
|
The locations of the business' offices outside the US. Allowable Values: 255 char max |
ip_address
string
|
The IP address of the business. Allowable Values: 39 char max |
last_modified_time
datetime
|
The date and time when the business was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
metadata
object
|
Associates any additional metadata you provide with the business. Allowable Values: Existing |