Create Business

Action: POST
Endpoint: /businesses

To create a business, send a POST request to the /businesses endpoint and include the business details in JSON format in the body of the request. When you create any Marqeta resource, the system associates a token for referencing that resource. You can create your own token using any alpha-numeric characters, 36 chars max. If you do not include a token value, one is generated automatically.

In order to perform a KYC check, the business resource on which you perform the check must have the following fields configured:

  • business_name_legal
  • business_name_dba
  • office_location (object; cannot perform KYC if set to a PO Box)
  • taxpayer_id
  • incorporation.incorporation_type
  • incorporation.state_of_incorporation
  • phone (the top-level phone field)
  • date_established

For information on how to create a user that has a child-to-parent hierarchical relationship to the business, see Create User.

Body Field Details

Name Type Required? Description Allowable Values
token string No The unique identifier of the business.

If you do not include a token, the system will generate 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.
36 char max
business_name_legal string No Legal name of business.

Required for verification (KYC) checks.
255 char max
business_name_dba string No Fictitious business name.

Required for verification (KYC) checks.
255 char max
office_location object No Address of business office.

Required for verification (KYC) checks. Cannot perform KYC if set to a PO Box.
in_current_location_since string No The date on which the business office opened in its current location. yyyy-MM-dd | yyyy-MM-dd'T'HH:mm:ss.SSSZ | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | EEE' or ' dd MMM yyyy HH:mm:ss zzz'
phone string No 10-digit telephone number of business.

Required for verification (KYC) checks.
123-456-7890 or 1234567890

Do not insert a 1 before the area code.
website string No URL of the business's website. 255 char max
date_established string No Date the business was established.

Required for verification (KYC) checks.
yyyy-MM-dd | yyyy-MM-dd'T'HH:mm:ss.SSSZ | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | EEE' or ' dd MMM yyyy HH:mm:ss zzz'
general_business_description string No General description of the business. 255 char max
history string No History of the business. 255 char max
account_holder_group_token string No Associates the specified account holder group with the business. Existing account holder group token.

Issue a GET to /accountholdergroups to retrieve account holder group tokens.
ip_address string No The IP address of the business. 39 char max
notes string No Any additional information pertaining to the business. 255 char max
active boolean No Indicates whether the business is active. true | false

Default: true
business_type string No Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). 255 char max
international_office_locations string No The locations of the business's offices outside the US. 255 char max
primary_contact object No Describes the business's primary contact.
taxpayer_id string No Tax identification number of business.

Required for verification (KYC) checks.
255 char max
duns_number string No Data Universal Numbering System (DUNS) number of business. 255 char max
incorporation object No Contains information regarding the business's incorporation.

Required for verification (KYC) checks.
proprietor_or_officer object No Contains information regarding the business's proprietor or officer.
metadata object No Associates customer-injected metadata with the business.
password string No Password for the business's account.
  • 8-20 characters
  • must contain at least 1 numeral
  • must contain at least 1 lower-case letter
  • must contain at least 1 upper-case letter
  • must contain at least 1 of these symbols: @#$%!^&*()\_+~`-=[]{}|;:'",./<>?

office_location

Name Type Required? Description Allowable Values
address1 string No Business office's street address.

Required for verification (KYC) checks. Cannot perform KYC if set to a PO Box.
35 char max
address2 string No Additional address information.

Cannot perform KYC if set to a PO Box.
35 char max
city string No Business office's city.

Required for verification (KYC) checks.
35 char max
state string No Business office's state.

Required for verification (KYC) checks.
35 char max
zip string No Business office's ZIP code.

Required for verification (KYC) checks.
20 char max
country string No Business office's country.

Required for verification (KYC) checks.
40 char max

primary_contact

Name Type Required? Description Allowable Values
full_name string No Name of primary contact. 255 char max
title string No Title of primary contact. 255 char max
department string No Department of primary contact. 255 char max
phone string No Telephone number of primary contact. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
extension string No Telephone extention of primary contact. 255 char max
fax string No Fax number of primary contact. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
mobile string No Mobile telephone number of primary contact. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
email string No Email address of primary contact. 255 char max

