POST
Create renter

Authorizations

Authorization
string
header
required

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

Body

application/json

JSON payload used to create renter.

Request payload for create renter.

full_name
string
required

Full legal or display name for the person.

Required string length: 1 - 160
phone
string
required

Required Vietnam mobile number for renter creation, accepted as 0912345678 or +84912345678.

Required string length: 1 - 40
Pattern: ^(0[35789][0-9]{8}|\+84[35789][0-9]{8})$
Example:

"0912345678"

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
note
string | null

Optional note captured by the operator.

Maximum string length: 1000

Response

Created renter

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.