POST /v1/:facility_id/tenants/sign_in
Sign a tenant in

Params

Param name Description
tenant
optional

Validations:

  • Must be a Hash
tenant[login]
required

Can be either an email or username.

Validations:

  • Must be a String
tenant[password]
required

Validations:

  • Must be a String
tenant[facility_uuid]
optional

Validations:

  • Must be a String

Examples

POST /v1/022b1423-ffc9-47b2-99b7-1cb1a493595c/tenants/sign_in
{
  "tenant": {
    "login": "[email protected]",
    "password": "super_secret_password"
  }
}
200
{
  "tenant": {
    "id": "10bb10a1-5576-4490-83cf-fefbb7492e9a",
    "account_number": 1000002,
    "first_name": "Clarice68",
    "last_name": "Quigley",
    "middle_initial": null,
    "email": "[email protected]",
    "tax_exempt": false,
    "is_military": false,
    "is_business": false,
    "business_name": null,
    "last_sign_in_at": "2023-09-15T04:37:32.042-10:00",
    "title": null,
    "delinquent": false,
    "current_ledger_ids": [],
    "preferences": {
      "email_invoices": true,
      "print_invoices": false,
      "charge_invoice_fee": true,
      "receive_legal_notices_by_email": null,
      "delinquency_exempt": false,
      "delinquency_docs_by_email": false,
      "delinquency_docs_by_mail": false,
      "receive_sms_for_gate_activity": false,
      "opt_in_to_marketing_emails": false,
      "opt_in_to_marketing_sms": false,
      "opt_in_to_transactional_sms": false,
      "exclude_from_insurance_auto_enroll": false,
      "exclude_from_insurance_auto_enroll_reason": null,
      "exclude_from_insurance_auto_enroll_created_by": null,
      "exclude_from_insurance_auto_enroll_on": null
    },
    "military_information": null,
    "username": "[email protected]",
    "drivers_license_number": null,
    "drivers_license_state": null,
    "vehicle_license_plate_number": null,
    "vehicle_license_state": null,
    "vehicle_description": null,
    "has_tenant_portal_account": true,
    "created_at": "2023-09-15T04:37:31.972-10:00",
    "gate_24_hour_access": false,
    "active": false,
    "tenant_account_kind_name": "Standard",
    "blocked_payments": false,
    "date_of_birth": null,
    "phone_numbers": [],
    "mailing_address": {
      "id": "d4bc0555-bb2b-4669-a633-f624af26d7f5",
      "address1": "50489734 Nia Vista",
      "address2": null,
      "city": "North Cruzfurt",
      "state": "DE",
      "postal": "89980",
      "country": "US",
      "full_address": "50489734 Nia Vista, North Cruzfurt, DE 89980",
      "latitude": 39.114844,
      "longitude": -94.630169,
      "time_zone_id": "America/New_York",
      "time_zone_offset": "-04:00",
      "invalid_data": false,
      "label": "Home"
    },
    "addresses": [
      {
        "id": "d4bc0555-bb2b-4669-a633-f624af26d7f5",
        "address1": "50489734 Nia Vista",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "50489734 Nia Vista, North Cruzfurt, DE 89980",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/New_York",
        "time_zone_offset": "-04:00",
        "invalid_data": false,
        "label": "Home"
      }
    ],
    "facility_id": "022b1423-ffc9-47b2-99b7-1cb1a493595c",
    "previous_ledger_ids": [],
    "lead_ids": [],
    "closed_lead_ids": [],
    "contact_ids": [],
    "support_case_ids": [],
    "event_ids": [],
    "password_recovery_question_ids": [
      "bca87e9a-6ee0-41d2-bb44-6c21322a01aa",
      "31df665d-fc78-4153-8c51-ae439a028b71"
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "tenant": {
        "login": "[email protected]",
        "password": "[FILTERED]"
      },
      "facility_id": "022b1423-ffc9-47b2-99b7-1cb1a493595c"
    }
  }
}