Data Schema

Datasets

Information in a member's Personal Data Store (PDS) is stored as series of datasets. A dataset might, for example, represent information pertaining to the member's driver's license, passport or house. A member can also have multiple instances of a dataset. For instance, a member may have a second instance of the 'Home' dataset containing details of a second address.

Each member has control over how organisations access their datasets by changing the access permissions on the connection between their PDS and the organisation.

Name Dataset Name Description Environment
Bank Account field_ds_bank_account Details of a member's bank account Production
Community Profile field_ds_community_profile Details of a member's community profile. Production
Credit Card field_ds_credit_card Details of the member's credit cards. Production
Driving Licence field_ds_driving_licence Data relating to a members driving licence Production
Education field_ds_education Data relating to a members education history Production
Employer field_ds_employment Details of each employer. Production
Health field_ds_health High-level health and GP details. Production
Home field_ds_home Data relating to a members home Production
Local Authority field_ds_local_authority Data relating to a members Local Authority Production
Loyalty Scheme field_ds_loyalty_scheme Data relating to a member's loyalty schemes. Production
National Insurance field_ds_ni Data relating to a members National Insurance details Production
Notepad field_ds_notepad Notes made by a member. Production
Passport field_ds_passport Data relating to a members passport details Production
Personal details field_ds_personal_details Data relating to a members personal details Production
Place of Birth field_ds_birth Data relating to a members date & place of birth Production
Travel Card field_ds_travel Details of travel arrangements. Production
TV Licence field_ds_tv_licence Television licence details. Production
Utility Account Details field_ds_utility Data relating to a members utilities accounts Production
Vehicle field_ds_assets Details of vehicles owned. Production
Voluntary field_ds_voluntary Details of voluntary activities. Production

Transactional Datasets

While some datasets change infrequently like the ones listed above, other datasets are updated constantly. Examples include browser history, bank transactions, and the call records in your mobile bill.

These are referred to as Transactional Datasets. The distinctions between an API call made to a regular Dataset and a Transactional Dataset are given in the Connection API table.

Name Dataset Name Description Environment
Assurance Log ds_assurance_log Logs all assurance records. Production
Bank Account Transactions ds_bank_account_transactions Bank account transactions Production
Bookmarks ds_bookmarks User bookmarks Production
Browsing History ds_browsing_history User browsing history Production
Credentials ds_credentials Details of the member's credentials (passwords) and associated details. Production
Credit Card Transactions ds_cc_transactions Credit card transactions Production
Device App Settings ds_device_app_settings Table for storing device app setting variables. Production
Device Record ds_device_record Records of devices. Production
Identity Protocol Settings ds_identity_protocol_settings Stores Identity protocol settings. Production
Identity Services ds_identity_services_log Identity Services Log Production
Journeys ds_journeys Journey data Production
Location Data ds_location_data Location data from devices. Production
Loyalty Scheme ds_loyalty_scheme Loyalty scheme data Production
Telephone Calls and SMS ds_utility_tel_calls Telephone calls Production
Utility Billing Records ds_utility_billing Utility billing Production
Utility Data Usage ds_utility_data_usage Data usage Production
Utility Meter Reading ds_utility_meter_readings Utility meter readings Production
Variables ds_variables Table for storing variables. Production

The Developer Namespace Dataset

The Developer Namespace Dataset enables developers to 'simulate' storing data against a dataset that is not yet available by allowing developers to save custom serialised JSON data to a connection. Any data can be stored inside this namespace, as long as it is valid JSON. This feature could be used to store Application or Connection state data; data that is not currently supported in the Master Schema.

Each developer’s namespace data is stored separately from each other, based on the developer’s API key. This means that a developer cannot access another developer’s namespace data. This feature is only available in the Sandbox environment.

Name Dataset Name Environment
Developer Namespace field_ds_developer_namespace Sandbox only

New Datasets

New datasets to cover new use-cases are constantly being added to the platform. These start out on the Sandbox environment at https://sbx-api.mydex.org before graduating to the live platform at https://api.mydex.org.

If there's a dataset you want to see added, please let us know by filling out our dataset request form.

In addition to listening on a number of support channels, you can email the support team directly at developersupport@mydex.org.