Skip to main content

Client Fields

FieldData TypeDescription
addressStringThe street address associated with the client.
cityStringThe city associated with the client.
countryStringThe country associated with the client.
created_atStringThe date and time at which the client was created on the MX Platform.
idStringThe unique partner created identifier for the client.
guidStringThe unique identifier for the client. Defined by MX.
main_urlStringThe main url associated with the client, which is often the client's primary website.
nameStringThe partner-defined name for the client
oauth_app_descriptionStringThe oauth app description associated with the client.
oauth_app_nameStringThe oauth app name associated with the client. This will be displayed to users and we suggest using a recognizable name.
postal_codeStringThe postal code associated with the client.
stateStringThe state associated with the client.
support_emailStringThe support email associated with the client.
support_phoneStringThe support phone number associated with the client.
support_urlStringThe support email associated with the client
updated_atStringThe date and time at which the client was most recently updated.
productsObjectThe object of MX products that are enabled or disabled for the associated client.
account_verificationBooleanIf the instant account verification product is enabled.
balanceBooleanIf the balance checks product is enabled.
business_suiteBooleanIf the business suite product is enabled.
data_apiBooleanIf the data access API product is enabled.
historyBooleanIf the extended transaction history product is enabled.
identity_verificationBooleanIf the account owner identification product is enabled.
microdepositsBooleanIf the microdeposits product is enabled.
moneymapBooleanIf the moneymap product is enabled.
platform_apiBooleanThe platform API product is always enabled. This is because the Client Onboarding API endpoints are only available via Platform API.
pulseBooleanIf the insights product is enabled.
reporting_apiObjectThe object of reporting API product(s) enabled.
is_enabledBooleanIf the reporting API is enabled. This is enabled by default unless set to false.
base_reportsBooleanIf the the base resource reports are enabled. This is enabbled by default unless set to false.
sherlock_apiBooleanIf the data enhancement off platform product is enabled.
statementsBooleanIf the statements product is enabled.
transactionsBooleanThe aggregation product is always enabled.