incorporation

Name Type Required? Description Allowable Values
is_public boolean No "True" indicates the business is publicly held. true | false

Default: false
incorporation_type string No The business's type of incorporation.

Required for verification (KYC) checks.
LLC | CORPORATION | SOLE_PROPRIETORSHIP | PARTNERSHIP | OTHER
stock_symbol string No The business's stock symbol. 255 char max
state_of_incorporation string No The state in which the business is incorporated.

Required for verification (KYC) checks.
255 char max
name_registered_under string No The name under which the business is registered. 255 char max
address_registered_under object No The address under which the business is registered.

incorporation.address_registered_under

Name Type Required? Description Allowable Values
address1 string No Business's registered street address. 35 char max
address2 string No Additional address information. 35 char max
city string No Business's registered city. 35 char max
state string No Business's registered state. 35 char max
zip string No Business's registered ZIP code. 20 char max
country string No Business's registered country. 40 char max

proprietor_or_officer

Name Type Required? Description Allowable Values
first_name string No First name of business proprietor or officer. 255 char max
middle_name string No Middle name of business proprietor or officer. 255 char max
last_name string No Last name of business proprietor or officer. 255 char max
alternative_names string No Alternate names of business proprietor or officer. 255 char max
title string No Title of business proprietor or officer. 255 char max
home object No Describes the business proprietor or officer's home.
ssn string No Social security number of business proprietor or officer. Full or last 4 digits.

Numerals only
dob string No Business proprietor or officer's date of birth yyyy-MM-dd | yyyy-MM-dd'T'HH:mm:ss.SSSZ | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | EEE' or ' dd MMM yyyy HH:mm:ss zzz'
phone string No Telephone number of business proprietor or officer. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
email string No Email address of business proprietor or officer. 255 char max

proprietor_or_officer.home

Name Type Required? Description Allowable Values
address1 string No Street address of business proprietor or officer. 35 char max
address2 string No Additional address information. 35 char max
city string No City of business proprietor or officer. 35 char max
state string No State in which business proprietor or officer resides. 35 char max
zip string No Business proprietor or officer's ZIP code. 20 char max
country string No Country in which business proprietor or officer resides 40 char max

metadata

Name Type Required? Description Allowable Values
customer_defined_name_01
customer_defined_name_02
...
customer_defined_name_20
(255 char max per name)
string No Associates customer-injected metadata with the business.

You can define the names and values of up to 20 fields, for example:

"metadata": {
  "my_name_1": "my_value_1",
  "my_name_2": "my_value_2"
  }
  • Up to 20 name-value pairs
  • 255 char max per name
  • 255 char max per value

Sample Request Body

{
"token": "my_business_02",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"active": true,
"notes": "My notes",
"password": "My_passw0rd",
"phone": "1234567890",
"website": "https://my_business_02.com",
"history": "My_business_history",
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B street",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"incorporation_type": "LLC"
},
"ip_address": "67.120.28.118",
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"in_current_location_since": "2010-04-15",
"date_established": "2010-04-15",
"general_business_description": "My_business_description",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"taxpayer_id": "123456789",
"duns_number": "123456789",
"primary_contact": {
"title": "Dr",
"department": "My_department",
"phone": "1234567890",
"extension": "11",
"fax": "1234567890",
"email": "dr_me@my_business.com",
"full_name": "First Middle Last",
"mobile": "1234567890"
},
"proprietor_or_officer": {
"title": "Dr",
"dob": "1954-03-07",
"phone": "1234567890",
"email": "dr_me@my_business.com",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My alternative name",
"home": {
"address1": "123 B street",
"address2": "Apt A",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
}
}
}

Sample Response Body

