Skip to main content
POST
Create Tenant

Authorizations

Authorization
string
header
required

HTTP Bearer Authentication. Generate a shared token via /authenticate/token, then pass it as Authorization: Bearer <token>.

Body

application/json
email
string<email>
required
fname
string
required
lname
string
required
post_code
string
required

Postal code (numbers only)

Required string length: 5
dob
string<date>
required

Date of birth format (YYYY-MM-DD)

employment_status
enum<string>
required
Available options:
employed,
self_employed,
student,
unemployed,
retired,
public_servant
current_annual_income
number
required
Required range: x >= 0
currency
string
required
Required string length: 3
phone_number
string
required

Phone number (numbers only)

Required string length: 6 - 15
dni_nie
string

Either dni_nie or passport_id is required. At least one of these identification fields must be provided.

passport_id
string

Either dni_nie or passport_id is required. At least one of these identification fields must be provided.

employment_category
enum<string>
Available options:
public_servant,
military,
permanent,
temporary,
permanent_seasonal_worker,
paternity_or_maternity_leave,
medical_leave,
ownACompany,
freelancer
protected_housing_docs
string[]
about_me
string

Response

Successful response

status
enum<string>
Available options:
success
message
string
data
object