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

# List KYC checks for a specific merchant

> Requires the merchant.kyc.list permission.

Returns the KYC check history of a merchant that belongs to the authenticated
organization, newest first. A check is run automatically when the merchant is
created and whenever its registration data changes; each check carries the
outcome of every rule in the policy that was in effect at the time, so a
historical check keeps its original results even after the policy changes.

The response carries the same rule results delivered by the `kyc.completed`
webhook, plus row identifiers and timestamps. `expected`, `received` and
`description` hold the values stored with the rule execution and are `null`
when the rule recorded none. Raw data returned by the external data source is
never included.




## OpenAPI

````yaml /api-spec.yaml get /v1/merchants/{merchantId}/kyc-checks
openapi: 3.1.0
info:
  title: Rinne API
  version: 1.0.0
  description: >
    **Rinne API** is a robust payment platform that offers integration with
    multiple payment providers.


    ## Authentication


    The API uses API Key authentication via the `x-api-key` header. Each company
    has a unique key to access resources.


    ## Response Format


    All responses follow a consistent format:

    - **Success**: Returns the requested data directly

    - **Error**: Returns an `error` object with detailed information


    ## Pagination


    Endpoints that return lists support pagination through parameters:

    - `page`: Page number (default: 1)

    - `limit`: Items per page (default: 20, maximum: 100)


    ## Supported Providers


    The API supports multiple payment providers:

    - **Rinne**: Internal provider

    - **Celcoin**: PIX integration and other financial services


    ## Raw Card Data (PCI Endpoints)


    Card credential fields (`card_data.number`, `card_data.cvv`,
    `card_data.network_token`,

    `card_data.cryptogram`, and the 3DS `card.number`) must always be sent
    encrypted —

    values start with the `ev:` prefix. Plaintext values are rejected with

    `400 VALIDATION_ERROR` on every host.


    There are two ways to send encrypted values:

    - **rinne-js**: card forms and wallet buttons (Apple Pay / Google Pay)
    encrypt
      credentials client-side before they leave the browser.
    - **PCI API host**: server-to-server integrations that handle raw card data
    must call
      `https://pci.api.rinne.com.br/core` (sandbox: `https://pci.api-sandbox.rinne.com.br/core`)
      instead of the regular host. This endpoint encrypts `number` and `cvv` in transit
      before the request reaches the API; all other fields pass through unchanged.

    The PCI host serves only transaction creation and 3DS session creation (both
    the

    self and merchant variants); use the regular host for everything else.
  contact:
    name: Rinne API Support
    email: suporte@rinne.com.br
servers:
  - url: https://api-sandbox.rinne.com.br/core
    description: Sandbox
  - url: https://api.rinne.com.br/core
    description: Production
security: []
tags:
  - name: System
    description: System and API health endpoints
  - name: Tap-on-Phone
    description: Access-token minting for the Tap-on-Phone SDK (called from your backend)
  - name: Authentication
    description: User authentication and authorization endpoints
  - name: Management
    description: >-
      Merchant management endpoints - create, list, get specific, overview,
      update
  - name: Transactions
    description: Transaction operations for merchants - create, list, overview, refunds
  - name: Affiliations
    description: Affiliation management for merchants
  - name: KYC
    description: KYC check history of your merchants
  - name: Banking
    description: Banking operations for merchants - balance, cashout, statements
  - name: Bank Accounts
    description: Bank account management for merchants
  - name: Pix Keys
    description: PIX key management for merchants
  - name: Company Transactions
    description: Direct transaction management and query endpoints for companies
  - name: Companies
    description: Company management
  - name: Company Affiliations
    description: Payment provider affiliation management
  - name: Company Banking
    description: Company banking endpoints (balance, etc.)
  - name: Company Pix
    description: Company PIX key management
  - name: Company Ledger
    description: Company ledger entry query endpoints
  - name: Company Disputes
    description: Company dispute query endpoints
  - name: Ledger
    description: Ledger entry query endpoints (company and merchants)
  - name: Disputes
    description: Dispute query endpoints for an organization's merchants
  - name: Cards
    description: Stored card management (self and merchant)
  - name: API Keys
    description: API key management - create, list, revoke (hashed, show-once)
  - name: Webhooks
    description: Endpoints for receiving webhooks from external providers
  - name: Pricing
    description: Fee and cost policy management for transaction pricing
  - name: Users
    description: User management endpoints
  - name: Roles
    description: Role management endpoints
  - name: Permissions
    description: Permission management endpoints
