Developer centerv1.0.0
Documentation menu
Data models

AddressRecord

Fields, types and constraints for the AddressRecord public API model.

Address associated with an entity by an official source.

Fields

FieldTypeConstraintExampleVisibility
entityId

Stable normalized entity id across source records.

string"example"Public contract
address

Free-text address reported by the source.

stringnullable"example"Personal context
city

Address city.

stringnullable"example"Public contract
region

Address region or administrative area.

stringnullable"example"Public contract
country

Entity, identifier or address country.

stringnullable"example"Personal context
postalCode

Address postal code.

stringnullable"example"Public contract

Machine-readable schema

The model is published under the same name in the JSON Schema bundle.

JSON Schema

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.