POST /v1/:facility_id/tenants/:tenant_id/sign_up
Sign up for a tenant portal account

Params

Param name Description
tenant
optional

Validations:

  • Must be a Hash
tenant[first_name]
optional

Validations:

  • Must be a String
tenant[account_number]
optional

Validations:

  • Must be a String
tenant[middle_initial]
optional

Validations:

  • Must be a String
tenant[last_name]
optional

Validations:

  • Must be a String
tenant[drivers_license_number]
optional

Validations:

  • Must be a String
tenant[drivers_license_state]
optional

Validations:

  • Must be a String
tenant[vehicle_license_plate_number]
optional

Validations:

  • Must be a String
tenant[vehicle_license_state]
optional

Validations:

  • Must be a String
tenant[vehicle_description]
optional

Validations:

  • Must be a String
tenant[email]
optional

Validations:

  • Must be a String
tenant[username]
optional

Validations:

  • Must be a String
tenant[password]
optional

Validations:

  • Must be a String
tenant[tax_exempt]
optional

Is the tenant tax exempt?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[is_military]
optional

Is the tenant military?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[is_business]
optional

Is the tenant a business?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[business_name]
optional

Validations:

  • Must be a String
tenant[title]
optional

Validations:

  • Must be a String
tenant[decline_alternate_contact]
optional

Whether or not the tenant declined to provide alternate contact information

Validations:

  • Must be one of: true, false, 1, 0.
tenant[military_information]
optional

A collection of military information (if is_military is true).

Validations:

  • Must be a Hash
tenant[military_information][retired_military]
optional

Is the tenant retired military?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[military_information][no_agent_given]
optional

Is agent information provided?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[military_information][date_entered_service]
optional

Date entered service, Format: YYYY-MM-DD

Validations:

  • Must be a Date
tenant[military_information][military_id]
optional

Validations:

  • Must be a String
tenant[military_information][end_of_active_service_date]
optional

End date of active service, Format: YYYY-MM-DD

Validations:

  • Must be a Date
tenant[military_information][place_of_birth]
optional

Validations:

  • Must be a String
tenant[military_information][last_4_of_ssn]
optional

Must be a 4 digit number

Validations:

  • Must be a String
tenant[military_information][military_email_address]
optional

Must be a valid email address

Validations:

  • Must be a String
tenant[military_information][military_rank]
optional

Validations:

  • Must be a String
tenant[military_information][current_duty_location]
optional

Validations:

  • Must be a String
tenant[military_information][branch_of_service]
optional

Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other

Validations:

  • Must be a String
tenant[military_information][military_unit]
optional

Validations:

  • Must be a String
tenant[military_information][squadron]
optional

Validations:

  • Must be a String
tenant[military_information][division]
optional

Validations:

  • Must be a String
tenant[military_information][type_of_service]
optional

Must be Active Component, Reserve Component, or National Guard

Validations:

  • Must be a String
tenant[military_information][agent_first_name]
optional

Validations:

  • Must be a String
tenant[military_information][agent_last_name]
optional

Validations:

  • Must be a String
tenant[military_information][agent_email_address]
optional

Must be a valid email address

Validations:

  • Must be a String
tenant[military_information][agent_phone_number]
optional

Must be a valid phone number

Validations:

  • Must be a String
tenant[military_information][agent_address]
optional

Validations:

  • Must be a String
tenant[military_information][agent_city]
optional

Validations:

  • Must be a String
tenant[military_information][agent_state]
optional

Must be a valid state abbreviation

Validations:

  • Must be a String
tenant[military_information][agent_postal_code]
optional

Must be a valid US postal code

Validations:

  • Must be a String
tenant[military_information][officer_first_name]
optional

Validations:

  • Must be a String
tenant[military_information][officer_last_name]
optional

Validations:

  • Must be a String
tenant[military_information][officer_phone_number]
optional

Must be a valid phone number

Validations:

  • Must be a String
tenant[password_recovery_questions_attributes]
optional

Password recovery questions

Validations:

  • Must be an Array of nested elements
tenant[password_recovery_questions_attributes][question]
required

Validations:

  • Must be a String
