Home
Documentation
Start typing to search…

DDx: Exchange Integration Set Up

ABOUT THE INTEGRATION

DDx Exchange clients can easily upload data to the Exchange via the Dataset Exchange API, a product of the DDx API team.

With a storage bucket provisioned and maintained by the DDx API team, data is securely transferred to the Exchange and ingested for credits. Exchange clients can enable a set-it-and-forget-it integration which automatically transfers data to the Exchange whenever a client adds new data to be transferred.

The Dataset Exchange API -> DDx Exchange integration currently supports data ingestion only. Data delivery from the Exchange will be supported via DDx API architecture later in 2026.

WORKFLOW SET UP REQUIREMENTS

To set up the Dataset Exchange API -> DDx Exchange workflow, the following items are required:

  • A current Exchange client agreement as either single organization or an enterprise member organization
  • Data to share with DDx Exchange
  • Use of Google Cloud Platform (GCP)
  • A DDx API Console Account: app.movementinfrastructure.org
    • The Console is where a client can connect to the Exchange via the Dataset Exchange API. Once the account is created, the Exchange client status will be verified and access to setting up the connection will be approved. To set up an Organizational Workspace, review those steps here!
    • If you are an Exchange client who uses the flat file transfer service, you have the option to migrate your transfer to the Dataset Exchange API flow.

    DATA TRANSFER REQUIREMENTS

    ✋

    DDx API follows the standard data type names from DDx’s data dictionary and you must set up your CSV file to follow the same column order. Data will not be transferred correctly for use in DDx Exchange if data type names differ and/or columns are out of order. If that is the case, you may be required to resubmit your data. Reach out to [email protected] if you need an updated copy of the data dictionary!


  • Review the folder structure and standardization in the example below to ensure your data is properly uploaded into your bucket, using the GCS folder setup instructions.
  • Ensure your file path and filenames match i.e. the voter_registration_submissions file path should have a filename with the same convention. No shorthand!
  • If you are submitting survey response files and survey question metadata, please follow the respective column header ID.
  • If you require access to the DDx dictionary, you can access it via your DDx Dashboard under the Resources tab, contact your DDx Exchange Client Representative, or reach out to [email protected].

File Structure Example

Please note: If you would like to upload a person list to share, this will be done directly in your DDx Dashboard under ‘Manage Lists’ using the List Uploader Feature.

SENDING DATA TO THE EXCHANGE VIA THE DATASET EXCHANGE API

  1. Create a Console account at app.movementinfrastructure.org
    1. Existing Exchange clients with Personal Workspaces:
    2. Request an Organizational Workspace by reaching out to [email protected] or directly to the Client Success Team. Your Organizational Workspace will have the same naming as your Exchange client slug.
      1. Existing Exchange clients with Organizational Workspaces:
        1. Confirm your Organizational Workspace name matches your Exchange client slug and request access to the Dataset Exchange API -> Exchange workflow by reaching out to [email protected].
        2. Proceed to Step 2! New Exchange Clients:
      2. Create the Console account and request an Organizational Workspace by submitting a request to [email protected].
  2. Log in to your Console account and Select ‘View & Manage Datasets’ under Dataset Exchange.
  3. Connect to the DDx Exchange Application.
    1. Select ‘Apps & Workspace Info’ and select the ‘+ Connect Application button!

  1. On the ‘Connect an Application’ page, select the ‘DDx Exchange’ App.
    1. Note: Only select the ‘DDx Exchange’ option. If you are interested in being able to use the Dataset Exchange API to connect to other available vendors that you use, reach out to [email protected].
  2. Confirm the permissions that are being provided to the DDx Exchange App by selecting ‘Next’.
  1. To receive the JSON credentials, select ‘Generate One-Time Credentials’ to view and copy the credentials into your GCP account to set up the bucket. DDx API provides a Google Cloud Platform (GCP) bucket where the data can be added for transfer to the Exchange..
    1. IMPORTANT: For security purposes, the JSON credentials can only be viewed/copied one time. Please be ready to input those credentials into GCP before clicking the button to generate the credentials.
    2. If selecting ‘Skip This Step’, the credentials can be accessed in the DDx Exchange tile under the ‘Apps & Workspace ID’ tab.
  1. Copy the credentials and paste those credentials into a file to use for authentication when connecting to the bucket. Once any data is uploaded to the bucket, it will be picked up and transferred to the Exchange via the Dataset Exchange API.
    1. If you have a Snowflake set up or similar configuration that requires DDx API to access your service account, let us know so we can ensure proper set up!
        1. Ensure any data that is uploaded follows the DDx data dictionary and is structured correctly for being ingested into the Exchange. Review the Data Transfer Requirements above prior to upload!
        2. Note: If you ever decided to disconnect from the Exchange App, the bucket and its content along with the service account will be deleted.

RECEIVE DATA FROM THE EXCHANGE

  1. Set Up Your File Storage Service and Bucket
    1. To receive data from DDx, you will need to have an account with one of the following cloud storage services and create a bucket where DDx can place that data.
    2. You should use one of the following cloud storage services:
      1. Sign Up For Google Cloud Platform
        1. How to: Configure access using GCP
        2. Sign Up For Amazon Web Services S3
        3. How to: AWS S3 Configuration

If you use CTA for data storage solutions, contact us at [email protected] and we will help work through the process with your organization and CTA.

If you need help establishing a GCP or AWS account and do not use CTA, please contact us at [email protected] to provide additional support.

  1. Set Up Your Bucket To Receive Data
    1. Bucket Naming Convention There is not a requirement for a particular bucket name, but we suggest naming your bucket based on the direction the data is flowing. To receive files from DDx, your bucket name might be data-from-ddx or from-ddx.
📘

Example: data-from-ddx

  1. Set Up The Required Permissions On Your Bucket

    In order to successfully submit your credentials for GCP or AWS, there are specific permission requirements for each option which will populate based on which service you select in the Console. Read through the following instructions on required permissions for receiving data from DDx.

📖

GCP Permissions Resource

Instructions For Receiving Data from DDx


AWS S3 Permissions AWS S3 Permissions Resource

Receiving Data from DDx Exchange

  1. Provide full access permissions to DDx as a user.
  2. Set up and provide the AWS S3 Bucket name being used to receive the data, the Access Key ID, and the Secret Access Key.

View the examples from the DDx API Console below to make sure you have all the required information to submit!


  1. Send your file storage credentials to the DDx API team

    1. Once you have a file storage service in place, provide your information and credentials through the DDx API Console at https://app.movementinfrastructure.org/ as follows:

      Create a Console account at app.movementinfrastructure.org

      1. Existing Exchange clients with Personal Workspaces
        1. Request an Organizational Workspace by reaching out to [email protected] or directly to the Client Success Team
        2. Existing Exchange clients with Organizational Workspaces
          1. Confirm your Organizational Workspace name matches your Exchange client slug by reaching out to [email protected].
          2. Proceed to Step 2!
        3. New Exchange Clients
          1. Create the Console account and request an Organizational Workspace by submitting a request to [email protected]

Once you are in your account dashboard, select ‘Set Up Transfer’ under the ‘Receive files from DDx’ tile.

Select your file storage service from the drop down menu and whether you would like to receive data. The Console submission will allow you to fill out the required information fields based on the selected file storage service.

Once that is complete, click 'Submit Connection Details' to submit your data delivery information to DDx.

Updated 3 days ago

What’s Next