{
"token": "my_business_02",
"active": true,
"notes": "My notes",
"ip_address": "67.120.28.118",
"password": "___________",
"phone": "1234567890",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"in_current_location_since": "2010-04-15",
"website": "https://my_business_02.com",
"date_established": "2010-04-15",
"general_business_description": "My_business_description",
"history": "My_business_history",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"taxpayer_id": "123456789",
"duns_number": "123456789",
"primary_contact": {
"full_name": "First Middle Last",
"title": "Dr",
"department": "My_department",
"phone": "1234567890",
"extension": "11",
"fax": "1234567890",
"mobile": "1234567890",
"email": "dr_me@my_business.com"
},
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B street",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"incorporation_type": "LLC"
},
"proprietor_or_officer": {
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My alternative name",
"title": "Dr",
"home": {
"address1": "123 B street",
"address2": "Apt A",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"dob": "1954-03-07",
"phone": "1234567890",
"email": "dr_me@my_business.com"
},
"created_time": "2017-01-13T23:29:10Z",
"last_modified_time": "2017-01-13T23:29:10Z",
"deposit_account": {
"token": "420df02a-6aef-42bf-be7b-0d080ebf7573",
"account_number": "12342126720827265",
"routing_number": "293748000",
"allow_immediate_credit": false
}
}


Retrieve Business

Action: GET
Endpoint: /businesses/{token}

To retrieve a specific business, issue a GET request to the /businesses/{token} endpoint. Include the business token path parameter to specify the business to return.

This endpoint supports field filtering, pagination, and sorting.

URL Path Parameters

Name Type Required? Description Allowable Values
token string Yes Identifies the business to retrieve. Existing business token.

Issue a GET to /businesses to retrieve business tokens.

Sample Response Body

{
"token": "my_business_02",
"active": true,
"notes": "My notes",
"ip_address": "67.120.28.118",
"password": "___________",
"phone": "1234567890",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"in_current_location_since": "2010-04-15",
"website": "https://my_business_02.com",
"date_established": "2010-04-15",
"general_business_description": "My_business_description",
"history": "My_business_history",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"taxpayer_id": "123456789",
"duns_number": "123456789",
"primary_contact": {
"full_name": "First Middle Last",
"title": "Dr",
"department": "My_department",
"phone": "1234567890",
"extension": "11",
"fax": "1234567890",
"mobile": "1234567890",
"email": "dr_me@my_business.com"
},
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B street",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"incorporation_type": "LLC"
},
"proprietor_or_officer": {
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My alternative name",
"title": "Dr",
"home": {
"address1": "123 B street",
"address2": "Apt A",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"dob": "1954-03-07",
"phone": "1234567890",
"email": "dr_me@my_business.com"
},
"created_time": "2017-01-13T23:29:10Z",
"last_modified_time": "2017-01-13T23:29:10Z",
"deposit_account": {
"token": "420df02a-6aef-42bf-be7b-0d080ebf7573",
"account_number": "12342126720827265",
"routing_number": "293748000",
"allow_immediate_credit": false
}
}


Update Business

Action: PUT
Endpoint: /businesses/{token}

To update a business, issue a PUT request to /businesses/{token}. Use the token path parameter to specify the business to update. Include the business details to update in JSON format in the body of the request. Only values of parameters in the request are modified; all others are left unchanged.

URL Path Parameters

Name Type Required? Description Allowable Values
token string Yes Identifies the business to update. Existing business token.

Issue a GET to /businesses to retrieve business tokens.

Body Field Details

Name Type Required? Description Allowable Values
business_name_legal string No Legal name of business.

Required for verification (KYC) checks.
255 char max
business_name_dba string No Fictitious business name.

Required for verification (KYC) checks.
255 char max
office_location object No Address of business office.

Required for verification (KYC) checks. Cannot perform KYC if set to a PO Box.
in_current_location_since string No The date on which the business office opened in its current location. yyyy-MM-dd | yyyy-MM-dd'T'HH:mm:ss.SSSZ | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | EEE' or ' dd MMM yyyy HH:mm:ss zzz'
phone string No 10-digit telephone number of business.

