/v1/tenants/{tenant_id}/addressAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request POST \
--url 'https://api.staging.facily.ai/v1/tenants/<TENANT_ID>/address' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"city": "string",
"state": "st",
"street": "string",
"zip": "string",
"country": "US",
"street_2": "string"
}'Parameters
tenant_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
citystringrequiredMin length: 1 · Max length: 100
countrystringISO 3166-1 alpha-2 code.
Default: "US" · Min length: 2 · Max length: 2
statestringrequiredTwo-letter state or region code.
Min length: 2 · Max length: 2
streetstringrequiredMin length: 1 · Max length: 255
street_2string | nullMax length: 255
Show street_2 schema
string | nullVariant 1: string
stringVariant 2: null
nullzipstringrequiredMin length: 1 · Max length: 10
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"address_type": "string",
"city": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_primary": false,
"state": "string",
"street": "string",
"zip": "string",
"country": "US",
"latitude": "<VALUE_MATCHING_PATTERN>",
"longitude": "<VALUE_MATCHING_PATTERN>",
"street_2": "string",
"verification_status": "string"
},
"meta": {
"request_id": "string"
}
}application/json
dataAddressResponserequiredShow data schema
address_typestringrequiredWhat the address is used for, for example physical, billing, or mailing.
citystringrequiredCity or town.
countrystringISO 3166-1 alpha-2 country code.
Default: "US"
idstringrequiredUnique identifier for this address.
Format: uuid
is_primarybooleanrequiredTrue for the address used by default when only one is needed.
latitudestring | nullLatitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show latitude schema
string | nullLatitude in decimal degrees, where the address has been geocoded.
Variant 1: string
stringVariant 2: null
nulllongitudestring | nullLongitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show longitude schema
string | nullLongitude in decimal degrees, where the address has been geocoded.
Variant 1: string
stringVariant 2: null
nullstatestringrequiredState, province, or region.
streetstringrequiredFirst line of the street address.
street_2string | nullSecond line, for a unit, suite, or apartment number.
Show street_2 schema
string | nullSecond line, for a unit, suite, or apartment number.
Variant 1: string
stringVariant 2: null
nullverification_statusstring | nullOutcome of address validation, for example verified, unverified, or corrected.
Show verification_status schema
string | nullOutcome of address validation, for example verified, unverified, or corrected.
Variant 1: string
stringVariant 2: null
nullverified_atstring | nullWhen the address was last validated against a postal database.
Format: date-time
Show verified_at schema
string | nullWhen the address was last validated against a postal database.
Variant 1: string
stringVariant 2: null
nullzipstringrequiredPostal or ZIP code.
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired