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

# Listar relatórios assíncronos da API

> Liste os relatórios assíncronos da Didit, filtre por tipo ou estado e analise falhas, com permissões por aplicação e paginação.

A API de Relatórios assíncrona da Didit lista as tarefas de exportação que pode consultar, das mais recentes para as mais antigas. Use `failed_count` e `failed_item_ids` para identificar as exportações de verificação com falhas individuais.

Consulte as [orientações sobre exportação e como tentar novamente](https://docs.didit.me/pt/console/export-pdf-csv.md#tentar-novamente-itens-com-falha-na-exportação), [como obter um relatório](https://docs.didit.me/pt/management-api/reports/retrieve.md) ou [como tentar novamente uma exportação](https://docs.didit.me/pt/management-api/reports/retry.md).


## OpenAPI

````yaml pt/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/reports/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/organization/{organization_id}/application/{application_id}/reports/:
    get:
      tags:
        - Reports
      summary: Listar relatórios assíncronos
      description: >-
        Requer permissões de leitura para todos os recursos abrangidos pelo
        relatório. As credenciais de aplicação/chave de API devem pertencer à
        aplicação indicada no caminho. Os tokens Bearer de membros devem ter
        acesso à aplicação. Devolve os relatórios legíveis, do mais recente para
        o mais antigo. Estes trabalhos de exportação assíncronos são separados
        da API de Relatórios Regulatórios. Consulte [Exportar dados de
        verificação](https://docs.didit.me/pt/console/export-pdf-csv).
      operationId: list_reports
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Identificador da organização.
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Identificador da aplicação.
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
          description: Número máximo de resultados por página.
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Número de resultados a ignorar.
        - name: status
          in: query
          schema:
            type: string
          description: >-
            Valores de status separados por vírgulas ou repetidos: PENDING,
            PROCESSING, READY, FAILED.
        - name: report_type
          in: query
          schema:
            type: string
          description: Valores de report_type separados por vírgulas ou repetidos.
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Pesquise por fragmento do ID do relatório ou por nome/e-mail do
            requerente (no máximo 255 caracteres).
      responses:
        '200':
          description: Listar relatórios assíncronos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncReportList'
        '400':
          description: status, report_type ou filtro de pesquisa inválido.
        '401':
          description: Credenciais em falta, inválidas ou expiradas.
        '403':
          description: >-
            O autor do pedido não tem acesso a esta aplicação nem as permissões
            necessárias.
        '429':
          $ref: '#/components/responses/RateLimitedRead'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            # and DIDIT_APPLICATION_ID.
            client = Didit()

            for item in client.reports.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            // and DIDIT_APPLICATION_ID.
            const didit = new Didit();

            for await (const item of didit.reports.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Reports.ListAutoPaging(ctx, didit.ReportsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            // and DIDIT_APPLICATION_ID.
            Didit client = new Didit();

            for (var item : client.reports().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            // and DIDIT_APPLICATION_ID.
            $didit = new DiditClient();

            foreach ($didit->reports->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            # and DIDIT_APPLICATION_ID.
            didit = Didit::Client.new

            didit.reports.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            // and DIDIT_APPLICATION_ID.
            using var client = new DiditClient();

            await foreach (var item in await client.Reports.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    AsyncReportList:
      type: object
      required:
        - count
        - next
        - previous
        - results
        - counts
      properties:
        count:
          type: integer
          description: >-
            Número de resultados, normalmente limitado a 100; pode ser estimado.
            Utilize next em vez de count para parar a paginação.
        next:
          type: string
          description: URL da página seguinte, ou null.
          nullable: true
        previous:
          type: string
          description: URL da página anterior, ou null.
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/AsyncReport'
        counts:
          type: object
          required:
            - report_type
            - status
          description: >-
            Contagens de todos os relatórios que o autor do pedido pode ler,
            antes dos filtros da lista.
          properties:
            report_type:
              type: object
              additionalProperties:
                type: integer
            status:
              type: object
              additionalProperties:
                type: integer
    AsyncReport:
      type: object
      required:
        - uuid
        - report_type
        - report_type_display
        - status
        - status_display
        - parameters
        - requested_by_user_id
        - requested_by_email
        - requested_by_name
        - row_count
        - failed_item_ids
        - failed_count
        - file_size
        - files
        - scheduled_report
        - error_message
        - deletion_pending
        - eta_seconds
        - started_at
        - completed_at
        - expires_at
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          description: Identificador do relatório.
          format: uuid
        report_type:
          type: string
          description: Tipo de exportação ou de relatório de conformidade.
          enum:
            - SESSION_EXPORT
            - TRANSACTION_EXPORT
            - BUSINESS_EXPORT
            - VENDOR_USER_EXPORT
            - VENDOR_BUSINESS_EXPORT
            - CASE_EXPORT
            - CASE_SLA_EXPORT
            - LIST_ENTRY_EXPORT
            - EVENT_EXPORT
            - COMPLIANCE_KYC_KYB
            - COMPLIANCE_AML_LOG
            - COMPLIANCE_TRAVEL_RULE
            - COMPLIANCE_SANCTIONS_PEP
            - COMPLIANCE_RISK_SUMMARY
            - COMPLIANCE_SAR_STR_DRAFT
            - COMPLIANCE_CTR
            - COMPLIANCE_CASE_SUMMARY
        report_type_display:
          type: string
          description: Rótulo apresentado para o tipo de relatório.
        status:
          type: string
          description: >-
            Estado da geração. READY pode incluir falhas individuais; verifique
            failed_count.
          enum:
            - PENDING
            - PROCESSING
            - READY
            - FAILED
        status_display:
          type: string
          description: Rótulo apresentado para o estado da geração.
        parameters:
          type: object
          description: Opções originais da exportação; as chaves dependem de report_type.
          additionalProperties: true
        requested_by_user_id:
          type: string
          description: >-
            Identidade original do requerente, ou null para chamadores sem
            identidade de utilizador.
          format: uuid
          nullable: true
        requested_by_email:
          type: string
          description: E-mail do requerente, quando disponível.
          nullable: true
        requested_by_name:
          type: string
          description: Nome de apresentação do requerente, quando disponível.
          nullable: true
        row_count:
          type: integer
          description: Número de registos exportados, ou null antes da geração.
          nullable: true
        failed_item_ids:
          type: array
          description: >-
            UUIDs das sessões de produção que falharam nesta exportação de
            verificação. As sessões eliminadas são excluídas. Utilize estes IDs
            para uma nova tentativa seletiva.
          items:
            type: string
            format: uuid
        failed_count:
          type: integer
          description: Número de entradas em failed_item_ids.
          minimum: 0
        file_size:
          type: integer
          description: Tamanho total do ficheiro gerado em bytes, ou null antes da geração.
          format: int64
          nullable: true
        files:
          type: array
          description: Metadados do ficheiro gerado; não contém URLs de transferência.
          items:
            $ref: '#/components/schemas/AsyncReportFile'
        scheduled_report:
          type: string
          description: >-
            Identificador do agendamento, ou null para um relatório não
            agendado.
          format: uuid
          nullable: true
        error_message:
          type: string
          description: Erro de geração, quando disponível.
          nullable: true
        deletion_pending:
          type: boolean
          description: Indica se uma eliminação solicitada ainda está em curso.
        eta_seconds:
          type: integer
          description: >-
            Tempo estimado, em segundos, até à conclusão de um relatório
            pendente ou em processamento; nulo sem histórico ou quando
            concluído.
          nullable: true
        started_at:
          type: string
          description: Data e hora de início da geração.
          format: date-time
          nullable: true
        completed_at:
          type: string
          description: Data e hora de conclusão da geração.
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: Hora de expiração do relatório.
          format: date-time
        created_at:
          type: string
          description: Data e hora de criação.
          format: date-time
        updated_at:
          type: string
          description: Data e hora da última atualização.
          format: date-time
      example:
        uuid: 00000000-0000-4000-8000-000000000002
        report_type: SESSION_EXPORT
        report_type_display: Verifications
        status: READY
        status_display: Ready
        parameters: {}
        requested_by_user_id: null
        requested_by_email: null
        requested_by_name: null
        row_count: 9
        failed_item_ids:
          - 00000000-0000-4000-8000-000000000001
        failed_count: 1
        file_size: 1200
        files:
          - name: verifications.csv
            format: csv
            rows: 9
            bytes: 1200
        scheduled_report: null
        error_message: null
        deletion_pending: false
        eta_seconds: null
        started_at: '2026-11-11T01:00:00Z'
        completed_at: '2026-11-11T01:01:00Z'
        expires_at: '2026-12-11T01:00:00Z'
        created_at: '2026-11-11T01:00:00Z'
        updated_at: '2026-11-11T01:01:00Z'
    RateLimitBudgetError:
      type: object
      description: >-
        Devolvido apenas numa recusa de orçamento de limite de pedidos do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de cada endpoint, não garantem estes campos de
        metadados.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensagem de recusa por orçamento já existente, legível por humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referência de suporte opaca: RL- seguido de 32 caracteres
            hexadecimais de UUID em minúsculas.
        limit:
          type: integer
          description: Orçamento do âmbito excedido; igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Orçamento restante, limitado a zero; igual a X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reposição da janela em segundos Unix; é igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duração da janela fixa em segundos, não o tempo de espera restante.
            Respeite Retry-After antes de tentar novamente.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    AsyncReportFile:
      type: object
      required:
        - name
        - format
        - rows
        - bytes
      properties:
        name:
          type: string
          description: Nome do ficheiro.
        format:
          type: string
          description: Formato do ficheiro.
        rows:
          type: integer
          description: Registos exportados neste ficheiro, quando aplicável.
          nullable: true
        bytes:
          type: integer
          description: Tamanho do ficheiro em bytes.
          format: int64
  responses:
    RateLimitedRead:
      description: >-
        Orçamento de leitura do middleware excedido. Respeite Retry-After antes
        de tentar novamente.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos a aguardar, arredondados por excesso para a janela seguinte.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O âmbito cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do âmbito excedido; igual ao limite do corpo. Presente nas
        recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining do corpo.
        Presente nas recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Hora de reposição em segundos Unix; é igual a reset no corpo. Presente
        nas recusas de orçamento do middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, a partir de Programadores -> Chaves de
        API na Business Console. A chave principal tem acesso total. Uma chave
        nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por
        recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de
        endereços IP e a uma data de validade. 401 significa que a chave está
        incorreta, revogada ou expirada; 403 significa que nenhuma chave foi
        enviada, que a chave não tem acesso a este recurso ou ação, ou que o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs
        como nulos, e uma chave sem permissão de escrita em sessões recebe
        ligações de sessão e tokens como nulos. Consulte
        https://docs.didit.me/console/api-keys.
    BearerAuth:
      type: http
      scheme: bearer
      description: O token de acesso de credenciais de cliente da aplicação.

````

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