Required for verification (KYC) checks.
123-456-7890 or 1234567890

Do not insert a 1 before the area code.
website string No URL of the business's website. 255 char max
date_established string No Date the business was established.

Required for verification (KYC) checks.
yyyy-MM-dd | yyyy-MM-dd'T'HH:mm:ss.SSSZ | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | EEE' or ' dd MMM yyyy HH:mm:ss zzz'
general_business_description string No General description of the business. 255 char max
history string No History of the business. 255 char max
account_holder_group_token string No Associates the specified account holder group with the business. Existing account holder group token.

Issue a GET to /accountholdergroups to retrieve account holder group tokens.
ip_address string No The IP address of the business. 39 char max
notes string No Any additional information pertaining to the business. 255 char max
active boolean No Indicates whether the business is active. true | false

Default: true
business_type string No Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). 255 char max
international_office_locations string No The locations of the business's offices outside the US. 255 char max
primary_contact object No Describes the business's primary contact.
taxpayer_id string No Tax identification number of business.

Required for verification (KYC) checks.
255 char max
duns_number string No Data Universal Numbering System (DUNS) number of business. 255 char max
incorporation object No Contains information regarding the business's incorporation.

Required for verification (KYC) checks.
proprietor_or_officer object No Contains information regarding the business's proprietor or officer.
metadata object No Associates customer-injected metadata with the business.
password string No Password for the business's account.
  • 8-20 characters
  • must contain at least 1 numeral
  • must contain at least 1 lower-case letter
  • must contain at least 1 upper-case letter
  • must contain at least 1 of these symbols: @#$%!^&*()\_+~`-=[]{}|;:'",./<>?

office_location

Name Type Required? Description Allowable Values
address1 string No Business office's street address.

Required for verification (KYC) checks. Cannot perform KYC if set to a PO Box.
35 char max
address2 string No Additional address information.

Cannot perform KYC if set to a PO Box.
35 char max
city string No Business office's city.

Required for verification (KYC) checks.
35 char max
state string No Business office's state.

Required for verification (KYC) checks.
35 char max
zip string No Business office's ZIP code.

Required for verification (KYC) checks.
20 char max
country string No Business office's country.

Required for verification (KYC) checks.
40 char max

primary_contact

Name Type Required? Description Allowable Values
full_name string No Name of primary contact. 255 char max
title string No Title of primary contact. 255 char max
department string No Department of primary contact. 255 char max
phone string No Telephone number of primary contact. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
extension string No Telephone extention of primary contact. 255 char max
fax string No Fax number of primary contact. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
mobile string No Mobile telephone number of primary contact. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
email string No Email address of primary contact. 255 char max

incorporation

Name Type Required? Description Allowable Values
is_public boolean No "True" indicates the business is publicly held. true | false

Default: false
incorporation_type string No The business's type of incorporation.

Required for verification (KYC) checks.
LLC | CORPORATION | SOLE_PROPRIETORSHIP | PARTNERSHIP | OTHER
stock_symbol string No The business's stock symbol. 255 char max
state_of_incorporation string No The state in which the business is incorporated.

Required for verification (KYC) checks.
255 char max
name_registered_under string No The name under which the business is registered. 255 char max
address_registered_under object No The address under which the business is registered.

incorporation.address_registered_under

Name Type Required? Description Allowable Values
address1 string No Business's registered street address. 35 char max
address2 string No Additional address information. 35 char max
city string No Business's registered city. 35 char max
state string No Business's registered state. 35 char max
zip string No Business's registered ZIP code. 20 char max
country string No Business's registered country. 40 char max

proprietor_or_officer

Name Type Required? Description Allowable Values
first_name string No First name of business proprietor or officer. 255 char max
middle_name string No Middle name of business proprietor or officer. 255 char max
last_name string No Last name of business proprietor or officer. 255 char max
alternative_names string No Alternate names of business proprietor or officer. 255 char max
title string No Title of business proprietor or officer. 255 char max
home object No Describes the business proprietor or officer's home.
ssn string No Social security number of business proprietor or officer. Full or last 4 digits.

