> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partner-api.tryrima.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get membership status

> Draft contract for looking up app access by external ID.

**Coming soon — unavailable in sandbox and production.** The code sample uses the current Partner API host for illustration; the final hostname and contract are undecided. Do not send requests to this route.

The lookup would use one `external_system` and `external_id` pair without a company or organization parameter. It would return exactly three booleans, without an envelope or identifiers.

No authorized identity match would return all three values as `false`. Matches resolving to different people would return HTTP `409` rather than combining their statuses. Service failures would return a non-2xx response rather than false booleans.

The exact enrollment-state mapping, the proposed rule across multiple employments, and opt-out aggregation across different participation decisions remain undecided.


## OpenAPI

````yaml POST /v1/get-membership-status
openapi: 3.1.0
info:
  title: Rima Partner API proposed endpoints
  version: draft
  description: Documentation preview only. These operations are not implemented.
servers:
  - url: https://partner-api.tryrima.com
    description: Rima (route not available)
security: []
paths:
  /v1/get-membership-status:
    post:
      summary: Get membership status
      description: Proposed endpoint. Not available in any environment.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                external_system:
                  type: string
                  description: Exact supported system name.
                external_id:
                  type: string
                  description: Opaque ID in that system.
              required:
                - external_system
                - external_id
              example:
                external_system: payroll_system
                external_id: 33333333-3333-4333-8333-333333333333
      responses:
        '200':
          description: Proposed app access result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrolled:
                    type: boolean
                    description: Effective enrollment; exact state mapping pending.
                  registered:
                    type: boolean
                    description: Existing app account, independent of enrollment.
                  opted_out:
                    type: boolean
                    description: Effective opt-out; aggregation across employments pending.
                required:
                  - enrolled
                  - registered
                  - opted_out
                additionalProperties: false
              examples:
                example:
                  value:
                    enrolled: true
                    registered: false
                    opted_out: false
        '400':
          description: Invalid or unsupported input.
        '401':
          description: Missing or invalid credentials.
        '403':
          description: Insufficient permissions.
        '409':
          description: External ID resolves to different people.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.