paths:
  /v1/merchants/{merchantId}/kyc-checks:
    get:
      tags:
        - KYC
      summary: List KYC checks for a specific merchant
      description: >
        Requires the merchant.kyc.list permission.


        Returns the KYC check history of a merchant that belongs to the
        authenticated

        organization, newest first. A check is run automatically when the
        merchant is

        created and whenever its registration data changes; each check carries
        the

        outcome of every rule in the policy that was in effect at the time, so a

        historical check keeps its original results even after the policy
        changes.


        The response carries the same rule results delivered by the
        `kyc.completed`

        webhook, plus row identifiers and timestamps. `expected`, `received` and

        `description` hold the values stored with the rule execution and are
        `null`

        when the rule recorded none. Raw data returned by the external data
        source is

        never included.
      parameters:
        - in: path
          name: merchantId
          required: true
          schema:
            type: string
            format: uuid
          description: The merchant ID
          example: 889fd9b3-1634-429a-b54f-eaa0004345cd
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number
          example: 1
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Number of items per page
          example: 20
      responses:
        '200':
          description: KYC checks of the merchant, newest first
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KycCheckResponse'
                  pagination:
                    $ref: '#/components/schemas/PaginationResponse'
                required:
                  - data
                  - pagination
        '400':
          description: Invalid pagination parameters (for example, `limit` above 100)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationErrorResponse'
        '403':
          description: Insufficient permissions to access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorResponse'
        '404':
          description: Merchant not found or does not belong to authenticated organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    KycCheckResponse:
      type: object
      description: One KYC check of a merchant with the outcome of every rule in its policy
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of this KYC check run
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        company_id:
          type: string
          format: uuid
          description: ID of the merchant company that was checked
          example: 889fd9b3-1634-429a-b54f-eaa0004345cd
        policy_id:
          type: string
          format: uuid
          description: ID of the KYC policy in effect when the check ran
          example: cb350742-a9b8-4a3c-9d7a-02aa8cbb24cb
        policy_name:
          type: string
          description: Name of the KYC policy in effect when the check ran
          example: rinne-default-natural-person
        kyc_type:
          type: string
          enum:
            - NATURAL_PERSON_COMPANY
            - LEGAL_PERSON_COMPANY
          description: Whether the checked company is a natural or legal person
          example: NATURAL_PERSON_COMPANY
        rule_executions:
          type: array
          description: Results for each rule in the policy, ordered by rule name
          items:
            $ref: '#/components/schemas/KycRuleExecutionResponse'
        created_at:
          type: string
          format: date-time
          description: When the check ran
          example: '2026-08-02T12:00:00.000Z'
      required:
        - id
        - company_id
        - policy_id
        - policy_name
        - kyc_type
        - rule_executions
        - created_at
    PaginationResponse:
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
        - hasNext
        - hasPrev
      properties:
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 20
        total:
          type: integer
          example: 50
        totalPages:
          type: integer
          example: 3
        hasNext:
          type: boolean
          example: true
        hasPrev:
          type: boolean
          example: false
    ValidationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation error
            status:
              type: integer
              example: 400
            details:
              type: object
              properties:
                issues:
                  type: array
                  items:
                    type: object
                    properties:
                      field:
                        type: string
                        example: email
                      type:
                        type: string
                        example: REQUIRED
                      message:
                        type: string
                        example: Field 'email' is required
                      value:
                        anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                        example: invalid_value
                      constraints:
                        type: object
                        example:
                          min: 18
                          max: 120
            path:
              type: string
              example: /companies
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    AuthenticationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: AUTHENTICATION_ERROR
            message:
              type: string
              example: Authentication required to access this resource
            status:
              type: integer
              example: 401
            details:
              type: object
              properties:
                reason:
                  type: string
                  example: Invalid API key
            path:
              type: string
              example: /companies/me
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    AuthorizationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: AUTHORIZATION_ERROR
            message:
              type: string
              example: You need 'admin' permissions to access this resource
            status:
              type: integer
              example: 403
            path:
              type: string
              example: /companies
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    NotFoundErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: RESOURCE_NOT_FOUND
            message:
              type: string
              example: Company with ID '123' not found
            status:
              type: integer
              example: 404
            path:
              type: string
              example: /companies/me
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    InternalServerErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: INTERNAL_SERVER_ERROR
            message:
              type: string
              example: An unexpected error occurred
            status:
              type: integer
              example: 500
            path:
              type: string
              example: /companies
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    KycRuleExecutionResponse:
      type: object
      description: The outcome of one policy rule inside a KYC check
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of this rule execution
          example: 5f0c2a8e-3b1d-4c7e-9a2f-6d8e1b4c7a90
        rule_name:
          type: string
          enum:
            - DOCUMENT_NUMBER_VALID
            - DOCUMENT_STATUS_VALID
            - FULL_NAME_CORRECT
            - DATE_OF_BIRTH_CORRECT
            - IS_ALIVE
            - HAS_SANCTIONS
            - LEGAL_DOCUMENT_NUMBER_VALID
            - LEGAL_DOCUMENT_STATUS_VALID
            - LEGAL_NAME_CORRECT
            - LEGAL_HAS_SANCTIONS
            - COMPANY_TYPE_CORRECT
            - IS_CONTACT_REPRESENTATIVE
            - NO_SHAREHOLDERS_RESTRICTIONS
            - CONTACT_DOCUMENT_NUMBER_VALID
            - CONTACT_DOCUMENT_STATUS_VALID
            - CONTACT_FULL_NAME_CORRECT
            - CONTACT_DATE_OF_BIRTH_CORRECT
            - CONTACT_IS_ALIVE
            - CONTACT_HAS_SANCTIONS
          description: Identifier of the rule that was evaluated
          example: DOCUMENT_NUMBER_VALID
        status:
          type: string
          enum:
            - PASSED
            - ISSUES_FOUND
            - FAILED
          description: Outcome of the rule evaluation
          example: PASSED
        expected:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            Field values reported by the external data source. Null when the
            data source was unreachable.
          example:
            document_exists: false
        received:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            Field values the merchant declared, or the values required for the
            rule to pass when it has no merchant-declared counterpart.
          example:
            document_exists: true
        description:
          type:
            - string
            - 'null'
          description: >-
            Human-readable explanation of why the rule did not pass. Null when
            the rule passed.
          example: Document was not found in the external data source
        created_at:
          type: string
          format: date-time
          description: When the rule was evaluated
          example: '2026-08-02T12:00:00.000Z'
      required:
        - id
        - rule_name
        - status
        - expected
        - received
        - description
        - created_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Company API key for authentication

````