Numerals only.
dob string No Business proprietor or officer's date of birth yyyy-MM-dd | yyyy-MM-dd'T'HH:mm:ss.SSSZ | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | EEE' or ' dd MMM yyyy HH:mm:ss zzz'
phone string No Telephone number of business proprietor or officer. 123-456-7890 or 1234567890

Do not insert a 1 before the area code.
email string No Email address of business proprietor or officer. 255 char max

proprietor_or_officer.home

Name Type Required? Description Allowable Values
address1 string No Street address of business proprietor or officer. 35 char max
address2 string No Additional address information. 35 char max
city string No City of business proprietor or officer. 35 char max
state string No State in which business proprietor or officer resides. 35 char max
zip string No Business proprietor or officer's ZIP code. 20 char max
country string No Country in which business proprietor or officer resides 40 char max

metadata

Name Type Required? Description Allowable Values
customer_defined_name_01
customer_defined_name_02
...
customer_defined_name_20
(255 char max per name)
string No Associates customer-injected metadata with the business.

You can define the names and values of up to 20 fields, for example:

"metadata": {
  "my_name_1": "my_value_1",
  "my_name_2": "my_value_2"
  }


The following samples show how to update, add, and delete fields. Existing fields are unaffected unless they are included in the request.

Update a field's value:
"metadata": {
  "my_name_1": "my_updated_value"
  }


Add a new field:
"metadata": {
  "my_new_field": "my_value"
  }


Delete an existing field:
"metadata": {
  "my_name_1": null
  }

Up to 20 name-value pairs.

255 char max per name.

255 char max per value.

Sample Request Body

{
"active": "false"
}

Sample Response Body

{
"token": "my_business_02",
"active": false,
"notes": "My notes",
"ip_address": "67.120.28.118",
"password": "___________",
"phone": "1234567890",
"metadata": {
"my_name_1": "my_value_1",
"my_name_2": "my_value_2"
},
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"in_current_location_since": "2010-04-15",
"website": "https://my_business_02.com",
"date_established": "2010-04-15",
"general_business_description": "My_business_description",
"history": "My_business_history",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"taxpayer_id": "123456789",
"duns_number": "123456789",
"primary_contact": {
"full_name": "First Middle Last",
"title": "Dr",
"department": "My_department",
"phone": "1234567890",
"extension": "11",
"fax": "1234567890",
"mobile": "1234567890",
"email": "dr_me@my_business.com"
},
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B street",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"incorporation_type": "LLC"
},
"proprietor_or_officer": {
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My alternative name",
"title": "Dr",
"home": {
"address1": "123 B street",
"address2": "Apt A",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"dob": "1954-03-07",
"phone": "1234567890",
"email": "dr_me@my_business.com"
},
"created_time": "2017-01-13T23:29:10Z",
"last_modified_time": "2017-01-13T23:29:10Z",
"deposit_account": {
"token": "420df02a-6aef-42bf-be7b-0d080ebf7573",
"account_number": "12342126720827265",
"routing_number": "293748000",
"allow_immediate_credit": false
}
}


List Businesses

Action: GET
Endpoint: /businesses

To return an array of all businesses, issue a GET request to the /businesses endpoint.

To narrow your result set to businesses that match a particular legal or ficticious name, include the appropriate parameters from the following Query Parameters table. This endpoint also supports field filtering, pagination, and sorting.

Query Parameters

Name Type Required? Description Allowable Values
business_name_legal string No Performs a non-case-sensitive match on the business's business_name_legal field. Matching is partial on the beginning of the name. For example, a match on "Tool" will return both "Tools R Us" and "Tools & More". 40 char max
business_name_dba string No Performs a non-case-sensitive match on the business's business_name_dba field. Matching is partial on the beginning of the name. For example, a match on "Tool" will return both "Tools R Us" and "Tools & More". 40 char max
dda string No Retrieves businesses with the specified direct deposit account (DDA) number. Existing DDA number

