GET///
List resources for the directors of a business.
URL path parameters
| Fields | Description |
|---|---|
| business_token string Required | Unique identifier of the business resource. Allowable Values: Existing business token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of business director resources to retrieve. Allowable Values: 1-10 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -createdTime |
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Indicates whether the business director is active. Allowable Values: true, false |
| address object Conditionally returned | Address associated with the business. Allowable Values: address1, address2, city, country, postal_code, state, zip |
| address.address1 string Conditionally returned | Street name and number of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.address2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.city string Conditionally returned | City of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.country string Conditionally returned | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| address.postal_code string Conditionally returned | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| address.state string Conditionally returned | State, province, or territory of the address. This field is returned if it exists in the resource. Allowable Values: 35 char max |
| address.zip string Conditionally returned | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| birth_date string Conditionally returned | Business director’s date of birth. Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the business director resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| email string Conditionally returned | Email address of the business director. Allowable Values: 255 char max |
| first_name string Conditionally returned | First or given name of the business director. Allowable Values: 255 char max |
| identifications array of objects Conditionally returned | One or more objects containing personal identifications of the business director. Allowable Values: Valid array of one or more identifications objects |
| identifications[].expiration_date string Conditionally returned | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| identifications[].type string Conditionally returned | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| identifications[].value string Conditionally returned | Number associated with the identification. Allowable Values: 255 char max |
| last_modified_time datetime Returned | Date and time when the business director resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_name string Conditionally returned | Last or family name of the business director. Allowable Values: 255 char max |
| middle_name string Conditionally returned | Middle name of the business director. Allowable Values: 255 char max |
| nationality string Conditionally returned | Nationality of the business director. Allowable Values: 255 char max |
| phone string Conditionally returned | Full phone number of the business director. Allowable Values: 255 char max |
| place_of_birth string Conditionally returned | Business director’s place of birth. Allowable Values: 255 char max |
| title string Conditionally returned | Title of the business director. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the business director resource. Allowable Values: 36 char max |