Owner Claim
Owners

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, properties:write 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

curl -X POST https://api.faireplace.com/api/owners/550e8400-e29b-41d4-a716-446655440000/claim/start \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (201 Created):

{
  "frontend_url": "https://app.faireplace.com/owner-claim/3f8b1c2d-...-9a0e",
  "owner_email": "owner@example.com"
}
post/owners/{owner_id}/claim/start

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/owners/{owner_id}/claim/start
  • Auth: HTTP bearer

Path parameters

owner_idstring uuid required

Identifier of the owner to start a claim for.

Response

Claim started; the link has been issued for the owner.

frontend_urlstring required

Frontend URL (containing the claim token) sent to the owner by email.

owner_emailstring email required

Email address of the owner the claim was started for.

Example response

{
  "frontend_url": "https://app.faireplace.com/owner-claim/3f8b1c2d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "owner_email": "owner@example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.