Noyo Member Transactions API

openapi: 3.0.1
info:
  description: APIs to manage and consume information about Carriers
  title: Noyo Carrier Carrier Mapped Field Member Transactions API
  version: 1.0.0
servers: []
tags:
- name: Member Transactions
paths:
  /api/v1/member_requests/{request_id}/member_transactions:
    x-summary: List Member Transactions By Member Request
    get:
      description: Returns a list of all member transactions for a given member request.
      operationId: getMemberTransactionsByMemberRequestList
      parameters:
      - description: The unique identifier of the member request for which you would like to view member transaction
        in: path
        name: request_id
        required: true
        schema:
          example: a6e30204-87b2-4802-95a4-a156bd0f7435
          format: uuid
          type: string
      - description: The max size of each page of results
        in: query
        name: page_size
        required: false
        schema:
          type: integer
      - description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
        in: query
        name: offset
        required: false
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              example:
                meta:
                  offset: 0
                  page_num: 1
                  page_size: 20
                  total_records: 1
                response:
                - body:
                    coverages:
                    - carrier_config:
                        bill_group: '1000001'
                        member_group: '99999'
                      carrier_id: d0003042-eaae-4491-b219-4825456a3d16
                      lines_of_coverage:
                        dental:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 2e6a04b6-21f3-40d7-a9e2-735196cc451b
                          waiving_members: []
                        medical:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 1873df52-c9e9-4e3a-995c-f47f32d0bd62
                          waiving_members: []
                        vision:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 9cb64800-022e-40af-ab80-8d945e430592
                          waiving_members: []
                  carrier_id: 478e066e-9696-490e-b60f-47f40c96dc7c
                  created: 1557512389
                  employee_id: 25434576-e85d-481b-a825-962fd575046f
                  id: a6e30204-87b2-4802-95a4-a156bd0f7435
                  lines_of_coverage:
                  - medical
                  - dental
                  - vision
                  member_request_id: bba6ea27-4004-4a52-a3d9-f986ace0d3da
                  modified: 1564440756
                  status: processing
              schema:
                $ref: '#/components/schemas/PaginatedMemberTransactionResult'
          description: Successful Response - Returns all matching Member Transactions
      summary: Get a list of all Member Transactions
      tags:
      - Member Transactions
  /api/v1/member_transactions:
    x-summary: List Member Transactions
    get:
      description: Returns a list of all member transactions
      operationId: getMemberTransactionsList
      parameters:
      - description: The max size of each page of results
        in: query
        name: page_size
        required: false
        schema:
          type: integer
      - description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Comma-separated member transaction IDs you would like to view
        in: query
        name: ids
        required: false
        schema:
          type: string
      - description: Comma-separated list of status details to be filtered on
        in: query
        name: status_details
        required: false
        schema:
          type: string
      - description: indicates whether the filter should operate on the current status detail or the entire history of status details
        in: query
        name: current_status_detail
        required: false
        schema:
          type: boolean
      - description: Comma-separated list of carrier IDs to be filtered on
        in: query
        name: carrier_ids
        required: false
        schema:
          type: string
      - description: Transaction type of the member transaction
        in: query
        name: transaction_type
        required: false
        schema:
          type: string
      - description: Earliest date that the transaction was created
        in: query
        name: transaction_min_date
        required: false
        schema:
          type: string
      - description: Latest date that the transaction was created
        in: query
        name: transaction_max_date
        required: false
        schema:
          type: string
      - description: Earliest date that the transaction entered the given status detail(s)
        in: query
        name: status_detail_min_date
        required: false
        schema:
          type: string
      - description: Latest date that the transaction entered the given status detail(s)
        in: query
        name: status_detail_max_date
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                meta:
                  offset: 0
                  page_num: 1
                  page_size: 20
                  total_records: 1
                response:
                - body:
                    coverages:
                    - carrier_config:
                        bill_group: '1000001'
                        member_group: '99999'
                      carrier_id: d0003042-eaae-4491-b219-4825456a3d16
                      lines_of_coverage:
                        dental:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 2e6a04b6-21f3-40d7-a9e2-735196cc451b
                          waiving_members: []
                        medical:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 1873df52-c9e9-4e3a-995c-f47f32d0bd62
                          waiving_members: []
                        vision:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 9cb64800-022e-40af-ab80-8d945e430592
                          waiving_members: []
                  carrier_id: 478e066e-9696-490e-b60f-47f40c96dc7c
                  created: 1557512389
                  employee_id: 25434576-e85d-481b-a825-962fd575046f
                  id: a6e30204-87b2-4802-95a4-a156bd0f7435
                  lines_of_coverage:
                  - medical
                  - dental
                  - vision
                  member_request_id: bba6ea27-4004-4a52-a3d9-f986ace0d3da
                  modified: 1564440756
                  status: processing
              schema:
                $ref: '#/components/schemas/PaginatedMemberTransactionResult'
          description: Successful Response - Returns all matching Member Transactions
      summary: Get a list of all Member Transactions
      tags:
      - Member Transactions
  /api/v1/member_transactions/{transaction_id}:
    x-summary: Get Single Member Transaction
    get:
      description: Returns the latest version of a single member transaction based on the ID provided.
      operationId: getMemberTransaction
      parameters:
      - description: The unique identifier of the member transaction you would like to view
        in: path
        name: transaction_id
        required: true
        schema:
          example: a6e30204-87b2-4802-95a4-a156bd0f7435
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                body:
                  coverages:
                  - carrier_config:
                      bill_group: '1000001'
                      member_group: '99999'
                    carrier_id: d0003042-eaae-4491-b219-4825456a3d16
                    lines_of_coverage:
                      dental:
                        enrolling_members:
                        - id: 25434576-e85d-481b-a825-962fd575046f
                          member_type: employee
                          plan_id: 2e6a04b6-21f3-40d7-a9e2-735196cc451b
                        waiving_members: []
                      medical:
                        enrolling_members:
                        - id: 25434576-e85d-481b-a825-962fd575046f
                          member_type: employee
                          plan_id: 1873df52-c9e9-4e3a-995c-f47f32d0bd62
                        waiving_members: []
                      vision:
                        enrolling_members:
                        - id: 25434576-e85d-481b-a825-962fd575046f
                          member_type: employee
                          plan_id: 9cb64800-022e-40af-ab80-8d945e430592
                        waiving_members: []
                carrier_id: 478e066e-9696-490e-b60f-47f40c96dc7c
                created: 1557512389
                employee_id: 25434576-e85d-481b-a825-962fd575046f
                id: a6e30204-87b2-4802-95a4-a156bd0f7435
                lines_of_coverage:
                - medical
                - dental
                - vision
                member_request_id: bba6ea27-4004-4a52-a3d9-f986ace0d3da
                modified: 1564440756
                status: processing
              schema:
                $ref: '#/components/schemas/MemberTransactionResult'
          description: Successful Response - Returns a single Member Transaction
      summary: Get a single Member Transaction
      tags:
      - Member Transactions
  /api/v1/member_transactions/{transaction_id}/case:
    x-summary: Get a public case for a single Member Transaction
    get:
      description: Returns a case if one exists for the member transaction based on the ID provided.
      operationId: getMemberTransactionCase
      parameters:
      - description: The unique identifier of the member transaction to get the case through.
        in: path
        name: transaction_id
        required: true
        schema:
          example: a6e30204-87b2-4802-95a4-a156bd0f7435
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                action_owner: noyo
                automated: false
                created: 1704153600
                id: 51881720-508f-4ddd-8485-0584179f4b7b
                modified: 1704153600
                resolved: null
                title: Public message for Case
                version: 160d4e95-7242-494d-a2aa-0d10042de94e
              schema:
                $ref: '#/components/schemas/CaseResultPublic'
          description: Successful Response - Returns a single Case associated with the Member Transaction
      summary: Get a Case for a Member Transaction
      tags:
      - Member Transactions
  /ui/v1/member_requests/{request_id}/member_transactions:
    x-summary: List Member Transactions By Member Request
    get:
      description: Returns a list of all member transactions for a given member request.
      operationId: uiGetMemberTransactionsByMemberRequestList
      parameters:
      - in: path
        name: request_id
        required: true
        schema:
          type: string
      - description: The max size of each page of results
        in: query
        name: page_size
        required: false
        schema:
          type: integer
      - description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Optionally include a restructured form of the body for UI display purposes
        in: query
        name: ui_body
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              example:
                meta:
                  offset: 0
                  page_num: 1
                  page_size: 20
                  total_records: 1
                response:
                - body:
                    coverages:
                    - carrier_config:
                        bill_group: '1000001'
                        member_group: '99999'
                      carrier_id: d0003042-eaae-4491-b219-4825456a3d16
                      lines_of_coverage:
                        dental:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 2e6a04b6-21f3-40d7-a9e2-735196cc451b
                          waiving_members: []
                        medical:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 1873df52-c9e9-4e3a-995c-f47f32d0bd62
                          waiving_members: []
                        vision:
                          enrolling_members:
                          - id: 25434576-e85d-481b-a825-962fd575046f
                            member_type: employee
                            plan_id: 9cb64800-022e-40af-ab80-8d945e430592
                          waiving_members: []
                  carrier_id: 478e066e-9696-490e-b60f-47f40c96dc7c
                  employee_id: 25434576-e85d-481b-a825-962fd575046f
                  id: a6e30204-87b2-4802-95a4-a156bd0f7435
                  lines_of_coverage:
                  - medical
                  - dental
                  - vision
                  member_request_id: bba6ea27-4004-4a52-a3d9-f986ace0d3da
                  status: processing
              schema:
                $ref: '#/components/schemas/PaginatedMemberTransactionResult'
          description: Successful Response - Returns all matching Member Transactions
      summary: Get a list of all Member Transactions by Member Request
      tags:
      - Member Transactions
  /ui/v1/member_snapshots/member_transaction/{transaction_id}:
    get:
      description: Gets member snapshot currently associated with a transaction
      operationId: getUIMemberSnapshotByMemberTransaction
      parameters:
      - description: The unique identifier of the member transaction we are using to get associated member snapshot
        in: path
        name: transaction_id
        required: true
        schema:
          example: 0059143c-e8df-4f2d-adfd-8013ee683030
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                created: 1656030390
                created_members:
                - custom_individual_id: bb6bfcd8-6657-4b77-8151-949ea8b5e44e
                  id: 6e7a80fc-473e-460a-8368-454e9e8dc9cb
                  type: employee
                - custom_individual_id: 3f093cc0-4fef-4d5d-9267-ba5cdfc09827
                  id: ab740704-7c37-4010-92b3-d22c6926be3e
                  type: dependent
                employee_id: 6e7a80fc-473e-460a-8368-454e9e8dc9cb
                fulfillment_summary:
                - carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
                  errors: []
                  status: processing
                id: 7bea80ac-499d-560b-5512-60be9e2349cb
                member_snapshot:
                  coverages:
                  - carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
                    enrolled_members:
                    - effective_end_date: '9999-12-31'
                      effective_start_date: '2022-01-01'
                      event_id: '1'
                      individual_id: 6e7a80fc-473e-460a-8368-454e9e8dc9cb
                      individual_type: employee
                    - effective_end_date: '9999-12-31'
                      effective_start_date: '2022-01-01'
                      event_id: '1'
                      individual_id: ab740704-7c37-4010-92b3-d22c6926be3e
                      individual_type: dependent
                    line_of_coverage: medical
                    plan_id: 4bf04f73-0aad-48ac-b28a-e5f4def7c5e9
                    signature_date: '2021-12-23'
                  dependents:
                  - custom_individual_id: 3f093cc0-4fef-4d5d-9267-ba5cdfc09827
                    event_id: '1'
                    id: ab740704-7c37-4010-92b3-d22c6926be3e
                    person:
                      date_of_birth: '1990-01-02'
                      first_name: Jamie
                      last_name: Johnson
                      sex: F
                    relationship: spouse
                  employee:
                    custom_individual_id: bb6bfcd8-6657-4b77-8151-949ea8b5e44e
                    event_id: '1'
                    group_id: d0ec3837-3499-4a2f-8c58-966ef7e46d95
                    id: 6e7a80fc-473e-460a-8368-454e9e8dc9cb
                    person:
                      contact:
                        email_address: david@testemail.com
                      date_of_birth: '1985-06-22'
                      first_name: David
                      home_address:
                        city: San Francisco
                        state: CA
                        street_one: 1234 Home Ave
                        zip_code: '94107'
                      last_name: Johnson
                      sex: M
                  events:
                  - date: '2022-01-01'
                    id: '1'
                    reason: open_enrollment
                    type: enrollment
                modified: 1656030390
                status: processing
                version: 271c60d6-f009-4b3d-8bba-aac49b2dd9a4
                warnings: []
              schema:
                $ref: '#/components/schemas/OutboundMemberSnapshot'
          description: Successful Response - Returns the Member Snapshot contents
        '404':
          content:
            application/json:
              example:
                message: MemberTransaction not found with UUID 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
                status: 404
          description: Failure Response - Not found error
      summary: Gets member snapshot currently associated with a transaction
      tags:
      - Member Transactions
  /ui/v1/member_transactions/public:
    x-summary: List Member Transactions
    get:
      description: Returns a list of all member transactions.
      operationId: uiGetMemberTransactionListPublic
      parameters:
      - description: The max size of each page of results
        in: query
        name: page_size
        required: false
        schema:
          type: integer
      - description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - in: query
        name: group_id
        required: false
        schema:
          format: uuid
          type: string
      - in: query
        name: case_id
        required: false
        schema:
          format: uuid
          type: string
      - in: query
        name: is_resolved
        required: false
        schema:
          type: boolean
      - in: query
        name: min_date
        required: false
        schema:
          format: uuid
          type: string
      - in: query
        name: max_date
        required: false
        schema:
          format: uuid
          type: string
      - in: query
        name: transaction_type
        required: false
        schema:
          type: string
      - in: query
        name: label_id
        required: false
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                meta:
                  offset: 0
                  page_num: 1
                  page_size: 20
                  total_records: 2
                response:
                - member_transaction:
                    body:
                      coverages:
                      - carrier_config:
                          bill_group: '1000001'
                          member_group: '99999'
                        carrier_id: d0003042-eaae-4491-b219-4825456a3d16
                        lines_of_coverage:
                          dental:
                            enrolling_members:
                            - id: 25434576-e85d-481b-a825-962fd575046f
                              member_type: employee
                              plan_id: 2e6a04b6-21f3-40d7-a9e2-735196cc451b
                            waiving_members: []
                          medical:
                            enrolling_members:
                            - id: 25434576-e85d-481b-a825-962fd575046f
                              member_type: employee
                              plan_id: 1873df52-c9e9-4e3a-995c-f47f32d0bd62
                            waiving_members: []
                          vision:
                            enrolling_members:
                            - id: 25434576-e85d-481b-a825-962fd575046f
                              member_type: employee
                              plan_id: 9cb64800-022e-40af-ab80-8d945e430592
                            waiving_members: []
                    carrier_id: 478e066e-9696-490e-b60f-47f40c96dc7c
                    employee_id: 25434576-e85d-481b-a825-962fd575046f
                    id: a6e30204-87b2-4802-95a4-a156bd0f7435
                    internal_status: created
                    lines_of_coverage:
                    - medical
                    - dental
                    - vision
                    member_request_id: bba6ea27-4004-4a52-a3d9-f986ace0d3da
                    status: processing
              schema:
                $ref: '#/components/schemas/PaginatedMemberTransactionUIResult'
          description: Successful Response - Returns all matching Member Transactions
      summary: Get a list of all Member Transactions
      tags:
      - Member Transactions
