openapi: 3.2.0
info:
  title: RELATED PERSON Relatedpersons API
  description: These API's are used to manage related persons information.
  termsOfService: http://lynx-fh.com
  license:
    name: LynxFH
    url: http://lynx-fh.com
  version: '1.0'
servers:
- url: https://sandbox.lynx-fh.co
security:
- bearerAuth: []
tags:
- name: Relatedpersons
paths:
  /relatedpersons:
    post:
      tags:
      - Relatedpersons
      summary: Add Related Person
      description: The Add Related Person API is used to add a related person to an existing member.
      operationId: addNewRelatedPerson
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelatedPersonRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: 'Bad request.

            - GBL-174: Member is in Inactive state

            - GBL-198: Allocation percentage is not 100%

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    delete:
      tags:
      - Relatedpersons
      summary: Delete Related Person
      description: This API will allow you to delete a related person from a member.
      operationId: deleteRelatedPerson
      parameters:
      - name: clientMemberId
        in: query
        description: Unique client-side identifier for the member
        required: true
        schema:
          type: string
        example: 3f50436491
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: relatedPersonId
        in: query
        description: The related person which will be associated to the member
        required: true
        schema:
          type: string
          format: uuid
        example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRelatedPersonResponseDoc'
        '400':
          description: 'Bad request.

            - GBL-174: Member is in Inactive state

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /relatedpersons/addresses:
    put:
      tags:
      - Relatedpersons
      summary: Update Related Person Addresses
      description: Updates the addresses for a related person (identified by clientMemberId and client org).
      operationId: updateRelatedPersonAddresses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRelatedPersonAddressesRequestDoc'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    delete:
      tags:
      - Relatedpersons
      summary: Delete Related Person Address
      description: This API will allow you to delete a related person address.
      operationId: deleteRelatedPersonAddress
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: relatedPersonId
        in: query
        description: Unique identifier for the related person
        required: true
        schema:
          type: string
          format: uuid
        example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
      - name: clientMemberId
        in: query
        description: Unique client-side identifier for the member
        required: true
        schema:
          type: string
        example: 3f50436491
      - name: addressId
        in: query
        description: Auto-generated type for the address
        required: true
        schema:
          type: string
        example: Address1
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /relatedpersons/allocation-percentage:
    patch:
      tags:
      - Relatedpersons
      summary: Update Beneficiaries Allocation Percentage
      description: This API will allow you to update the allocation percentage of a member's beneficiaries.
      operationId: updateAllocationPercentage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBeneficiariesAllocationPercentageRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchBeneficiariesAllocationPercentageResponseDoc'
        '400':
          description: 'Bad request.

            - GBL-174: Member is in Inactive state

            - GBL-187: Incorrect number of beneficiary-related persons for the beneficiary type

            - GBL-198: Allocation percentage is not 100%

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /relatedpersons/details:
    get:
      tags:
      - Relatedpersons
      summary: Get Related Person Details
      description: Retrieves detailed information for the related person identified by the incoming clientMemberId, clientOrgName and relatedPersonId.
      operationId: getRelatedPersonDetails
      parameters:
      - name: clientMemberId
        in: query
        description: Unique client-side identifier for the member
        required: true
        schema:
          type: string
        example: 3f50436491
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: relatedPersonId
        in: query
        description: The related person which will be associated to the member
        required: true
        schema:
          type: string
        example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRelatedPersonDetailsResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    patch:
      tags:
      - Relatedpersons
      summary: Update Related Person
      description: This API will allow you to update related person detail information.
      operationId: updateRelatedPersonDetails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRelatedPersonRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: 'Bad request.

            - GBL-174: Member is in Inactive state

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /relatedpersons/emails:
    put:
      tags:
      - Relatedpersons
      summary: Update Related Person Emails
      description: Updates the email address(es) for a related person (identified by clientMemberId and client org).
      operationId: putRelatedPersonEmails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailRelatedPersonRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    delete:
      tags:
      - Relatedpersons
      summary: Delete Related Person Email
      description: This API will allow you to delete a related person email address.
      operationId: deleteRelatedPersonEmail
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: relatedPersonId
        in: query
        description: Unique identifier for the related person
        required: true
        schema:
          type: string
          format: uuid
        example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
      - name: emailId
        in: query
        description: Auto-generated type for the email address
        required: true
        schema:
          type: string
        example: Email1
      - name: clientMemberId
        in: query
        description: Unique client-side identifier for the member
        required: true
        schema:
          type: string
        example: 3f50436491
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /relatedpersons/list:
    get:
      tags:
      - Relatedpersons
      summary: Get Related Persons Summary
      description: Retrieves the summary list of related persons for a given member of a client organization
      operationId: getRelatedPersonsByMember
      parameters:
      - name: clientMemberId
        in: query
        description: Unique client-side identifier for the member
        required: true
        schema:
          type: string
        example: 3f50436491
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: type
        in: query
        description: The type of related person
        required: false
        schema:
          type: string
          enum:
          - Beneficiary
          - Dependent
          - Designated Rep
        example: Beneficiary
      - name: beneficiaryType
        in: query
        description: The type of beneficiary
        required: false
        schema:
          type: string
          enum:
          - Primary
          - Contingent
        example: Primary
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRelatedPersonsResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /relatedpersons/phones:
    put:
      tags:
      - Relatedpersons
      summary: Update Related Person Phones
      description: Updates the phone numbers for a related person (identified by clientMemberId and client org).
      operationId: updateRelatedPersonPhones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRelatedPersonPhonesRequestDoc'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    delete:
      tags:
      - Relatedpersons
      summary: Delete Related Person Phone
      description: This API will allow you to delete a related person phone number.
      operationId: deleteRelatedPersonPhone
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: relatedPersonId
        in: query
        description: Unique identifier for the related person
        required: true
        schema:
          type: string
          format: uuid
        example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
      - name: phoneId
        in: query
        description: Auto-generated type for the phone number
        required: true
        schema:
          type: string
        example: Phone1
      - name: clientMemberId
        in: query
        description: Unique client-side identifier for the member
        required: true
        schema:
          type: string
        example: 3f50436491
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedPersonResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
components:
  schemas:
    EmailRelatedPersonData:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        member:
          $ref: '#/components/schemas/BaseMember'
          description: Unique client-side identifier for the member
          example: 3f50436491
        relatedPerson:
          $ref: '#/components/schemas/RelatedPersonEmailDto'
          description: The related person which will be associated to the member
      required:
      - clientOrg
      - member
      - relatedPerson
    RelatedPersonDto:
      type: object
      properties:
        firstName:
          type: string
          description: First name
          example: John
        lastName:
          type: string
          description: Last name
          example: Smith
        middleName:
          type: string
          description: Middle name
          example: Paul
        namePrefix:
          type: string
          description: Prefix for the name
          example: Doctor
        nameSuffix:
          type: string
          description: Suffix for the name
          example: Jr.
        type:
          type: string
          description: The type of related person
          example: Beneficiary
        beneficiaryType:
          type: string
          description: The type of beneficiary
          example: Primary
        allocationPercentage:
          type: number
          description: The percentage allocated to the beneficiary
          example: 100
        relationshipType:
          type: string
          description: Relationship type to member
          example: Child
        dateOfBirth:
          type: string
          format: date-time
          description: Date of birth
          example: '1969-03-02'
        ssn:
          type: string
          description: Social Security Number
          example: '033764347'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/AddressDto'
        emails:
          type: array
          items:
            $ref: '#/components/schemas/EmailDto'
        phones:
          type: array
          items:
            $ref: '#/components/schemas/PhoneDto'
      required:
      - dateOfBirth
      - firstName
      - lastName
      - relationshipType
      - ssn
      - type
    PhoneDto:
      type: object
      properties:
        type:
          type: string
          description: Auto-generated type for the phone number
          example: Phone1
        typeDescription:
          type: string
          description: Client-defined description for the phone number
          example: Cell
        countryCode:
          type: string
          default: '1'
          description: Phone country code
          example: 1
        phoneNumber:
          type: string
          description: 10-Digit phone number
          example: 5089188736
        phoneExtension:
          type: integer
          format: int32
          description: Optional extension
          example: 344
        primaryIndicator:
          type: boolean
          description: Determines whether this is a primary phone
          example: true
      required:
      - countryCode
      - phoneNumber
    GetRelatedPersonsResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetRelatedPersonsResponse'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    PatchRelatedPersonRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatchData'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
      required:
      - data
      - idempotency
    ClientOrgDto:
      type: object
      properties:
        name:
          type: string
          description: The name of the client organization
          example: Health_Plan_ABC_Division
      required:
      - name
    PatchBeneficiariesAllocationPercentageRequestData:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        member:
          $ref: '#/components/schemas/BaseMember'
          description: Unique client-side identifier for the member
          example: 3f50436491
        beneficiaryType:
          type: string
          default: Primary
          description: The type of beneficiary
          enum:
          - Primary
          - Contingent
        relatedPersons:
          type: array
          description: List of related persons of the given beneficiary type of a member
          items:
            $ref: '#/components/schemas/RelatedPersonWithAllocationPercentage'
      required:
      - beneficiaryType
      - clientOrg
      - member
      - relatedPersons
    AddData:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        member:
          $ref: '#/components/schemas/BaseMember'
          description: Unique client-side identifier for the member
          example: 3f50436491
        relatedPerson:
          $ref: '#/components/schemas/AddRelatedPerson'
          description: The related person which will be associated to the member
        beneficiaries:
          type: array
          example:
          - id: b7d24dcf-4362-4e65-88aa-af959aef623c
            allocationPercentage: '90'
          - id: new
            allocationPercentage: '10'
          items:
            $ref: '#/components/schemas/RelatedPersonWithAllocationPercentage'
      required:
      - clientOrg
      - member
      - relatedPerson
    RelatedPersonResponse:
      type: object
      properties:
        relatedPerson:
          $ref: '#/components/schemas/BaseRelatedPerson'
    PatchData:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        member:
          $ref: '#/components/schemas/BaseMember'
          description: Unique client-side identifier for the member
          example: 3f50436491
        relatedPerson:
          $ref: '#/components/schemas/PatchRelatedPerson'
          description: The related person which will be associated to the member
      required:
      - clientOrg
      - member
      - relatedPerson
    GetRelatedPersonsResponse:
      type: object
      properties:
        member:
          $ref: '#/components/schemas/BaseMember'
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        relatedPersons:
          type: array
          items:
            $ref: '#/components/schemas/RelatedPersonSummaryDto'
    RelatedPersonPhonesDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the related person
          example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
        phones:
          type: array
          example:
          - countryCode: '1'
            phoneNumber: '5089188736'
            phoneExtension: 344
            typeDescription: Cell
            primaryIndicator: true
          items:
            $ref: '#/components/schemas/PhoneDto'
      required:
      - id
      - phones
    RelatedPersonWithAllocationPercentage:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the related person
          example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
        allocationPercentage:
          type: number
          description: The percentage allocated to the beneficiary
          example: 100
      required:
      - allocationPercentage
      - id
    GetRelatedPersonDetailsResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetRelatedPersonDetailResponse'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    UpdateRelatedPersonPhonesRequestDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateRelatedPersonPhonesRequest'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
      required:
      - data
      - idempotency
    RelatedPersonSummaryDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        firstName:
          type: string
          description: First name
          example: John
        lastName:
          type: string
          description: Last name
          example: Smith
        status:
          type: string
          description: The status of the related person
          example: NEW
        relationshipType:
          type: string
          description: Relationship type to member
          example: Child
        type:
          type: string
          description: The type of related person
          example: Beneficiary
        beneficiaryType:
          type: string
          description: The type of beneficiary
          example: Primary
        allocationPercentage:
          type: number
          description: The percentage allocated to the beneficiary
          example: 100
        creationDate:
          type: string
          format: date-time
          description: Date when the related person was created
          example: '2018-03-22'
        updateDate:
          type: string
          format: date-time
          description: Date when the related person was updated
          example: '2018-03-22'
      required:
      - relationshipType
      - type
      - updateDate
    ResponseException:
      type: object
      properties:
        errorCode:
          type: string
          description: The GBL error code that is populated when the exceptionSource is SYSTEM
        exceptionSource:
          type: string
          description: Characterizes the type of exception (JSON, SYSTEM, PARAMETER)
        exceptionMessage:
          type: string
          description: Additional information about the exception
    ExceptionBaseResponse:
      type: object
      properties:
        data:
          type: object
          description: 'null'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    Idempotency:
      type: object
      properties:
        idempotencyKey:
          type: string
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
    PatchBeneficiariesAllocationPercentageRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatchBeneficiariesAllocationPercentageRequestData'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
      required:
      - data
      - idempotency
    BaseRelatedPerson:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the related person
          example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
      required:
      - id
    EmailRelatedPersonRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EmailRelatedPersonData'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
      required:
      - data
      - idempotency
    RelatedPersonAddressesDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the related person
          example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
        addresses:
          type: array
          example:
          - typeDescription: Home
            name: John Smith
            attentionCareOf: Care/of John Smith
            line3: line3
            line4: line4
            pobox: P.O. box 21345
            county: Norfolk
            line1: 10 Miller Street
            line2: line2
            city: Boston
            stateProvince: MA
            country: US
            postalCode: 02119
            postalCodeExtension: '0123'
            primaryIndicator: true
          items:
            $ref: '#/components/schemas/AddressDto'
      required:
      - addresses
      - id
    AddressDto:
      type: object
      properties:
        line1:
          type: string
          description: The first line of the address
          example: 10
        line2:
          type: string
          description: The (optional) second line of the address
          example: address line2
        city:
          type: string
          description: Address city
          example: Boston
        stateProvince:
          type: string
          description: 2-Character address state or province
          example: MA
        country:
          type: string
          description: Address country
          example: US
        postalCode:
          type: string
          description: Address zip code
          example: 02119
        postalCodeExtension:
          type: string
          description: Address zip code extension
          example: '0123'
        type:
          type: string
          description: Auto-generated type for the address
          example: Address1
        typeDescription:
          type: string
          description: Client-defined description for the address
          example: Home
        name:
          type: string
          description: Name of person
          example: John Smith
        attentionCareOf:
          type: string
          description: If the address is 'in-care-of' someone else
          example: Care/of John Smith
        line3:
          type: string
          description: The (optional) third line of the address
          example: address line3
        line4:
          type: string
          description: The (optional) fourth line of the address
          example: address line4
        pobox:
          type: string
          description: P.O. Box number
          example: P.O. box 21345
        county:
          type: string
          description: Address county
          example: Norfolk
        primaryIndicator:
          type: boolean
          description: Determines whether this is a primary address
          example: true
        returnMailIndicator:
          type: boolean
          description: Indicated whether the member’s address has had mail returned
          example: false
        returnMailDate:
          type: string
          format: date-time
          description: Date returned mail was received
          example: '2024-01-01'
        returnMailReason:
          type: string
          description: Reason for mail being returned
          example: Invalid Address
      required:
      - city
      - country
      - line1
      - postalCode
      - stateProvince
    PatchBeneficiariesAllocationPercentageResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatchBeneficiariesAllocationPercentageResponse'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    EmailDto:
      type: object
      properties:
        type:
          type: string
          description: Auto-generated type for the email address
          example: Email1
        typeDescription:
          type: string
          description: Client-defined description for the email address
          example: Personal
        emailAddress:
          type: string
          description: Email address - any notifications will be sent to this email address
          example: john@doe.com
        primaryIndicator:
          type: boolean
          description: Determines whether this is a primary email address
          example: true
      required:
      - emailAddress
    PatchRelatedPerson:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the related person
          example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
        firstName:
          type: string
          description: First name
          example: John
        lastName:
          type: string
          description: Last name
          example: Smith
        middleName:
          type: string
          description: Middle name
          example: Paul
        namePrefix:
          type: string
          description: Prefix for the name
          example: Doctor
        nameSuffix:
          type: string
          description: Suffix for the name
          example: Jr.
        relationshipType:
          type: string
          description: Relationship type to member
          enum:
          - Child
          - Spouse
          - Other
          example: Child
        dateOfBirth:
          type: string
          description: Date of birth
          example: '1969-03-02'
        ssn:
          type: string
          description: Social Security Number - either SSN or passport are required
          example: '033764347'
        type:
          type: string
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/AddressDto'
        emails:
          type: array
          items:
            $ref: '#/components/schemas/EmailDto'
        phones:
          type: array
          items:
            $ref: '#/components/schemas/PhoneDto'
        beneficiaryType:
          type: string
      required:
      - id
    UpdateRelatedPersonAddressesRequest:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        member:
          $ref: '#/components/schemas/BaseMember'
        relatedPerson:
          $ref: '#/components/schemas/RelatedPersonAddressesDto'
    AddRelatedPerson:
      type: object
      properties:
        firstName:
          type: string
          description: First name
          example: John
        lastName:
          type: string
          description: Last name
          example: Smith
        middleName:
          type: string
          description: Middle name
          example: Paul
        namePrefix:
          type: string
          description: Prefix for the name
          example: Doctor
        nameSuffix:
          type: string
          description: Suffix for the name
          example: Jr.
        relationshipType:
          type: string
          description: Relationship type to member
          enum:
          - Child
          - Spouse
          - Other
          example: Child
        dateOfBirth:
          type: string
          description: Date of birth
          example: '1969-03-02'
        ssn:
          type: string
          description: Social Security Number - either SSN or passport. This is required when the related person type is 'Beneficiary'
          example: '033764347'
        type:
          type: string
          description: The type of related person
          enum:
          - Beneficiary
          - Dependent
          - Designated Rep
          example: Beneficiary
        beneficiaryType:
          type: string
          description: The type of beneficiary
          enum:
          - Primary
          - Contingent
          example: Primary
        addresses:
          type: array
          example:
          - typeDescription: Home
            name: John Smith
            attentionCareOf: Care/of John Smith
            line3: line3
            line4: line4
            pobox: P.O. box 21345
            county: Norfolk
            line1: 10 Miller Street
            line2: line2
            city: Boston
            stateProvince: MA
            country: US
            postalCode: 02119
            postalCodeExtension: '0123'
            primaryIndicator: true
          items:
            $ref: '#/components/schemas/AddressDto'
        emails:
          type: array
          example:
          - typeDescription: Personal
            emailAddress: john@doe.com
            primaryIndicator: true
          items:
            $ref: '#/components/schemas/EmailDto'
        phones:
          type: array
          example:
          - countryCode: '1'
            phoneNumber: '5089188736'
            phoneExtension: 344
            typeDescription: Cell
            primaryIndicator: true
          items:
            $ref: '#/components/schemas/PhoneDto'
      required:
      - firstName
      - lastName
      - relationshipType
      - type
    PatchBeneficiariesAllocationPercentageResponse:
      type: object
      properties:
        relatedPersons:
          type: array
          items:
            $ref: '#/components/schemas/BaseRelatedPerson'
    RelatedPersonRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AddData'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
      required:
      - data
      - idempotency
    BaseMember:
      type: object
      properties:
        clientMemberId:
          type: string
          description: Unique client-side identifier for the member
          example: 3f50436491
      required:
      - clientMemberId
    UpdateRelatedPersonPhonesRequest:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        member:
          $ref: '#/components/schemas/BaseMember'
        relatedPerson:
          $ref: '#/components/schemas/RelatedPersonPhonesDto'
    UpdateRelatedPersonAddressesRequestDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateRelatedPersonAddressesRequest'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
      required:
      - data
      - idempotency
    DeleteRelatedPersonResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BaseMember'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    RelatedPersonResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RelatedPersonResponse'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    RelatedPersonEmailDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the related person
          example: 3d3bdad9-21e0-47bc-becd-b4872c0e8bf9
        emails:
          type: array
          example:
          - typeDescription: Personal
            emailAddress: john@doe.com
            primaryIndicator: true
          items:
            $ref: '#/components/schemas/EmailDto'
      required:
      - emails
      - id
    GetRelatedPersonDetailResponse:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        member:
          $ref: '#/components/schemas/BaseMember'
        relatedPerson:
          $ref: '#/components/schemas/RelatedPersonDto'
      required:
      - clientOrg
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://docs.lynx-fh.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.lynx-fh.com/reference/addnewrelatedperson.md
  - https://docs.lynx-fh.com/reference/deleterelatedperson.md
  - https://docs.lynx-fh.com/reference/deleterelatedpersonaddress.md
  - https://docs.lynx-fh.com/reference/deleterelatedpersonemail.md
  - https://docs.lynx-fh.com/reference/deleterelatedpersonphone.md
  - https://docs.lynx-fh.com/reference/getrelatedpersondetails.md
  - https://docs.lynx-fh.com/reference/getrelatedpersonsbymember.md
  - https://docs.lynx-fh.com/reference/putrelatedpersonemails.md
  - https://docs.lynx-fh.com/reference/updateallocationpercentage.md
  - https://docs.lynx-fh.com/reference/updaterelatedpersonaddresses.md
  - https://docs.lynx-fh.com/reference/updaterelatedpersondetails.md
  - https://docs.lynx-fh.com/reference/updaterelatedpersonphones.md
  merge:
    pages: 12
    deduped: 85
    conflicts_kept_first: 0