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

# List participants

> Lists participants for a device with optional enrollment info.



## OpenAPI

````yaml api-reference/banking-api/receivables/biometrics/openapi.json GET /biometrics/participants
openapi: 3.0.0
info:
  title: Trio Biometrics API
  version: 0.1.0
servers:
  - url: http://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /biometrics/participants:
    get:
      tags:
        - biometrics
      summary: List participants
      description: >-
        Lists participants. Optionally filter by ISPB. When a device_id is
        provided, each participant includes enrolled? and enrollment fields, and
        enrolled participants are returned first.
      operationId: TrioInitiationWeb.Biometrics.ParticipantController.index
      parameters:
        - description: >-
            Device ID. When provided, enrollments for this device are included
            in the response.
          in: query
          name: device_id
          required: false
          schema:
            type: string
        - description: List of ISPBs to filter by
          in: query
          name: ispbs
          required: false
          schema:
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Participants_response'
                  - $ref: >-
                      #/components/schemas/Participants_with_enrollments_response
                description: >-
                  When device_id is provided, returns participants with
                  enrollment info. Otherwise, returns participants without
                  enrollment info.
          description: Participants
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonErrorResponse'
          description: Unprocessable Entity
      callbacks: {}
components:
  schemas:
    Participants_response:
      description: List of biometrics participants
      example:
        data:
          - avatar: >-
              https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg
            id: 019fa021-d9f8-a4b4-0683-068db83a1f65
            integration_id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
            is_enrollment_available: true
            ispb: '12345678'
            name: Mock Bank
            slug: mock-bank
            status: active
            unavailable: false
      properties:
        data:
          items:
            $ref: '#/components/schemas/Biometrics_Participant'
          type: array
      title: Participants_response
      type: object
    Participants_with_enrollments_response:
      description: List of biometrics participants with enrollment info
      example:
        data:
          - avatar: >-
              https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg
            id: 019fa021-d9f8-a4b4-0683-068db83a1f65
            integration_id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
            is_enrollment_available: true
            ispb: '12345678'
            name: Mock Bank
            slug: mock-bank
            status: active
            unavailable: false
            enrolled?: true
            enrollment:
              device_id: 019fa021-d9f8-a4b4-0683-068db83a1f65
              expiration_datetime: '2026-08-26T00:00:00Z'
              id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
              inserted_at: '2026-07-26T00:00:00Z'
              participant_id: 019fa021-d9f8-a4b4-0683-068db83a1f65
              status: completed
              updated_at: '2026-07-26T00:00:00Z'
      properties:
        data:
          items:
            $ref: '#/components/schemas/Biometrics_Participant_with_Enrollment'
          type: array
      title: Participants_with_enrollments_response
      type: object
    JsonErrorResponse:
      properties:
        errors:
          items:
            properties:
              detail:
                example: null value where string expected
                type: string
              source:
                properties:
                  pointer:
                    example: /data/attributes/petName
                    type: string
                required:
                  - pointer
                type: object
              title:
                example: Invalid value
                type: string
            required:
              - title
              - source
              - detail
            type: object
          type: array
      required:
        - errors
      title: JsonErrorResponse
      type: object
    Biometrics_Participant:
      description: A biometrics participant
      example:
        avatar: >-
          https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg
        id: 019fa021-d9f8-a4b4-0683-068db83a1f65
        integration_id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
        is_enrollment_available: true
        ispb: '12345678'
        name: Mock Bank
        slug: mock-bank
        status: active
        unavailable: false
      properties:
        avatar:
          description: Avatar URL
          type: string
        id:
          description: Participant ID
          format: uuid
          type: string
        integration_id:
          description: Integration ID
          type: string
        is_enrollment_available:
          description: Whether enrollment is available
          type: boolean
        ispb:
          description: ISPB code
          type: string
        name:
          description: Participant name
          type: string
        slug:
          description: Slug
          type: string
        status:
          description: Participant status
          type: string
        unavailable:
          description: Whether participant is unavailable
          type: boolean
      title: Biometrics_Participant
      type: object
    Biometrics_Participant_with_Enrollment:
      description: A biometrics participant with enrollment info
      allOf:
        - $ref: '#/components/schemas/Biometrics_Participant'
        - type: object
          properties:
            enrolled?:
              description: >-
                Whether participant is enrolled. Present when device_id is
                provided.
              type: boolean
            enrollment:
              description: Enrollment data, or null if not enrolled
              nullable: true
              oneOf:
                - $ref: '#/components/schemas/Biometrics_Participant_Enrollment'
                - type: string
                  nullable: true
      example:
        avatar: >-
          https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg
        id: 019fa021-d9f8-a4b4-0683-068db83a1f65
        integration_id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
        is_enrollment_available: true
        ispb: '12345678'
        name: Mock Bank
        slug: mock-bank
        status: active
        unavailable: false
        enrolled?: true
        enrollment:
          device_id: 019fa021-d9f8-a4b4-0683-068db83a1f65
          expiration_datetime: '2026-08-26T00:00:00Z'
          id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
          inserted_at: '2026-07-26T00:00:00Z'
          participant_id: 019fa021-d9f8-a4b4-0683-068db83a1f65
          status: completed
          updated_at: '2026-07-26T00:00:00Z'
      title: Biometrics_Participant_with_Enrollment
      type: object
    Biometrics_Participant_Enrollment:
      description: Enrollment data attached to a participant
      example:
        device_id: 019fa021-d9f8-a4b4-0683-068db83a1f65
        expiration_datetime: '2026-08-26T00:00:00Z'
        id: 019fa021-d9f9-7fa9-6f53-afc7b32f7b93
        inserted_at: '2026-07-26T00:00:00Z'
        participant_id: 019fa021-d9f8-a4b4-0683-068db83a1f65
        status: completed
        updated_at: '2026-07-26T00:00:00Z'
      properties:
        device_id:
          description: Device ID
          format: uuid
          type: string
        expiration_datetime:
          description: Expiration datetime
          format: date-time
          type: string
        id:
          description: Enrollment ID
          format: uuid
          type: string
        inserted_at:
          description: Created at
          format: date-time
          type: string
        participant_id:
          description: Participant ID
          format: uuid
          type: string
        status:
          description: Enrollment status
          type: string
        updated_at:
          description: Updated at
          format: date-time
          type: string
      title: Biometrics_Participant_Enrollment
      type: object

````