Issue a GET to /directdeposits/accounts/{business_token} to retrieve the DDA number for a specific business.

Issue a GET to /businesses to retrieve business tokens.

Sample Response Body

{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": true,
"data": [
{
"token": "my_business_01",
"active": true,
"notes": "My notes",
"password": "___________",
"phone": "1234567890",
"website": "https://my_business.com",
"history": "My_business_history",
"incorporation": {
"is_public": true,
"stock_symbol": "MB",
"state_of_incorporation": "CA",
"name_registered_under": "First Middle Last",
"address_registered_under": {
"address1": "123 B street",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"incorporation_type": "LLC"
},
"ip_address": "67.120.28.118",
"business_name_legal": "My_legal_business_name",
"business_name_dba": "My_fictitious_business_name",
"office_location": {
"address1": "123 A street",
"address2": "Suite 123",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
},
"in_current_location_since": "2010-04-15",
"date_established": "2010-04-15",
"general_business_description": "My_business_description",
"business_type": "My_business_type",
"international_office_locations": "Athens, Greece; Buenos Aires, Argentina",
"taxpayer_id": "123456789",
"duns_number": "123456789",
"primary_contact": {
"title": "Dr",
"department": "My_department",
"phone": "1234567890",
"extension": "11",
"fax": "1234567890",
"email": "dr_me@my_business.com",
"full_name": "First Middle Last",
"mobile": "1234567890"
},
"proprietor_or_officer": {
"title": "Dr",
"dob": "1954-03-07",
"phone": "1234567890",
"email": "dr_me@my_business.com",
"first_name": "First",
"middle_name": "Middle",
"last_name": "Last",
"alternative_names": "My alternative name",
"home": {
"address1": "123 B street",
"address2": "Apt A",
"city": "My_city",
"state": "CA",
"zip": "94711",
"country": "USA"
}
},
"created_time": "2016-10-18T21:17:03Z",
"last_modified_time": "2016-10-19T22:48:02Z"
}
]
}


List Business Children

Action: GET
Endpoint: /businesses/{parent_token}/children

To return an array of all child-users of a particular business, issue a GET request to the /businesses/{parent_token}/children endpoint. Include the parent_token as a URL path parameter.

This endpoint supports field filtering.

URL Path Parameters

Name Type Required? Description Allowable Values
parent_token string Yes Indentifies the business whose child-users you want to list. Existing business token.

Issue a GET to /businesses to retrieve business tokens.

Sample Response Body

{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"token": "my_child_user_01",
"active": true,
"password": "___________",
"phone": "510-111-1111",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"gender": "F",
"email": "my_child_user_01@gmail.com",
"address1": "1234 Lake Street",
"city": "Berkeley",
"state": "CA",
"zip": "94702",
"country": "USA",
"ssn": "___________",
"first_name": "First",
"last_name": "Last",
"birth_date": "1990-01-01",
"corporate_card_holder": false,
"parent_token": "my_business_01",
"uses_parent_account": true,
"created_time": "2016-10-20T17:50:36Z",
"last_modified_time": "2016-10-20T17:50:36Z",
"business_token": "my_business_01"
}
]
}


Retrieve Business SSN

Action: GET
Endpoint: /businesses/{token}/ssn

To retrieve the social security number (SSN) of a business's proprietor (the value of the proprietor_or_officer.ssn field), issue a GET request to the /businesses/{token}/ssn endpoint. Include the token path parameter to specify the business whose ssn you want to return. You can indicate whether to return the full number or the last four digits only.

URL Path Parameters

Name Type Required? Description Allowable Values
token string Yes Identifies the business whose SSN you want to retrieve. Existing business token.

Issue a GET to /businesses to retrieve business tokens.

Query Parameters

Name Type Required? Description Allowable Values
full_ssn boolean Yes To return the full social security number, set to true. To return only the last 4 digits set to false. true | false

Default: false

Sample Response Body

{
"ssn": "5555"
}