Client Fields
| Field | Data Type | Description |
|---|---|---|
address | String | The street address associated with the client. |
city | String | The city associated with the client. |
country | String | The country associated with the client. |
created_at | String | The date and time at which the client was created on the MX Platform. |
id | String | The unique partner created identifier for the client. |
guid | String | The unique identifier for the client. Defined by MX. |
main_url | String | The main url associated with the client, which is often the client's primary website. |
name | String | The partner-defined name for the client |
oauth_app_description | String | The oauth app description associated with the client. |
oauth_app_name | String | The oauth app name associated with the client. This will be displayed to users and we suggest using a recognizable name. |
postal_code | String | The postal code associated with the client. |
state | String | The state associated with the client. |
support_email | String | The support email associated with the client. |
support_phone | String | The support phone number associated with the client. |
support_url | String | The support email associated with the client |
updated_at | String | The date and time at which the client was most recently updated. |
products | Object | The object of MX products that are enabled or disabled for the associated client. |
account_verification | Boolean | If the instant account verification product is enabled. |
balance | Boolean | If the balance checks product is enabled. |
business_suite | Boolean | If the business suite product is enabled. |
data_api | Boolean | If the data access API product is enabled. |
history | Boolean | If the extended transaction history product is enabled. |
identity_verification | Boolean | If the account owner identification product is enabled. |
microdeposits | Boolean | If the microdeposits product is enabled. |
moneymap | Boolean | If the moneymap product is enabled. |
platform_api | Boolean | The platform API product is always enabled. This is because the Client Onboarding API endpoints are only available via Platform API. |
pulse | Boolean | If the insights product is enabled. |
reporting_api | Object | The object of reporting API product(s) enabled. |
is_enabled | Boolean | If the reporting API is enabled. This is enabled by default unless set to false. |
base_reports | Boolean | If the the base resource reports are enabled. This is enabbled by default unless set to false. |
sherlock_api | Boolean | If the data enhancement off platform product is enabled. |
statements | Boolean | If the statements product is enabled. |
transactions | Boolean | The aggregation product is always enabled. |