Locations represent the physical address where you receive mail.

  id: string;
  address: {
    line1: string;
    line2: string;
    city: string;
    state: string;
    postalCode: string;
  type: 'cmra' | 'registeredAgent';
  onboarding: {
    status: 'authorize' | 'sign' | 'verify' | 'complete';
  metadata: object;


id string
Unique identifier for the object

address.line1 string
The first line of the address for this location.

address.line2 string
The second line of the address for this location.

address.city string
The city where this location resides.

address.state string
The state where this location resides.

postalCode string
The USPS 5-digit postal code associated with this location.

type: string

Whether the location is a cmra (commercial mail receiving agency) or a registeredAgent.

onboarding.status: string

The current state of onboarding for this location:

  • authorize
  • sign
  • verify
  • complete

metadata: nullable object

A customizable key-value object to associate with your metadata. The object can only be one level deep, where each key is a string and each value is either a number or string.