Sign in

v1

latestOpenAPI 3.0.02026-07-24276673.3 KB
Locations

Create a location

Creates a single location.

post/v1/locations

Headers

x-api-keystring required

Request body

locationCode'ATL3' | 'BHM1' | 'BNA1' | 'BOS1' | 'BWI1' | 'CLT1' | 'CMH1' | 'CYS1' | 'DCA1' | 'DCA2' | 'DEN1' | 'DFW2' | 'DTW1' | 'EWR1' | 'IAH1' | 'ILG1' | 'ILG2' | 'IND1' | 'LAS1' | 'LAX1' | 'LGA1' | 'MCI1' | 'MDW1' | 'MIA1' | 'MSP1' | 'MSY1' | 'PHL1' | 'PHX1' | 'SDF1' | 'SEA1' | 'SFO1' | 'SLC1' | 'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY' required
autoScanboolean

Whether incoming mail should be auto-scanned. Defaults to true. For RA locations, only true is permitted.

metadataobject

Arbitrary key/value pairs to attach to the location. Values must be strings or numbers.

companyIdstring

UUID of an existing company. Required for RA locations. Not allowed for CMRA locations.

Example request

{
  "platformPrefill": {
    "business": {
      "legalBusinessName": "Ada's Apples",
      "placeOfRegistration": "Kent County, DE",
      "businessType": "Agriculture"
    },
    "recipients": {
      "business": [
        {
          "name": "Ada's Apples"
        }
      ],
      "individual": [
        {
          "firstName": "Ada",
          "lastName": "Lovelace"
        }
      ]
    }
  },
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "additionalInformation": {
    "managementType": "Member Managed",
    "official": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialDirector": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialManager": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialMember": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialPartner": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialPresident": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialSecretary": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "officialTreasurer": {
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

Response

Success

idstring required
status'active' | 'inactive' required
type'cmra' | 'registeredAgent' required
metadataobject required