Set or clear a tenant residency pin (superadmin, AAL3 step-up)
PUT
/v1/system/orgs/{tenant_id}/region
const url = 'https://example.com/v1/system/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/region';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"data_region":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/v1/system/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/region \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "data_region": "example" }'Sets or clears the data residency pin of one tenant. The region is validated against the residency registry, and an empty region clears the pin.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” tenant_id
required
string format: uuid
Tenant identifier (UUIDv7).
Request Body required
Section titled “Request Body required ” Media type application/json
object
data_region
required
Residency region pin; empty clears the pin
string
Example generated
{ "data_region": "example"}Responses
Section titled “ Responses ”OK
Media type application/json
object
created_at
required
string format: date-time
data_region
string
id
required
string format: uuid
name
required
string
slug
required
string
status
required
string
tenant_id
required
string format: uuid
Example generated
{ "created_at": "2026-04-15T12:00:00Z", "data_region": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "slug": "example", "status": "example", "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Bad request
Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{ "error": { "code": "example", "message": "example" }}Unauthenticated
Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{ "error": { "code": "example", "message": "example" }}Forbidden
Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{ "error": { "code": "example", "message": "example" }}Not found
Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{ "error": { "code": "example", "message": "example" }}Conflict / setup required
Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{ "error": { "code": "example", "message": "example" }}Rate limited
Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{ "error": { "code": "example", "message": "example" }}