components:
  schemas:
    StatusDetailResult:
      properties:
        event_created:
          description: Timestamp indicating when the status detail was created
          example: '1673452723'
          type: integer
        status_detail:
          description: Type of Status detail
          enum:
          - noyo_accepted
          - carrier_accepted
          - carrier_processing
          - carrier_completed
          - noyo_verified
          example: carrier_accepted
          type: string
      required:
      - event_created
      - status_detail
      type: object
      x-field_order:
      - status_detail
      - event_created
    MemberSnapshotDB:
      properties:
        coverages:
          description: List of coverage and enrollment decisions for each member
          items:
            $ref: '#/components/schemas/InboundMemberSnapshotCoverage'
          type: array
        dependents:
          description: List of demographic information for each dependent
          items:
            $ref: '#/components/schemas/InboundMemberSnapshotDependent'
          type: array
        employee:
          allOf:
          - $ref: '#/components/schemas/InboundMemberSnapshotEmployee'
          description: Demographic information for the employee
        enable_member_auto_link:
          default: false
          description: Boolean flag for autolinking workflow
          type: boolean
        events:
          description: List of events associated with member and coverage updates
          items:
            $ref: '#/components/schemas/InboundMemberSnapshotEvent'
          type: array
        omitted_coverage_handling:
          allOf:
          - $ref: '#/components/schemas/InboundMemberSnapshotOmittedCoverage'
          description: Configuration for handling omitted coverages
        snapshot_mode:
          description: Mode describing how the contents of the snapshot will be processed
          enum:
          - current_open
          example: current_open
          type: string
      required:
      - employee
      - snapshot_mode
      type: object
    MemberTransactionResult:
      properties:
        body:
          description: Body of the member transaction
          type: object
        carrier_id:
          description: Unique identifier of the carrier in the Noyo system
          format: uuid
          type: string
        created:
          description: The date the record was created
          type: integer
        employee_id:
          description: Unique identifier of the associated employee in the Noyo system
          format: uuid
          type: string
        id:
          description: Unique identifier of the record in Noyo
          format: uuid
          type: string
        lines_of_coverage:
          description: List of lines of coverage for the member transaction
          items:
            description: Line of coverage for the member transaction
            enum:
            - medical
            - dental
            - vision
            - life
            - add
            - std
            - ltd
            - accident
            - critical_illness
            - cancer
            - health_fund
            - hospital_indemnity
            - pharmacy
            - wellness
            type: string
          type: array
        member_request_id:
          description: Unique identifier of the member request in the Noyo system
          format: uuid
          type: string
        modified:
          description: The date the record was last updated
          type: integer
        result:
          description: Result of the member transaction
          type: object
        status:
          description: Status of the member transaction
          enum:
          - processing
          - completed
          - failed
          - canceled
          type: string
        status_details:
          description: History of status details for the member transaction
          items:
            $ref: '#/components/schemas/StatusDetailResult'
          type: array
        transaction_type:
          description: Transaction type of the member transaction
          enum:
          - carrier_demographic
          - carrier_demographic_full
          - carrier_new_hire
          - carrier_termination
          - noyo_termination
          - carrier_open_enrollment_full
          - carrier_open_enrollment_adding
          - carrier_open_enrollment_modifying
          - carrier_open_enrollment_removing
          - carrier_qualifying_life_event_full
          - carrier_qualifying_life_event_adding
          - carrier_qualifying_life_event_modifying
          - carrier_qualifying_life_event_removing
          - carrier_enrollment_snapshot_new_hire
          - carrier_cobra_enrollment
          - carrier_cobra_termination
          - carrier_cobra_open_enrollment
          - carrier_cobra_qualifying_life_event
          type: string
        ui_body:
          description: A restructured form of the transaction's body data for UI display purposes
          type: string
        verified:
          description: The date the member transaction was verified
          type: integer
        version:
          description: Current version of the record
          format: uuid
          type: string
      required:
      - body
      - created
      - employee_id
      - id
      - lines_of_coverage
      - member_request_id
      - modified
      - result
      - status
      - transaction_type
      - version
      type: object
      x-field_order:
      - id
      - version
      - created
      - modified
      - member_request_id
      - employee_id
      - carrier_id
      - lines_of_coverage
      - transaction_type
      - status
      - verified
      - body
      - result
    InboundMemberSnapshotPersonContact:
      properties:
        email_address:
          description: Email address of the person
          example: catherine.briggs@example.com
          format: email
          nullable: true
          type: string
        email_address_type:
          description: Type of email address
          enum:
          - home
          - work
          example: home
          type: string
        home_phone:
          description: Home phone number in E.164 format
          example: '+15555551212'
          type: string
        preferred_language:
          description: Preferred written or spoken language of the person
          example: English
          type: string
        preferred_method:
          description: Preferred method of contact for the person
          enum:
          - mail
          - email
          - home-phone
          - work-phone
          - other
          example: email
          type: string
        speaks_english:
          description: True if the person can speak or communicate in English
          example: true
          type: boolean
        work_phone:
          description: Work phone number in E.164 format
          example: '+15555551212'
          type: string
      type: object
      x-field_order: []
    InboundMemberSnapshotEvent:
      properties:
        date:
          description: The date the event occurred
          format: date
          type: string
        id:
          description: Unique ID for the event, used internally in this payload
          minLength: 1
          type: string
        reason:
          description: The cause or real world scenario described in the event
          enum:
          - adoption
          - benefit_class_change
          - change_to_part_time
          - change_to_full_time
          - cobra_enrollment
          - cobra_termination
          - cobra_update_other
          - court_order
          - death
          - demographic_change
          - dependent_open_enrollment
          - disability_status_change
          - divorce
          - eligibility_change
          - foster_care
          - immigration_status_change
          - leave_status_change
          - legal_guardian
          - lost_coverage
          - marriage
          - medicare
          - moved
          - newborn
          - new_hire
          - offline_change
          - open_enrollment
          - rate_changed
          - rehire
          - reinstatement
          - retirement
          - termination
          type: string
        type:
          description: The type or category of member change made due to this event
          enum:
          - coverage
          - demographic
          type: string
      required:
      - date
      - id
      - reason
      - type
      type: object
      x-field_order: []
    InboundMemberSnapshotEmployment:
      properties:
        employment_dates:
          allOf:
          - $ref: '#/components/schemas/InboundMemberSnapshotEmploymentDates'
          description: Employee employment dates
        employment_status:
          description: Employee employment status
          enum:
          - full-time
          - part-time
          - contract
          - disabled
          - terminated
          - retired
          type: string
        hours_worked:
          description: An integer of hours worked per week by the employee
          example: 40
          format: int32
          type: integer
        occupation:
          description: Employee occupation or job title
          example: Engineer
          ty

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/noyo/refs/heads/main/openapi/noyo-member-transactions-api-openapi.yml