Skip to main content

Data formats

JSON​

  • Property names are camelCase (agentCode, effectiveFrom).
  • Null properties are omitted from responses. A missing property means "no value", so don't treat it as an error.
  • Ignore unknown properties when you deserialize. New properties may be added to responses at any time without a version change. See Versioning.
  • Enumerations are sent as strings, such as "status": "Active". More values may be added, so handle unknown ones gracefully.

Dates and times​

KindFormatExample
Date (no time)YYYY-MM-DD2026-03-15
Date and timeISO 8601 in UTC2026-03-15T14:30:00Z
  • Date-only fields hold calendar dates with no time zone, such as birth dates and certification effective dates. Don't turn them into timestamps. Doing so can shift the date by a day.
  • Timestamps such as lastModified and createdAt are UTC.
  • Effective date ranges are inclusive. A period with effectiveFrom: 2026-01-01 and effectiveThrough: 2026-12-31 covers both of those days. A missing effectiveThrough means open-ended (in effect indefinitely).

Jurisdictions​

States, provinces and territories are sent as ISO 3166-2 style codes: a country code, a hyphen and a subdivision code.

ExampleMeaning
US-TXTexas, United States
US-CACalifornia, United States
CA-ONOntario, Canada

Agency Management's GET /jurisdictions operation returns the supported values. See Reference data.

Phone numbers​

Phone numbers are structured objects, not free text:

{ "countryCode": "1", "areaCode": "512", "phoneNumber": "5550123" }

countryCode defaults to 1 (North America) where it's optional.

Addresses​

Address shapes differ slightly between APIs. Agency Management uses line1, line2, city, jurisdiction, postalCode and country, while Agent Onboarding uses address1, address2, city, jurisdiction and postalCode. Check the API Portal for the exact schema.

Sensitive data​

Some fields hold personally identifiable or financial information, such as government identifiers (SSN/SIN), taxpayer identifiers, birth dates and bank details. Protect them in transit and at rest, and store them only if you have to.