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

# Retrieve signers

> Get signers with support for filtering.



## OpenAPI

````yaml /public/spi-v3.yaml get /v1/signer
openapi: 3.0.0
info:
  title: SPI documentation
  version: 2.0.0
  description: API documentation for TransfiYa SPI flow
servers: []
security: []
tags:
  - name: Signer
    description: Operations related to Signers (keys)
paths:
  /v1/signer:
    get:
      tags:
        - Signer
      summary: Retrieve signers
      description: Get signers with support for filtering.
      operationId: getSigners
      parameters:
        - in: query
          name: pagenum
          schema:
            type: integer
          required: false
        - in: query
          name: pagesize
          schema:
            type: integer
          required: false
        - in: query
          name: handle
          schema:
            type: string
          required: false
        - in: query
          name: labels.aliasType
          schema:
            type: string
            enum:
              - ALPHANUM
              - NRIC
              - PHONE
              - EMAIL
              - MERCHANT
          required: false
        - in: query
          name: labels.aliasValue
          schema:
            type: string
          required: false
          examples:
            example1:
              summary: Get a signer by aliasValue
              value: '@jorge'
      responses:
        '200':
          description: Signer details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  entities:
                    type: array
                    items:
                      $ref: '#/components/schemas/SignerResponse'
                  pagination:
                    type: object
                    properties:
                      pageNum:
                        type: number
                      pageSize:
                        type: number
                  error:
                    type: object
                    properties:
                      code:
                        type: number
                      message:
                        type: string
              examples:
                example1:
                  summary: Response for query by aliasValue
                  value:
                    entities:
                      - signer_id: 01958221-232c-7884-9c17-d76170087d06
                        id: 01958221-232c-7884-9c17-d76170087d06
                        handle: wgC4AdDJGDPoGrdD2e4MsS28W3SAR3Uo9h
                        keeper:
                          - public: >-
                              0406abe8a361c5d9cc6f8d2ae387ff2451622978c2a41f68ed0523652c06ac33c03b0841ec3c55bc33be831b2bc5a1aaf46b615554cdf809300b2d509f8258d4da
                            scheme: ecdsa-ed25519
                            secret: >-
                              0563062c13538fc6fb28bd73a2ef70278c2bdc5037a5a828b69899f9b29eb5f0
                        labels:
                          type: PERSON
                          status: ACTIVE
                          created: '2025-03-18T15:12:55.993-05:00'
                          updated: '2025-03-18T15:12:55.993-05:00'
                          createdBy: mSJkneiASd
                          aliasType: ALPHANUM
                          aliasValue: '@jorge'
                          proprietary: CC
                          identification: '1010101010'
                          firstName: Jorge
                          lastName: Diaz
                          bankId: '900123456'
                          bankAccountType: SVGS
                          bankAccountNumber: '4123456789'
                          routerReference: $bancorojo
                          targetSpbviCode: TFY
                          consented: '2025-03-18T20:38:07-05:00'
                          received: '2025-03-13T20:38:07.123-05:00'
                          dispatched: '2025-03-13T20:38:10.123-05:00'
                      - signer_id: 0195b009-a139-7ff2-adac-15e3c3ecfc88
                        id: 0195b009-a139-7ff2-adac-15e3c3ecfc88
                        handle: wYe6h63CNqoLxJet5jP1WWLhGi8D11ZGij
                        keeper:
                          - public: >-
                              7ef44ee7ff1f4527ef44ee7ff1f4527ef44ee7ff1f4527ef44ee7ff1f4527ef4
                            scheme: ecdsa-ed25519
                            secret: >-
                              046d541aec939b4748943e49cc1117a70966a6fc87345e6052a54f1e69ea48d5
                        labels:
                          type: PERSON
                          status: INACTIVE
                          created: '2025-03-19T15:12:55.993-05:00'
                          updated: '2025-03-19T15:12:55.993-05:00'
                          createdBy: mSJkneiASd
                          aliasType: ALPHANUM
                          aliasValue: '@jorge'
                          proprietary: CC
                          identification: '1010101010'
                          firstName: Jorge
                          lastName: Diaz
                          bankId: '900123456'
                          bankAccountType: SVGS
                          bankAccountNumber: '4123456789'
                          routerReference: $bancorojo
                          targetSpbviCode: TFY
                          consented: '2025-03-19T20:38:07-05:00'
                          received: '2025-03-13T20:38:07.123-05:00'
                          dispatched: '2025-03-13T20:38:10.123-05:00'
                    pagination:
                      pageNum: 0
                      pageSize: 50
                    error:
                      code: 0
                      message: Success
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
components:
  schemas:
    SignerResponse:
      type: object
      properties:
        id:
          type: string
        signer_id:
          type: string
        handle:
          type: string
        keeper:
          type: array
          items:
            type: object
            properties:
              private:
                type: string
              public:
                type: string
              scheme:
                type: string
        labels:
          type: object
          properties:
            type:
              type: string
            aliasType:
              type: string
            aliasValue:
              type: string
            status:
              type: string
            proprietary:
              type: string
            description:
              type: string
            identification:
              type: string
            name:
              type: string
            firstName:
              type: string
            secondName:
              type: string
            lastName:
              type: string
            secondLastName:
              type: string
            countryOfResidence:
              type: string
            bankAccountType:
              type: string
            bankAccountNumber:
              type: string
            bankBicfi:
              type: string
            bankName:
              type: string
            bankId:
              type: string
            createdBy:
              type: string
            routerReference:
              type: string
            targetSpbviCode:
              type: string
            consented:
              type: string
            received:
              type: string
            dispatched:
              type: string
            created:
              type: string
            updated:
              type: string
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/GenericError'
    GenericError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        requestId:
          type: string

````