HomeGuidesAPI Reference
Log In
API Reference

Data Types

Country Code (ISO 3166-1 alpha-2)

The country data type represents a country using its standardized two-letter code, as defined by ISO 3166-1 alpha-2. This international standard ensures a consistent and unambiguous representation of countries for various applications, including financial transactions, geographical data, and international communication. For example, "US" denotes the United States, "GB" represents the United Kingdom, and "FR" signifies France.

Country List (Array of ISO Codes)

The country list data type is structured as an array of strings, where each string is a two-letter ISO 3166-1 alpha-2 country code. This array allows for the specification of multiple countries in a single field, providing flexibility when operations or filters need to apply to a collection of nations. For instance, ["US", "CA", "MX"] would represent a list including the United States, Canada, and Mexico. This format is ideal for scenarios requiring multi-country selection.

Date and Time (ISO 8601 + Unix Timestamp)

The date data type handles date and time information, accepting values in one of two widely recognized formats: ISO 8601 or Unix timestamp. You can provide a date and time as a string adhering to the ISO 8601 standard, which offers a globally recognized and unambiguous way to represent dates and times (e.g., "2025-06-24T12:30:00Z"). Alternatively, for convenience and computational efficiency, the field also supports providing the corresponding Unix timestamp (the number of seconds that have elapsed since January 1, 1970, at UTC).