> ## 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 redes de fraude

> Liste as redes de fraude detectadas pelo Didit na sua organização, filtradas por status, sinal, padrão, faixa de risco, tamanho e data.



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



      
      

\<pre>

\`List fraud networks for my Didit application through the Management API.

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

Authentication:
Use the x-api-key header with my Didit API key.
Networks endpoints need a full-access API key: a key with restricted access gets 403.

Goal:
\- Retrieve the same clustered fraud networks the Console's Networks list shows: applicants, businesses, or transaction parties linked by shared device, IP, face, document number, phone, email, or address signals, within my own organization only.

Useful query params:
\- status=active,in_review,resolved,dismissed (comma-separated). Omit to exclude dismissed networks.
\- scope=identity|transactions: transactions keeps networks whose members are all transaction parties, identity keeps every other network. Omit for both. Any other value is a 400.
\- signal_type=ip_address,device,face,document_number,phone,email,address (comma-separated)
\- pattern_type=exact_same_device,similar_device,same_ip_address,same_address,similar_selfie_backgrounds,similar_poa_documents,same_document_number,same_phone_number,same_email (comma-separated)
\- risk_band=low,medium,high (comma-separated)
\- min_size, max_size - member count bounds
\- assignee=unassigned,<member email>,me (comma-separated, any value matches). me needs a console member token; an API key gets a 400.
\- priority=low,medium,high,none (comma-separated; none is a network without a priority). Any other value is a 400.
\- risk_min - minimum risk score, a whole number from 0 to 100. A value that is not a whole number is a 400.
\- has_case=true|false - networks your application opened a case for, or the others
\- date_from, date_to - ISO 8601 date/datetime bounds on activity
\- q - free-text search across network name, member names, and the network id (e.g. N-0001)
\- ordering=risk_score|-risk_score|last_activity_at|-last_activity_at|first_activity_at|-first_activity_at|network_number|-network_number (default -risk_score,-last_activity_at)
\- limit (1-500, default 100), offset
\- summary=true|false: false returns the page and its count only, without kpis and counts. Defaults to true. Any other value is a 400.

Example call:
curl -X GET "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/?status=active,in_review&ordering=-risk_score" \
-H "x-api-key: YOUR_API_KEY"

Response shape:
\{"count": int, "next": int|null, "previous": int|null, "results": [NetworkListItem, ...], "kpis": {...}, "counts": {...}, "sharing_mode": "off"|"private"|"global", "cross_org_available": bool, "cross_org_unavailable_reason": "plan"|"sharing_mode"|null}
next/previous are offsets, not URLs - null next means the last page.
Each NetworkListItem has uuid, network_id (e.g. "N-0001"), name, status (active|in_review|resolved|dismissed), risk {score, band, bar}, pattern_types, signal_types, member_counts, member_status, signal_coverage, first_activity_at, last_activity_at.
kpis carries active, in_review, applicants_involved, detected_this_period, false_positive_rate, each as {value, delta}, computed over the filtered result set.
counts carries scopes {all, identity, transactions}, views {all, active, in_review, resolved, dismissed, mine, high_risk} and facets {total, last_activity_days {"7", "30", "90"}, risk_min {"50", "80"}, signal_types {one count per signal type}, priority {low, medium, high, none}, assignee {me, unassigned, users: [{uuid, full_name, email, count}]}, has_case, min_size {"10"}}.
scopes count every network visible to this application; views count the visible networks inside the selected scope; facets count the networks in the selected scope and status view. The other filters do not change counts. mine and assignee.me are always 0 for an API key.
kpis and counts are omitted when summary=false.

Cross-organization fields (on every response, whatever summary says):
\- sharing_mode: the organization's cross-organization sharing mode. Only global compares networks across organizations; private and off keep them to the organization's own history.
\- cross_org_available: whether cross-organization signals apply to this organization. They need the Enterprise plan and the global sharing mode.
\- cross_org_unavailable_reason: plan (the organization's plan does not include the cross-organization fraud network; it needs the Enterprise plan, whatever the sharing mode), sharing_mode (the plan includes it, but sharing is private or off), or null when cross_org_available is true. plan is checked first.

Notes:
\- Sandbox applications never return networks - clustering excludes sandbox data entirely.
\- Networks are clustered organization-wide, but this endpoint only returns networks with at least one member visible to this application.

Failure modes:
\- 401: missing or invalid x-api-key. {"detail": "Authentication credentials were not provided or are invalid."}
\- 403: the API key belongs to another application, or it has restricted access (Networks needs a full-access key). A console member token needs list:networks. {"detail": "You do not have permission to perform this action."} or {"detail": "This API key has no access to this endpoint."}
\- 403 with code: Networks is not enabled for the organization. {"detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled"}
\- 400: an invalid filter, ordering, limit or offset, or summary that is not true or false. {"summary": ["Must be \\"true\\" or \\"false\\"."]}

Side effects: none, pure read.

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

\</pre>



      
      

Colar em

Liste as redes de fraude detectadas para sua organização.
Por padrão, a lista é ordenada pela pontuação de risco, da maior para a menor, e depois pela atividade mais recente.
Todos os filtros disponíveis na lista de Redes do Console são expostos como parâmetros de consulta, incluindo a busca de texto livre `q` e os mesmos chips de status, sinal, padrão e faixa de risco.
Os parâmetros `assignee`, `priority`, `risk_min` e `has_case` correspondem às opções de responsável, prioridade, risco mínimo e caso vinculado que `counts.facets` contabiliza.
`assignee=me` exige um token de membro do Console; com uma chave de API, retorna `400`.> [!NOTE]
>
> Aplicações de sandbox nunca têm redes. O agrupamento é executado apenas com dados de produção.## Modo de compartilhamento e sinais entre organizaçõesToda resposta inclui `sharing_mode`, `cross_org_available` e `cross_org_unavailable_reason` da sua organização.| Campo | Significado |
| - | - |
| `sharing_mode` | O modo de compartilhamento entre organizações da sua organização. Apenas `global` compara redes entre organizações; `private` e `off` as restringem ao próprio histórico da organização. |
| `cross_org_available` | Indica se os sinais entre organizações se aplicam à sua organização. Eles exigem o plano Enterprise e o modo de compartilhamento `global`. |
| `cross_org_unavailable_reason` | `plan` quando seu plano não inclui a rede de fraude entre organizações (ela exige o plano Enterprise), qualquer que seja seu modo de compartilhamento. `sharing_mode` quando o plano a inclui, mas seu modo de compartilhamento é `private` ou `off`. `null` quando `cross_org_available` é `true`. |O plano é verificado primeiro: abaixo do plano Enterprise, o motivo é `plan` mesmo quando seu modo de compartilhamento é `global`.## Contagens e o parâmetro summary`kpis` agregam as redes que correspondem aos seus filtros e `counts` agregam todas as redes que sua aplicação pode ver, por isso ambos custam mais do que a própria página.
Passe `summary=false` quando precisar apenas da página e do seu `count`: a resposta então omite `kpis` e `counts`.
`summary` aceita apenas `true` ou `false`; qualquer outro valor retorna `400`.`counts` contém os números por trás das visualizações e opções de filtro da lista, com cada rede contada uma única vez:| Chave | O que contabiliza |
| - | - |
| `scopes` | Todas as redes visíveis (`all`), divididas em `transactions` (todo membro é parte de uma transação) e `identity` (todas as outras redes). |
| `views` | Redes visíveis dentro do `scope` selecionado (`all`), por status (`active`, `in_review`, `resolved`, `dismissed`), atribuídas ao membro do console que chama (`mine`) e `high_risk` (pontuação de risco de 80 ou mais, não descartadas). |
| `facets` | Redes no `scope` e na visualização de `status` selecionados (`total`), por atividade recente (`last_activity_days`: 7, 30, 90), risco mínimo (`risk_min`: 50, 80), tipo de sinal, prioridade (incluindo `none`), responsável (`me`, `unassigned` e uma entrada por responsável em `users`), redes para as quais sua aplicação abriu um caso (`has_case`) e redes com pelo menos 10 membros (`min_size`). |Filtros diferentes de `scope` e `status` não alteram `counts`.
`views.mine` e `facets.assignee.me` são sempre `0` para uma chave de API, já que nenhum membro do console está chamando a API.## AcessoOs endpoints de Redes exigem uma [chave de API](https://docs.didit.me/pt-br/console/api-keys.md) com acesso total.
O uso de uma chave com acesso restrito resulta em `403`.
Um token de membro do console precisa de `list:networks`.
Quando Networks não está habilitado para sua organização, todos os endpoints de Redes retornam `403` com `"code": "networks_not_entitled"`.## Relacionados- [Obter rede](https://docs.didit.me/pt-br/management-api/networks/get.md)
- [Grafo da rede](https://docs.didit.me/pt-br/management-api/networks/graph.md)
- [Redes (Console)](https://docs.didit.me/pt-br/console/networks.md)


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/
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}/networks/:
    get:
      tags:
        - Networks
      summary: Listar redes
      description: >-
        Lista as redes de fraude detectadas na organização desta aplicação, com
        as de maior risco primeiro por padrão. Por padrão, as redes descartadas
        são excluídas; passe status para incluí-las. Aplicações de sandbox nunca
        têm redes: o agrupamento exclui totalmente os dados de sandbox. Toda
        resposta traz o `sharing_mode` da organização e informa se os sinais
        entre organizações se aplicam a ela (`cross_org_available`,
        `cross_org_unavailable_reason`). `kpis` agregam as redes que
        correspondem aos seus filtros e `counts` agregam todas as redes que a
        aplicação pode ver; passe `summary=false` para omitir ambos quando você
        precisar apenas da página. Requer uma chave de API com acesso total, ou
        `list:networks` para um membro do console.
      operationId: list_networks
      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: status
          in: query
          schema:
            type: string
          description: >-
            Status a incluir, separados por vírgula:
            active,in_review,resolved,dismissed. Omita para excluir dismissed.
        - name: scope
          in: query
          schema:
            type: string
            enum:
              - identity
              - transactions
          description: >-
            `transactions` mantém as redes cujos membros são todos partes de
            transações; `identity` mantém todas as outras redes. Omita para
            obter ambas. Também restringe `counts.views` e `counts.facets`.
            Qualquer outro valor retorna 400.
        - name: signal_type
          in: query
          schema:
            type: string
          description: >-
            Tipos de sinal separados por vírgula:
            ip_address,device,face,document_number,phone,email,address.
        - name: pattern_type
          in: query
          schema:
            type: string
          description: >-
            Tipos de padrão separados por vírgula, por exemplo,
            exact_same_device,same_email.
        - name: risk_band
          in: query
          schema:
            type: string
          description: 'Faixas separadas por vírgula: low,medium,high.'
        - name: min_size
          in: query
          schema:
            type: integer
          description: Quantidade mínima de membros.
        - name: max_size
          in: query
          schema:
            type: integer
          description: Número máximo de membros.
        - name: assignee
          in: query
          schema:
            type: string
          description: >-
            Responsáveis separados por vírgula: `unassigned`, e-mails de membros
            (comparados sem diferenciar maiúsculas de minúsculas) ou `me` para o
            membro do console que faz a chamada. Uma rede corresponde a qualquer
            valor. `me` exige um token de membro do console: uma chave de API
            recebe 400 `{"assignee": ["\"me\" needs a user token; an API key has
            no assignee identity."]}`.
        - name: priority
          in: query
          schema:
            type: string
          description: >-
            Prioridades separadas por vírgula: `low`, `medium`, `high` ou `none`
            para redes sem prioridade. Qualquer outro valor retorna 400
            `{"priority": "Unknown priority: <values>."}`.
        - name: risk_min
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 100
          description: >-
            Pontuação de risco mínima, um número inteiro de 0 a 100. Um valor
            que não seja um número inteiro retorna 400 `{"risk_min": "Use a
            whole number from 0 to 100."}`.
        - name: has_case
          in: query
          schema:
            type: boolean
          description: >-
            `true` mantém as redes para as quais sua aplicação abriu um caso, e
            `false`, as demais. Qualquer outro valor é ignorado.
        - name: date_from
          in: query
          schema:
            type: string
            format: date
          description: Limite inferior de last_activity_at (data ou data e hora ISO 8601).
        - name: date_to
          in: query
          schema:
            type: string
            format: date
          description: Limite superior de first_activity_at (data ou data e hora ISO 8601).
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Busca em texto livre por nome da rede, nomes dos membros, network_id
            (N-0001) e tokens exatos de pattern_type.
        - name: ordering
          in: query
          schema:
            type: string
          description: >-
            Um entre risk_score, -risk_score, last_activity_at,
            -last_activity_at, first_activity_at, -first_activity_at,
            network_number, -network_number. O padrão é
            -risk_score,-last_activity_at.
        - name: limit
          in: query
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Tamanho da página, de 1 a 500. O padrão é 100.
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Deslocamento, a partir de zero, do primeiro registro.
        - name: summary
          in: query
          schema:
            type: boolean
            default: true
          description: >-
            `false` retorna a página e seu `count` apenas, sem `kpis` e
            `counts`. O padrão é `true`. Qualquer valor diferente de `true` ou
            `false` retorna 400.
      responses:
        '200':
          description: >-
            Lista paginada de redes, com o modo de compartilhamento da
            organização e a disponibilidade entre organizações, além de `kpis` e
            `counts`, exceto quando `summary=false`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: integer
                    nullable: true
                    description: Offset da próxima página, ou null na última página.
                  previous:
                    type: integer
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/NetworkListItem'
                  kpis:
                    type: object
                    description: >-
                      Cada chave é {value, delta} sobre os resultados que
                      correspondem aos filtros atuais. Omitido quando
                      `summary=false`.
                    properties:
                      active:
                        type: object
                      in_review:
                        type: object
                      applicants_involved:
                        type: object
                      detected_this_period:
                        type: object
                      false_positive_rate:
                        type: object
                  counts:
                    $ref: '#/components/schemas/NetworkListCounts'
                  sharing_mode:
                    type: string
                    enum:
                      - 'off'
                      - private
                      - global
                    description: >-
                      O modo de compartilhamento entre organizações da
                      organização. Somente `global` compara redes entre
                      organizações; `private` e `off` as restringem ao histórico
                      da própria organização.
                    example: global
                  cross_org_available:
                    type: boolean
                    description: >-
                      Indica se os sinais entre organizações se aplicam a esta
                      organização. Eles exigem tanto o plano Enterprise quanto o
                      modo de compartilhamento `global`.
                    example: true
                  cross_org_unavailable_reason:
                    type: string
                    enum:
                      - plan
                      - sharing_mode
                    nullable: true
                    description: >-
                      Por que os sinais entre organizações não se aplicam,
                      verificados nesta ordem. `plan`: o plano da organização
                      não inclui a rede antifraude entre organizações (ela exige
                      o plano Enterprise), qualquer que seja o modo de
                      compartilhamento. `sharing_mode`: o plano a inclui, mas o
                      modo de compartilhamento é `private` ou `off`. Nulo quando
                      `cross_org_available` é `true`.
                    example: null
                required:
                  - count
                  - next
                  - previous
                  - results
                  - sharing_mode
                  - cross_org_available
                  - cross_org_unavailable_reason
        '400':
          description: Um valor inválido de filtro, ordenação, paginação ou `summary`.
          content:
            application/json:
              examples:
                Invalid summary:
                  summary: Resumo inválido
                  value:
                    summary:
                      - Must be "true" or "false".
                Invalid scope:
                  summary: Escopo inválido
                  value:
                    scope:
                      - Use identity or transactions.
                Unsupported ordering:
                  summary: Ordenação não suportada
                  value:
                    - Unsupported ordering.
        '401':
          description: Credenciais ausentes ou inválidas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros com código, por exemplo
                      `networks_not_entitled`.
              examples:
                Missing or invalid credentials:
                  summary: Credenciais ausentes ou inválidas
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
        '403':
          description: >-
            A chave de API pertence a outra aplicação ou é uma chave com acesso
            restrito: os endpoints de Networks exigem uma chave com acesso
            total. Um token de membro do console precisa de `list:networks`.
            Também é retornado com `code: networks_not_entitled` quando o
            Networks não está habilitado para a organização.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros com código, por exemplo
                      `networks_not_entitled`.
              examples:
                Networks not enabled:
                  summary: Redes não habilitadas
                  value:
                    detail: >-
                      Networks is disabled for this organization. Contact Didit
                      support if you believe this is an error.
                    code: networks_not_entitled
                Restricted API key:
                  summary: Chave de API restrita
                  value:
                    detail: This API key has no access to this endpoint.
                No permission:
                  summary: Sem permissão
                  value:
                    detail: You do not have permission to perform this action.
      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/networks/?status=active,in_review&ordering=-risk_score'
            \
              -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.networks.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.networks.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.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})\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.networks().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->networks->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.networks.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.Networks.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    NetworkListItem:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        network_id:
          type: string
          description: ID sequencial legível por organização, por exemplo N-0001.
        name:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - active
            - in_review
            - resolved
            - dismissed
          description: >-
            Status do ciclo de vida da rede. Diferente do outcome_status por
            candidato dentro de uma rede
            (approved/in_review/declined/not_completed).
        risk:
          $ref: '#/components/schemas/NetworkRiskDisplay'
        pattern_types:
          type: array
          items:
            type: string
            enum:
              - exact_same_device
              - similar_device
              - same_ip_address
              - same_address
              - similar_selfie_backgrounds
              - similar_poa_documents
              - same_document_number
              - same_phone_number
              - same_email
          description: Os padrões de agrupamento detectados nesta rede.
        signal_types:
          type: array
          items:
            type: string
            enum:
              - ip_address
              - device
              - face
              - document_number
              - phone
              - email
              - address
          description: Os tipos de sinal distintos presentes nesta rede.
        member_counts:
          type: object
          description: >-
            Contagens de membros por categoria (por exemplo, total, por
            outcome_status).
        member_status:
          type: object
          description: Distribuição dos membros por outcome_status.
        signal_coverage:
          type: object
          description: Cobertura por signal_type dos membros desta rede.
        first_activity_at:
          type: string
          format: date-time
          nullable: true
        last_activity_at:
          type: string
          format: date-time
          nullable: true
    NetworkListCounts:
      type: object
      description: >-
        Contagens de redes para as visualizações e opções de filtro da lista,
        com cada rede contada uma única vez. Retornado somente quando `summary`
        não é `false`. `scopes` contam todas as redes visíveis para a aplicação.
        `views` contam as redes visíveis dentro do `scope` selecionado. `facets`
        contam as redes no `scope` e na visualização de `status` selecionados
        (redes descartadas ficam de fora, a menos que `status` as inclua). Os
        demais filtros da lista não alteram essas contagens.
      properties:
        scopes:
          type: object
          description: Redes visíveis por produto.
          properties:
            all:
              type: integer
            identity:
              type: integer
              description: Todas as outras redes.
            transactions:
              type: integer
              description: Redes cujos membros são todos partes de transações.
        views:
          type: object
          description: >-
            Redes visíveis dentro do `scope` selecionado, por status, além de
            duas visualizações salvas.
          properties:
            all:
              type: integer
            active:
              type: integer
            in_review:
              type: integer
            resolved:
              type: integer
            dismissed:
              type: integer
            mine:
              type: integer
              description: >-
                Redes atribuídas ao membro do console que fez a chamada. Sempre
                0 para uma chave de API.
            high_risk:
              type: integer
              description: >-
                Redes com pontuação de risco de 80 ou mais que não foram
                descartadas.
        facets:
          type: object
          description: >-
            Contagens de cada opção de filtro, dentro do `scope` selecionado e
            da visualização de status.
          properties:
            total:
              type: integer
              description: Redes no `scope` e na visualização de status selecionados.
            last_activity_days:
              type: object
              description: >-
                Redes com atividade nos últimos 7, 30 e 90 dias, indexadas pelo
                número de dias.
              properties:
                '7':
                  type: integer
                '30':
                  type: integer
                '90':
                  type: integer
            risk_min:
              type: object
              description: >-
                Redes com pontuação de risco de pelo menos 50 e de pelo menos
                80, indexadas pelo limiar.
              properties:
                '50':
                  type: integer
                '80':
                  type: integer
            signal_types:
              type: object
              description: Redes com pelo menos um sinal de cada tipo.
              properties:
                ip_address:
                  type: integer
                device:
                  type: integer
                face:
                  type: integer
                document_number:
                  type: integer
                phone:
                  type: integer
                email:
                  type: integer
                address:
                  type: integer
            priority:
              type: object
              description: Redes por prioridade. `none` conta as redes sem prioridade.
              properties:
                low:
                  type: integer
                medium:
                  type: integer
                high:
                  type: integer
                none:
                  type: integer
            assignee:
              type: object
              description: Redes por responsável.
              properties:
                me:
                  type: integer
                  description: >-
                    Atribuído ao membro do console que fez a chamada. Sempre 0
                    para uma chave de API.
                unassigned:
                  type: integer
                  description: Não atribuído a ninguém.
                users:
                  type: array
                  description: >-
                    Uma entrada por responsável, do que tem mais redes para o
                    que tem menos.
                  items:
                    type: object
                    properties:
                      uuid:
                        type: string
                        format: uuid
                      full_name:
                        type: string
                        description: >-
                          O nome do responsável, ou o e-mail quando nenhum nome
                          está definido.
                      email:
                        type: string
                      count:
                        type: integer
            has_case:
              type: integer
              description: Redes para as quais esta aplicação abriu um caso.
            min_size:
              type: object
              description: Redes com pelo menos 10 membros, indexadas pelo tamanho mínimo.
              properties:
                '10':
                  type: integer
    NetworkRiskDisplay:
      type: object
      properties:
        score:
          type: integer
          description: Pontuação de risco, de 0 a 100.
        band:
          type: string
          enum:
            - low
            - medium
            - high
          description: >-
            Faixa em que a pontuação é exibida. high >= 70, medium >= 40, caso
            contrário low.
        bar:
          type: number
          format: float
          description: Valor normalizado de 0 a 1 para renderizar uma barra de risco.
  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.