HBX-mobile-app-APIs

Specifications and resources for mobile apps needed by the HBX mobile app

The MVP uses existing IAM & EnrollApp security systems, and not require any changes to HBX's security systems.

APIs in enroll-mobile-api

Broker APIs

Broker

Entry point:

• [hostname]/api/v1/mobile/broker
  • example response

via HATEOAS:

Employer Details for Broker

• [hostname]/api/v1/mobile/employer/<id>
  • example response

Employee Roster for Broker

• [hostname]/api/v1/mobile/employer/<id>/employees
  • example response

Employer APIs

Entry points:

Employer

• [hostname]/api/v1/mobile/employer/
  • example response

Employee Roster for Employer

• [hostname]/api/v1/mobile/employer/employees
  • example response

Individual & Employee APIs

Entry points:

Insured

• [hostname]/api/v1/mobile/insured
  • example response

Plans

• [hostname]/api/v1/mobile/plans
  • Parameters:
    • coverage_kind - health or dental
    • active_year - YYYY; if not given, upcoming year
    • csr_kind - value for whether to restrict search by CSR eligibility
    • ages - array of ages of family members, for premium calculation
    • elected_aptc_amount - for premium calculation
    • effective_on - date to investigate plans for
  • example response

via HATEOAS:

Services & Rates

• [hostname]/api/v1/mobile/services_rates
  • Parameters:
    • coverage_kind - health or dental
    • active_year - YYYY, year of plan
    • hios_id - id of insurance plan
  • example response

APIs in hbx-mobile-integration

Entry points:

Sign Up

• [hostname]/sign-up (POST)
  • example of request payload
  • Elements found in post payload:
    • username - User Name
    • password - Password
    • token - encrypted token returned by the call to the Enroll RIDP endpoint
    • ssn - Social Security Number
    • first_name - First Name
    • last_name - Last Name
    • date_of_birth - Date of Birth (MM/DD/YYYY)
  • example error response

APIs in hbx-mobile-auth-server

Entry points:

Login

• [hostname]/login (POST)
  • Parameters (POST):
    • userid - User Name (in either IAM or the integration server)
    • pass - Password (in either IAM or the integration server)
    • device_id - this is the device ID that can be used to send push notifications to the device via Apple or Google
  • ("local"/integration server login response)[https://github.com/dchealthlink/HBX-mobile-app-APIs/blob/master/static/login/local_login_response.json]