> ## 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.

# API para listar relatórios à UIF

> Use o endpoint da API da Didit para listar os relatórios regulatórios de toda a aplicação, com filtro por status, tipo de relatório e caso.



Prompt da API de listagem de relatórios
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`List FIU reports across the application through the Management API.

Endpoint:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/

Authentication:
Use the x-api-key header with my Didit API key.

Query params:
\- limit (default 50), offset (default 0)
\- status=DRAFT|VALIDATED|FINALIZED
\- report_type=SAR|STR|CTR|TTR|UTR|IFT|CBR|TFR
\- case=<case-uuid>

Example call:
curl -X GET "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/?status=DRAFT" \
-H "x-api-key: YOUR_API_KEY"

Response 200: {"count", "next", "previous", "results": [RegulatoryReportDetail, ...]}

Failure modes:
\- 401/403 - auth/permission errors (requires read:cases).

Side effects: none, pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Colar em

Lista os relatórios de toda a aplicação, com os mesmos dados da página independente Reports do Console. Este é o endpoint a ser consultado periodicamente para obter a fila de relatórios em DRAFT que aguardam validação e finalização.## Conteúdo relacionado- [Criar relatório independente](https://docs.didit.me/pt-br/management-api/regulatory-reports/create-for-case.md)
- [Validar relatório](https://docs.didit.me/pt-br/management-api/regulatory-reports/validate.md)
- [Finalizar relatório](https://docs.didit.me/pt-br/management-api/regulatory-reports/finalize.md)
- [Baixar relatório](https://docs.didit.me/pt-br/management-api/regulatory-reports/download-url.md)
- [Excluir relatório](https://docs.didit.me/pt-br/management-api/regulatory-reports/delete.md)


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/regulatory-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}/regulatory-reports/:
    get:
      tags:
        - Regulatory Reports
      summary: Listar relatórios
      description: >-
        Lista de relatórios para a FIU de toda a aplicação, com filtro opcional
        por status, report_type ou caso.
      operationId: list_regulatory_reports
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID da organização.
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID da aplicação.
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
          description: Tamanho da página.
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Deslocamento a partir de zero.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - DRAFT
              - VALIDATED
              - FINALIZED
          description: Filtra por status.
        - name: report_type
          in: query
          schema:
            type: string
            enum:
              - SAR
              - STR
              - CTR
              - TTR
              - UTR
              - IFT
              - CBR
              - TFR
          description: Filtrar por tipo de relatório.
        - name: case
          in: query
          schema:
            type: string
            format: uuid
          description: Filtra os relatórios deste caso.
      responses:
        '200':
          description: Relatórios paginados de toda a aplicação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatoryReportList'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - 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.regulatory_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.regulatoryReports.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.RegulatoryReports.ListAutoPaging(ctx, didit.RegulatoryReportsListParams{})\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.regulatoryReports().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->regulatoryReports->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.regulatory_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.RegulatoryReports.ListAsync())

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    RegulatoryReportList:
      type: object
      properties:
        count:
          type: integer
          description: Número de linhas correspondentes, limitado a 100 por desempenho.
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/RegulatoryReportDetail'
    RegulatoryReportDetail:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        case_uuid:
          type: string
          format: uuid
        case_number:
          type: string
          nullable: true
        report_type:
          type: string
          enum:
            - SAR
            - STR
            - CTR
            - TTR
            - UTR
            - IFT
            - CBR
            - TFR
        report_type_display:
          type: string
        report_code:
          type: string
          description: >-
            Código de relatório goAML derivado de report_type, por exemplo STR,
            CTR, BCR.
        report_number:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - DRAFT
            - VALIDATED
            - FINALIZED
        status_display:
          type: string
        jurisdiction:
          type: string
          minLength: 2
          maxLength: 2
        rentity_id:
          type: string
          nullable: true
          description: ID da entidade declarante emitido pela FIU.
        rentity_branch:
          type: string
          nullable: true
        submission_code:
          type: string
          enum:
            - E
            - M
        entity_reference:
          type: string
          nullable: true
        fiu_ref_number:
          type: string
          nullable: true
        currency_code_local:
          type: string
          minLength: 3
          maxLength: 3
          nullable: true
        submission_date:
          type: string
          format: date-time
          nullable: true
        reporting_person:
          type: object
        location:
          type: object
        reason:
          type: string
          nullable: true
        action:
          type: string
          nullable: true
        activity:
          type: string
          nullable: true
        narrative:
          type: object
          description: Seções narrativas no formato dos cinco Ws.
          properties:
            who:
              type: string
            what:
              type: string
            when:
              type: string
            where:
              type: string
            why:
              type: string
            how:
              type: string
        report_indicators:
          type: array
          items:
            type: string
        included_fields:
          type: array
          items:
            type: string
        transactions:
          type: array
          items:
            type: string
            format: uuid
        validation_errors:
          type: array
          description: >-
            Resultado da validação mais recente; cada entrada é um objeto
            {field, message}.
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        validated_at:
          type: string
          format: date-time
          nullable: true
        finalized_at:
          type: string
          format: date-time
          nullable: true
        created_by_email:
          type: string
          nullable: true
        created_by_name:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

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