> ## 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 casos de conformidade

> Liste casos de conformidade na Didit por status, prioridade, origem, blueprint, responsável, tag e prazo, com busca em assunto, tag e entidades.



Prompt da API para listar casos
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`List compliance cases for my Didit application through the Management API.

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

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

Goal:
\- Retrieve cases with the same filtering the Console's Cases list offers: status, priority, source, blueprint, assignee, tag, created-date range, due-before, and overdue. Paginated with limit/offset.

Useful query params:
\- status__in=OPEN,AWAITING_USER,RESOLVED (comma-separated)
\- priority=LOW,MEDIUM,HIGH (comma-separated)
\- source__in=MANUAL,AML_SCREENING,TRANSACTION_RULE,WORKFLOW_BUILDER
\- blueprint=<uuid>, assigned_to=<uuid>, unassigned=true|false, tag=<string>
\- search=<string> - matches title, case_number, tag, subject name/UUID/external ID, linked session UUID, linked transaction UUID
\- date_from=YYYY-MM-DD, date_to=YYYY-MM-DD (created_at range), due_before=<ISO datetime>, overdue=true
\- ordering=created_at|-created_at|due_at|-due_at (default -created_at)

Example call:
curl -X GET "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/?status__in=OPEN,AWAITING_USER&ordering=-due_at" \
-H "x-api-key: YOUR_API_KEY"

Response shape:
\{"count": int, "next": url|null, "previous": url|null, "results": [CaseListItem, ...]}
count is exact up to 100 and capped at 100 beyond that for performance - rely on next being null to detect the last page, never on count.
Each CaseListItem has uuid, case_number, title, status, resolution, pending_resolution (set only while a 4-eyes resolution is staged), checker {member_uuid, name, email}, priority, source, tags, subject {type, uuid, name, external_id, country, portrait}, assigned_to {uuid, full_name, email}, team {uuid, name}, blueprint {uuid, name}, links_count, notes_count, due_at, resolved_at, created_at, updated_at.
\- subject.country - ISO 3166-1 alpha-3 code, or null when unknown. A business: its country of incorporation. A person: the issuing country of one of their identity documents.
\- subject.portrait - short-lived signed URL of the person's portrait, or null. Always null for a business. Download the image when you read it; do not store the URL.
\- team - the review team that owns the case, or null.
\- checker - the member named to approve a pending four-eyes resolution, or null. Set only while a resolution waits on a named checker; name is null when unknown.

Failure modes:
\- 401 - missing or malformed x-api-key.
\- 403 - a key with restricted access gets {"detail": "This API key has no access to this endpoint."} (cases need a full-access key). A console member token needs list:cases.

Side effects: none, pure read.

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

\</pre>



      
      

Colar em

Liste os casos da aplicação, do mais recente para o mais antigo por padrão. Todos os filtros e opções de ordenação disponíveis na lista de casos do Console são expostos como parâmetros de consulta, incluindo a busca de texto completo `search` no titular, nas tags, no número do caso e nos IDs de sessão ou de transação vinculados.
Cada caso também traz a equipe responsável (`team`), o `checker` designado para uma resolução pendente que requer dupla verificação (four-eyes) e o `country` e o `portrait` do titular.## AcessoOs endpoints de casos exigem uma [chave de API](https://docs.didit.me/pt-br/console/api-keys.md) com acesso completo.
Uma chave com acesso restrito retorna `403`.## Conteúdo relacionado- [Criar caso](https://docs.didit.me/pt-br/management-api/cases/create.md)
- [Atualizar caso](https://docs.didit.me/pt-br/management-api/cases/update.md)
- [Análises de casos](https://docs.didit.me/pt-br/management-api/cases/statistics.md)
- [Casos (Console)](https://docs.didit.me/pt-br/console/case-management/cases.md)


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/
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}/cases/:
    get:
      tags:
        - Cases
      summary: Listar casos
      description: >-
        Lista os casos da aplicação, do mais recente para o mais antigo. Aceita
        filtragem, busca e ordenação; consulte os parâmetros de consulta.
        Paginado com `limit`/`offset`.
      operationId: list_cases
      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. O padrão é 50.
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Deslocamento, a partir de zero, do primeiro registro.
        - name: status__in
          in: query
          schema:
            type: string
          description: >-
            Status a incluir, separados por vírgula, por exemplo,
            OPEN,AWAITING_USER.
        - name: priority
          in: query
          schema:
            type: string
          description: Prioridades a incluir, separadas por vírgula.
        - name: source__in
          in: query
          schema:
            type: string
          description: Origens a incluir, separadas por vírgula.
        - name: blueprint
          in: query
          schema:
            type: string
            format: uuid
          description: Filtra os casos deste blueprint.
        - name: assigned_to
          in: query
          schema:
            type: string
            format: uuid
          description: Filtra os casos atribuídos a este usuário.
        - name: unassigned
          in: query
          schema:
            type: boolean
          description: true para casos não atribuídos, false para casos atribuídos.
        - name: tag
          in: query
          schema:
            type: string
          description: Filtra os casos que têm exatamente esta tag.
        - name: search
          in: query
          schema:
            type: string
          description: >-
            Corresponde a title, case_number, tag, nome/UUID/ID externo do
            titular, UUID da sessão vinculada ou UUID da transação vinculada.
        - name: date_from
          in: query
          schema:
            type: string
            format: date
          description: Limite inferior da data de criação (inclusivo).
        - name: date_to
          in: query
          schema:
            type: string
            format: date
          description: Limite superior da data de criação (inclusivo).
        - name: due_before
          in: query
          schema:
            type: string
            format: date-time
          description: Limite superior de due_at.
        - name: overdue
          in: query
          schema:
            type: boolean
          description: true para retornar apenas casos open/awaiting-user em atraso.
        - name: ordering
          in: query
          schema:
            type: string
            enum:
              - created_at
              - '-created_at'
              - due_at
              - '-due_at'
            default: '-created_at'
          description: Ordem de classificação. due_at coloca os valores nulos por último.
      responses:
        '200':
          description: Lista paginada de casos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Número de linhas correspondentes. Exato até 100 e limitado
                      a 100 acima disso, por desempenho. Considere `next` nulo
                      para detectar a última página.
                  next:
                    type: string
                    nullable: true
                    description: URL absoluta da próxima página, ou null.
                  previous:
                    type: string
                    nullable: true
                    description: URL absoluta da página anterior, ou null.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/CaseListItem'
      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/cases/?status__in=OPEN,AWAITING_USER&ordering=-due_at'
            \
              -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.cases.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.cases.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.Cases.ListAutoPaging(ctx, didit.CasesListParams{})\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.cases().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->cases->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.cases.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.Cases.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    CaseListItem:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        case_number:
          type: string
          nullable: true
          description: Atribuído automaticamente, por exemplo, CS-0001.
        title:
          type: string
        status:
          type: string
          enum:
            - OPEN
            - AWAITING_USER
            - RESOLVED
        resolution:
          type: string
          enum:
            - FALSE_POSITIVE
            - VALID_THREAT
            - INCONCLUSIVE
            - REQUIREMENTS_NOT_MET
            - REQUIREMENTS_SATISFIED
          nullable: true
        pending_resolution:
          type: object
          nullable: true
          description: >-
            Definido apenas enquanto uma resolução com aprovação em duas etapas
            (4-eyes) está preparada no blueprint do verificador, aguardando
            aprovação ou rejeição da aprovação.
          properties:
            resolution:
              type: string
              enum:
                - FALSE_POSITIVE
                - VALID_THREAT
                - INCONCLUSIVE
                - REQUIREMENTS_NOT_MET
                - REQUIREMENTS_SATISFIED
            resolution_notes:
              type: string
              nullable: true
            maker_email:
              type: string
              format: email
              nullable: true
              description: >-
                E-mail do responsável que enviou a resolução. Null quando uma
                chave de API a enviou: essa resolução não tem autor registrado,
                portanto approve e reject-approval retornam 403 para qualquer
                chamador.
            maker_name:
              type: string
              nullable: true
            maker_user_id:
              type: string
              format: uuid
              nullable: true
              description: >-
                UUID de usuário membro do responsável que enviou a resolução.
                Null quando uma chave de API a enviou. Esse membro não pode ser
                indicado como `checker`.
            maker_blueprint_id:
              type: string
              format: uuid
            staged_at:
              type: string
              format: date-time
        checker:
          $ref: '#/components/schemas/CaseChecker'
        priority:
          type: string
          enum:
            - LOW
            - MEDIUM
            - HIGH
        source:
          type: string
          enum:
            - MANUAL
            - AML_SCREENING
            - TRANSACTION_RULE
            - WORKFLOW_BUILDER
        tags:
          type: array
          items:
            type: string
        subject:
          $ref: '#/components/schemas/CaseSubject'
        assigned_to:
          $ref: '#/components/schemas/CaseAssignee'
        assigned_at:
          type: string
          format: date-time
          nullable: true
        team:
          $ref: '#/components/schemas/CaseTeamSummary'
        due_at:
          type: string
          format: date-time
          nullable: true
        resolved_at:
          type: string
          format: date-time
          nullable: true
        created_by_email:
          type: string
          nullable: true
        created_by_name:
          type: string
          nullable: true
        blueprint:
          $ref: '#/components/schemas/CaseBlueprintSummary'
        links_count:
          type: integer
        notes_count:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        application_id:
          type: string
          format: uuid
        application_name:
          type: string
        organization_id:
          type: string
          format: uuid
        organization_name:
          type: string
    CaseChecker:
      type: object
      nullable: true
      description: >-
        O membro designado para aprovar ou rejeitar a resolução pendente.
        Definido apenas enquanto uma resolução de quatro olhos aguarda um
        verificador designado. Nulo quando não há nada pendente, enquanto a
        resolução pendente aguarda na fila de verificadores e depois que a
        resolução é aprovada, rejeitada ou devolvida para uma nova revisão
        porque as evidências mudaram.
      properties:
        member_uuid:
          type: string
          format: uuid
          description: >-
            O uuid de usuário do membro: o valor que você passa como `checker`
            ao resolver o caso.
        name:
          type: string
          nullable: true
          description: O nome completo do membro, ou nulo quando não é conhecido.
        email:
          type: string
          format: email
    CaseSubject:
      type: object
      nullable: true
      description: O único usuário ou empresa ao qual o caso está vinculado.
      properties:
        type:
          type: string
          enum:
            - user
            - business
        uuid:
          type: string
          format: uuid
        name:
          type: string
        external_id:
          type: string
          nullable: true
          description: O vendor_data do titular.
        country:
          type: string
          nullable: true
          description: >-
            Código de país de três letras do titular (ISO 3166-1 alpha-3), ou
            null quando não é conhecido. Para uma empresa, o país de
            constituição. Para uma pessoa, o país emissor de um documento de
            identidade de suas verificações; uma pessoa com documentos de vários
            países mostra um deles, e códigos de documento da ICAO como `XXA`
            podem aparecer.
          example: ESP
        portrait:
          type: string
          format: uri
          nullable: true
          description: >-
            URL assinada de curta duração da imagem do retrato da pessoa. Sempre
            null para uma empresa e null para uma pessoa sem retrato. A URL
            expira, portanto baixe a imagem ao ler o caso em vez de armazenar a
            URL.
    CaseAssignee:
      type: object
      nullable: true
      properties:
        uuid:
          type: string
          format: uuid
        full_name:
          type: string
        email:
          type: string
          format: email
    CaseTeamSummary:
      type: object
      nullable: true
      description: >-
        A equipe de revisão responsável pelo caso, ou null quando nenhuma equipe
        é responsável por ele. O roteamento o define quando uma regra de
        roteamento atribui o caso a uma de suas equipes. Altere ou remova com
        `PATCH .../cases/{case_uuid}/` (`team`).
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
    CaseBlueprintSummary:
      type: object
      nullable: true
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 24
  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.