- Permission:
ADDRESS_MANAGEMENT - Roles:
extended_user,flex_management
Registers a new address during customer onboarding. The address is filed under the calling account’s own realm — this is not something the request can name, and it cannot be changed afterwards. Appliances default to all-false and terms to not-accepted when omitted — acceptance is a legal record and is never inferred.
Retrying is not safe. The UUID is generated by this service, so a request that fails after the write reached the address service has still created an address. Every error body carries that UUID as details.addressUuid: read it and GET the address to find out whether the write landed. Sending the request again instead creates a second address, and there is no endpoint that can find the first one by its details.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
400Invalid address details
403The account has no realm assigned, or spans every realm and so has none to file the address under
502The address service is unavailable or timed out. error is SERVICE_UNAVAILABLE, and details.addressUuid is the UUID of the address that may or may not have been created — see the note above.