Datafiles API

Datafiles are JSON files with entity, instrument or event data ready for bulk upload through this endpoint.

The /datafiles endpoint can upload and check the status of a file.

Only one file at a time can be updated, with each file being up to 1GB. Please add a waiting time of 2 seconds between upload requests.

We support JSON only.

curl -X POST \
  'https://<API_ENDPOINT>/v1/datafiles/create' \
  -H 'Content-Type: multipart/form-data' \
  -H 'u21-key: <YOUR_API_KEY>' \
  --form '[email protected]' \
  --form 'run_rules=true'

Below is an example of a datafile with a single user entity:

[
  {
    "general_data": {
      "entity_id": "Datafile-User1",
      "entity_type": "user",
      "entity_subtype": "payments",
      "status": "active"
    },
    "user_data": {
      "first_name": "Matthew",
      "middle_name": "Joseph",
      "last_name": "Baker",
      "day_of_birth": 14,
      "month_of_birth": 1,
      "year_of_birth": 1983,
      "gender": "male",
      "ssn": "733-99-5921"
    },
    "communication_data": {
      "email_addresses": [
        "[email protected]"
      ],
      "phone_numbers": [
        "+14159627132"
      ]
    },
    "custom_data": {
      "uploaded": "Via Datafile"
    }
  },
  {
    "general_data": {
      "entity_id": "Datafile-User2",
      "entity_type": "user",
      "entity_subtype": "payments",
      "status": "active"
    },
    "user_data": {
      "first_name": "Matt",
      "middle_name": "Joe",
      "last_name": "Baker",
      "day_of_birth": 14,
      "month_of_birth": 1,
      "year_of_birth": 1983,
      "gender": "male",
      "ssn": "733-99-5921"
    },
    "communication_data": {
      "email_addresses": [
        "[email protected]"
      ],
      "phone_numbers": [
        "+14159627132"
      ]
    },
    "custom_data": {
      "uploaded": "Via Datafile"
    }
  }
]