POST
Create tenant renter claim

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

JSON request payload for tenant_create_claim.

Request payload for tenant claim.

full_name
string
required

Full legal or display name for the person.

Required string length: 1 - 160
organization_id
string<uuid> | null

UUID identifier for organization.

phone
string | null

Phone number associated with the renter or user.

Maximum string length: 40
email
string<email> | null

Email address associated with the user or renter.

identity_number
string | null

Government or landlord-recorded identity number for the renter.

Maximum string length: 80
proof
any

proof value for tenant claim request.

Response

Tenant API operation succeeded

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.