Owner Claim
Owner-claim flow: public token-based claim view, claim confirmation, and the authenticated start of an owner claim.
View owner claim details
Returns a minimal public summary of an owner claim so the recipient can confirm they are looking at the right request before logging in.
Authentication
This endpoint is public (the user is not yet authenticated when they click the email link). The only credential is the claim token in the URL path.
Privacy
Anti-leak by design: the initiator email is masked
(jo***@example.com), the owner email is never returned, and no internal
IDs are exposed. Unknown / consumed tokens return a generic 404
(anti-oracle); responses are padded to a constant minimum latency.
Example
Code
Response:
Code
path Parameters
tokenOwner claim token (clear value from the email link).
View owner claim details › Responses
Owner claim details retrieved.
initiator_email_partialMasked initiator email (first chars + domain), e.g. jo***@example.com.
owner_display_nameOwner display name (last name, plus first name for individuals).
expires_atExpiration date of the claim session.
Confirm an owner claim
Finalizes an owner claim: links owner.auth_user_id to the currently
authenticated account and marks the claim session as consumed.
Authentication
Unlike the GET above, this endpoint requires authentication
(Bearer JWT, PropertiesRead permission). The user must be logged in;
the confirmation matches the authenticated account against the claim
initiator. The token is still read from the URL path.
Body
The request body may be empty — the confirmation is derived from the JWT and the path token.
Example
Code
Response:
Code
path Parameters
tokenOwner claim token (clear value from the email link).
Confirm an owner claim › Request Body optional
Confirm an owner claim › Responses
Claim confirmed and linked to the authenticated account.
owner_idIdentifier of the owner that is now linked to the authenticated account.
claimed_atTimestamp at which the claim was confirmed.
Start an owner claim
Starts an owner-claim workflow for the given owner_id. The backend
generates a token, persists the claim session, and the targeted owner
receives an email containing the confirmation link.
Authentication
This endpoint requires authentication (Bearer JWT, PropertiesWrite
permission) — it modifies the account ↔ owner association. The initiator
identity (auth user id + email) and tenant are taken from the JWT.
The claim TTL defaults to 7 days (168 hours).
Example
Code
Response (201 Created):
Code
path Parameters
owner_idIdentifier of the owner to start a claim for.
Start an owner claim › Responses
Claim started; the link has been issued for the owner.
frontend_urlFrontend URL (containing the claim token) sent to the owner by email.
owner_emailEmail address of the owner the claim was started for.