--- updatedAt: 2026-10-13T21:16:16.000Z agentTools: projectIndex: https://docs.usestable.com/llms.txt --- # Create a location Creates a single location. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Stable API", "version": "1" }, "paths": { "/v1/locations": { "post": { "summary": "Create a location", "description": "Creates a single location.", "tags": [ "Locations" ], "operationId": "createLocation.post.v1/locations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocationRequestBody" } } }, "description": "Body required in the request", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "security": [ { "x-api-key": [] } ] } } }, "servers": [ { "url": "https://api.usestable.com", "description": "Production" }, { "url": "https://api.dev.usestable.com", "description": "Development" } ], "components": { "securitySchemes": { "x-api-key": { "type": "apiKey", "name": "x-api-key", "in": "header" } }, "schemas": { "PlatformPrefillRecipients": { "properties": { "business": { "items": { "$ref": "#/components/schemas/PlatformPrefillBusinessRecipients" }, "title": "PlatformPrefillRecipients.business", "description": "Business recipients for the created location. If provided, the top level `business` field is also required.", "type": "array" }, "individual": { "items": { "$ref": "#/components/schemas/PlatformPrefillIndividualRecipients" }, "title": "PlatformPrefillRecipients.individual", "description": "Individual recipients for the created location. At least one individual recipient is required.", "type": "array" } }, "required": [ "individual" ], "additionalProperties": false, "title": "PlatformPrefillRecipients", "type": "object" }, "PlatformPrefillIndividualRecipients": { "properties": { "firstName": { "title": "PlatformPrefillIndividualRecipients.firstName", "description": "First name of the individual recipient", "type": "string", "example": "Ada" }, "lastName": { "title": "PlatformPrefillIndividualRecipients.lastName", "description": "Last name of the individual recipient", "type": "string", "example": "Lovelace" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "PlatformPrefillIndividualRecipients", "type": "object" }, "PlatformPrefillBusiness": { "properties": { "legalBusinessName": { "title": "PlatformPrefillBusiness.legalBusinessName", "description": "Legal name of the business", "type": "string", "example": "Ada's Apples" }, "placeOfRegistration": { "title": "PlatformPrefillBusiness.placeOfRegistration", "description": "If the business is in the United States, then \"county, state\" is required -- otherwise just \"country\".", "type": "string", "example": "Kent County, DE" }, "businessType": { "title": "PlatformPrefillBusiness.businessType", "description": "The NAICS definition of the business.\nLearn more: https://www.census.gov/naics/?58967?yearbck=2022", "type": "string", "example": "Agriculture" } }, "required": [ "legalBusinessName", "placeOfRegistration", "businessType" ], "additionalProperties": false, "title": "PlatformPrefillBusiness", "type": "object" }, "PlatformPrefillBusinessRecipients": { "properties": { "name": { "title": "PlatformPrefillBusinessRecipients.name", "description": "Name of the business recipient", "type": "string", "example": "Ada's Apples" } }, "required": [ "name" ], "additionalProperties": false, "title": "PlatformPrefillBusinessRecipients", "type": "object" }, "CreateLocationRequestBody": { "properties": { "locationCode": { "title": "CreateLocationRequestBody.locationCode", "description": "Identifies the location to create. Either:\n- A CMRA airport code (IATA-style, e.g. \"ATL3\") for a CMRA location, or\n- A 2-letter US state or territory abbreviation (e.g. \"WY\") for a registered\n agent (RA) location.", "allOf": [ { "$ref": "#/components/schemas/LocationCode" } ] }, "autoScan": { "title": "CreateLocationRequestBody.autoScan", "description": "Whether incoming mail should be auto-scanned. Defaults to `true`. For RA\nlocations, only `true` is permitted.", "type": "boolean" }, "metadata": { "title": "CreateLocationRequestBody.metadata", "description": "Arbitrary key/value pairs to attach to the location. Values must be strings or numbers.", "type": "object" }, "platformPrefill": { "title": "CreateLocationRequestBody.platformPrefill", "description": "Pre-fill data for the new location. Only allowed for CMRA locations;\nnot allowed for RA locations.", "allOf": [ { "$ref": "#/components/schemas/PlatformPrefill" } ] }, "companyId": { "title": "CreateLocationRequestBody.companyId", "description": "UUID of an existing company. Required for RA locations. Not allowed for CMRA locations.", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "additionalInformation": { "title": "CreateLocationRequestBody.additionalInformation", "description": "Additional information required for certain RA jurisdictions (e.g. Wyoming).\nOnly allowed for RA locations; not allowed for CMRA locations.", "allOf": [ { "$ref": "#/components/schemas/AdditionalRegisteredAgentInformation" } ] } }, "required": [ "locationCode" ], "additionalProperties": false, "title": "CreateLocationRequestBody", "type": "object" }, "LocationCode": { "enum": [ "ATL3", "AUS2", "BHM1", "BNA1", "BOS1", "BWI1", "CHS1", "CLT1", "CMH1", "CRW1", "CYS1", "DCA1", "DCA2", "DEN1", "DFW2", "DSM1", "DTW1", "EWR1", "FSD1", "HPN1", "IAH1", "ILG1", "ILG2", "IND1", "LAS1", "LAX1", "LGA1", "MCI1", "MDW1", "MHT1", "MIA1", "MSP1", "MSY1", "OMA1", "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" ], "title": "LocationCode", "type": "string" }, "PlatformPrefill": { "properties": { "business": { "title": "PlatformPrefill.business", "description": "Business information for the created location.", "allOf": [ { "$ref": "#/components/schemas/PlatformPrefillBusiness" } ] }, "recipients": { "title": "PlatformPrefill.recipients", "description": "Recipients for the created location.", "allOf": [ { "$ref": "#/components/schemas/PlatformPrefillRecipients" } ] } }, "required": [ "recipients" ], "additionalProperties": false, "title": "PlatformPrefill", "type": "object" }, "AdditionalRegisteredAgentInformation": { "properties": { "managementType": { "title": "AdditionalRegisteredAgentInformation.managementType", "description": "Management type for the entity (e.g. \"Member Managed\" or \"Manager Managed\")", "type": "string", "example": "Member Managed" }, "official": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.official.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.official.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.official", "type": "object" }, "officialDirector": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialDirector.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialDirector.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialDirector", "type": "object" }, "officialManager": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialManager.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialManager.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialManager", "type": "object" }, "officialMember": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialMember.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialMember.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialMember", "type": "object" }, "officialPartner": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialPartner.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialPartner.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialPartner", "type": "object" }, "officialPresident": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialPresident.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialPresident.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialPresident", "type": "object" }, "officialSecretary": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialSecretary.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialSecretary.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialSecretary", "type": "object" }, "officialTreasurer": { "properties": { "firstName": { "title": "AdditionalRegisteredAgentInformation.officialTreasurer.firstName", "description": "First name", "type": "string", "example": "John" }, "lastName": { "title": "AdditionalRegisteredAgentInformation.officialTreasurer.lastName", "description": "Last name", "type": "string", "example": "Doe" } }, "required": [ "firstName", "lastName" ], "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation.officialTreasurer", "type": "object" } }, "additionalProperties": false, "title": "AdditionalRegisteredAgentInformation", "type": "object" }, "BadRequestError": { "properties": { "message": { "title": "BadRequestError.message", "enum": [ "Bad Request" ], "type": "string" } }, "required": [ "message" ], "additionalProperties": false, "title": "BadRequestError", "type": "object" }, "NotFoundError": { "properties": { "message": { "title": "NotFoundError.message", "enum": [ "Not Found" ], "type": "string" } }, "required": [ "message" ], "additionalProperties": false, "title": "NotFoundError", "type": "object" }, "Forbidden": { "properties": { "message": { "title": "Forbidden.message", "enum": [ "Forbidden" ], "type": "string" } }, "required": [ "message" ], "additionalProperties": false, "title": "Forbidden", "type": "object" }, "InternalError": { "properties": { "message": { "title": "InternalError.message", "enum": [ "Internal Error" ], "type": "string" } }, "required": [ "message" ], "additionalProperties": false, "title": "InternalError", "type": "object" }, "Location": { "properties": { "id": { "title": "Location.id", "type": "string" }, "status": { "$ref": "#/components/schemas/LocationStatus" }, "address": { "properties": { "line1": { "title": "Location.address.line1", "type": "string" }, "line2": { "title": "Location.address.line2", "type": "string" }, "city": { "title": "Location.address.city", "type": "string" }, "state": { "title": "Location.address.state", "type": "string" }, "postalCode": { "title": "Location.address.postalCode", "type": "string" } }, "required": [ "line1", "line2", "city", "state", "postalCode" ], "additionalProperties": false, "title": "Location.address", "type": "object" }, "type": { "$ref": "#/components/schemas/LocationType" }, "onboarding": { "properties": { "status": { "$ref": "#/components/schemas/OnboardingStatus" } }, "required": [ "status" ], "additionalProperties": false, "title": "Location.onboarding", "type": "object" }, "metadata": { "title": "Location.metadata", "type": "object" } }, "required": [ "id", "status", "address", "type", "onboarding", "metadata" ], "additionalProperties": false, "title": "Location", "type": "object" }, "LocationStatus": { "enum": [ "active", "inactive" ], "title": "LocationStatus", "type": "string" }, "LocationType": { "enum": [ "cmra", "registeredAgent" ], "title": "LocationType", "type": "string" }, "OnboardingStatus": { "enum": [ "authorize", "sign", "verify", "complete" ], "title": "OnboardingStatus", "type": "string" } } } } ```