tenant[password_recovery_questions_attributes][answer]
required

Validations:

  • Must be a String
tenant[phone_numbers_attributes]
required

A collection of phone numbers.

Validations:

  • Must be an Array of nested elements
tenant[phone_numbers_attributes][number]
optional

Phone number

Validations:

  • Must be a String
tenant[phone_numbers_attributes][extension]
required

Phone number extension

Validations:

  • Must be a String
tenant[phone_numbers_attributes][label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.

Validations:

  • Must be a String
tenant[phone_numbers_attributes][primary]
optional

Flag that indicates if this is the primary phone number of the tenant

Validations:

  • Must be a String
tenant[phone_numbers_attributes][sms_opt_in]
optional

Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly.

Validations:

  • Must be one of: true, false, 1, 0.
tenant[mailing_address_attributes]
required

A collection of addresses.

Validations:

  • Must be a Hash
tenant[mailing_address_attributes][address1]
required

Validations:

  • Must be a String
tenant[mailing_address_attributes][address2]
optional

Validations:

  • Must be a String
tenant[mailing_address_attributes][city]
required

Validations:

  • Must be a String
tenant[mailing_address_attributes][state]
required

Validations:

  • Must be a String
tenant[mailing_address_attributes][postal]
required

Validations:

  • Must be a String
tenant[contacts_attributes]
optional

A collection of contacts.

Validations:

  • Must be an Array of nested elements
tenant[contacts_attributes][id]
optional

Contact id required to update a contact.

Validations:

  • Must be a String
tenant[contacts_attributes][first_name]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][middle_initial]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][last_name]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][email]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][description]
required

Contact description

Validations:

  • Must be a String
tenant[contacts_attributes][primary]
optional

Flag that indicates if this is the primary contact of the tenant

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes]
optional

A collection of phone numbers.

Validations:

  • Must be an Array of nested elements
tenant[contacts_attributes][phone_numbers_attributes][number]
optional

Phone number

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes][extension]
optional

Phone number extension

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes][label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes][primary]
optional

Flag that specifies if this is the primary phone number of the contact

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes]
optional

A collection of addresses.

Validations:

  • Must be a Hash
tenant[contacts_attributes][address_attributes][address1]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][address2]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][city]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][state]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][postal]
optional

Validations:

  • Must be a String
id
required

Validations:

  • Must be a String

Examples

POST /v1/f70970d2-541c-4f2e-891a-3fe58f23e682/tenants/40d80a3c-e03a-46bb-aed7-d56ccf1b8529/sign_up
{
  "tenant": {
    "username": "awesome_o_5000",
    "password": "supersecretpassword"
  }
}
200
{
  "tenant": {
    "id": "40d80a3c-e03a-46bb-aed7-d56ccf1b8529",
    "account_number": 1000002,
    "first_name": "Hana65",
    "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": null,
    "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": "awesome_o_5000",
    "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:30.604-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": "8391fed7-a96a-4b6a-a55e-ff1c10e3e82d",
      "address1": "494446 Glenda Plains",
      "address2": null,
      "city": "North Cruzfurt",
      "state": "DE",
      "postal": "89980",
      "country": "US",
      "full_address": "494446 Glenda Plains, 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": "8391fed7-a96a-4b6a-a55e-ff1c10e3e82d",
        "address1": "494446 Glenda Plains",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "494446 Glenda Plains, 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": "f70970d2-541c-4f2e-891a-3fe58f23e682",
    "previous_ledger_ids": [],
    "lead_ids": [],
    "closed_lead_ids": [],
    "contact_ids": [],
    "support_case_ids": [],
    "event_ids": [],
    "password_recovery_question_ids": [
      "fdb6df51-40b3-4a0f-9bcf-7117243246a8",
      "26e6cd26-795a-4aff-baad-5c63e7347338"
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "tenant": {
        "username": "awesome_o_5000",
        "password": "[FILTERED]"
      },
      "facility_id": "f70970d2-541c-4f2e-891a-3fe58f23e682",
      "tenant_id": "40d80a3c-e03a-46bb-aed7-d56ccf1b8529"
    }
  }
}