This section describes the formats and structure of the data we use across our APIs both for individual fields and whole responses. It covers the date and time, objects and enveloped responses typical formats.

Date and Time

Timestamps

Timestamps in WealthTech API platform follow the RFC 3339 format and are always interpreted as UTC time, unless otherwise noted in the resource's documentation. Timestamps may resolve with second, millisecond or microsecond precision. We don't store or provide nanoseconds level of granularity in timestamps.

For example, the created_at_utc field of the Source Positions API returns the following time:

2023-06-08T12:04:29.603041Z

Date Format

For fields that express solely a date, we use a simple YYYY-MM-DD format.

For example, the billing_date field of Retrieve a Billing Report API returns:

2018-09-30

Object Types

Every object returned by the API has an object field to advertise its type. These types are dotted values and correspond to the overall organization of the API.

For example, /reporting is a section of the API containing PDF reports and settings. Benchmarks are objects that are retrievable from this section and have the object type reporting.benchmarks, since the data is available at /reporting/benchmarks.

Throughout the API Reference documentation you'll find the value of the object key for each data type.

Enveloped Objects

WealthTech API returns data as a JSON. The data contains information about objects and, in the case of retrieving multiple objects, presents itself wrapped in an envelope.

When retrieving multiple objects via a GET request the top-level keys contain information about pagination and data type. In this case the data itself is available in a key named data.

{
    "object": "list",
    "has_next": true,
    "has_previous": false,
    "current_page": 1,
    "total_pages": 2,
    "data": [{
        "object": "cac.class_tag",
        ...
    }]
}

Single Objects

When retrieving an individual object - no envelope is used. In this case each object is given an object key to determine its type:

{
  "object": "cac.class_tag",
  ... // the object's fields
}