> ## 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 obter rede de fraude

> Veja uma rede de fraude no Didit: estatísticas, tags, sinais de risco, resultados de membros, padrão de fundo de selfie e acesso entre organizações.



Prompt da API para obter rede
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Retrieve a single fraud network's full detail through the Management API.

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

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.

Path parameter:
\- network_uuid - the network's UUID, from list networks.

Response 200: NetworkDetailResponse. Everything in the list-item shape (uuid, network_id, name, status, risk, pattern_types, signal_types, member_counts, member_status, signal_coverage, first_activity_at, last_activity_at), plus stats, fraud_tags, risk_signals (residential_proxy_reuse, email_intelligence, phone_intelligence summaries), reviewed_at, reviewed_by, review_reason, notes_count, and:
\- sharing_mode, cross_org_available, cross_org_unavailable_reason: the same fields as on list networks. sharing_mode is off|private|global (only global compares networks across organizations). cross_org_available is true only with the Enterprise plan and global sharing. cross_org_unavailable_reason is plan (checked first), sharing_mode, or null when available.
\- tags: my application's tags on the network, oldest first. Each is {uuid, name, color, source (didit|custom), added_by (the console member's email, or null when an API key added it), added_at}. Each application sees only its own tags. fraud_tags is separate and unchanged: the tags the network's members carry.
\- outcomes: {approved, declined, in_review, total}. Each member I may see counts once, by the status of their most recent verification that reached a decision. total counts members with at least one verification; a member whose verifications are all undecided counts only in total. Transaction parties are not counted.
\- patterns: [{type: "background", score, members, reason, computed_at}]. score is 0 to 1 with 4 decimals: the mean similarity of every pair of member selfie backgrounds, the person masked out. It reads the newest selfie of each person (at most the 50 newest, age assurance sessions excluded) across the whole network, not only my applications.
\- reason "computing": score, members and computed_at are null; read the network again later.
\- reason "not_enough_selfies": fewer than two members have a usable selfie; score is null and members is 0 or 1.
\- reason null: score is set, members is how many selfies were compared, computed_at is when.

Failure modes:
\- 404: {"detail": "Network not found."}. The network does not exist, or has no member visible to this application.
\- 401: missing or invalid x-api-key.
\- 403: the API key belongs to another application, or it has restricted access (Networks needs a full-access key). A console member token needs read:networks.
\- 403 with {"code": "networks_not_entitled"}: Networks is not enabled for the organization.

Side effects: the network does not change. A read that finds no current background score schedules its computation.

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

\</pre>



      
      

Colar em

Obtenha uma rede com tudo o que é necessário para renderizar o painel de visão geral de uma rede: a distribuição do risco, as tags de fraude detectadas e os resumos de sinais de risco, além dos campos compartilhados com a listagem.
Os detalhes também incluem as tags da sua aplicação na rede, o status das verificações dos membros e o grau de semelhança entre os fundos das selfies deles.## Tags`tags` lista as tags da sua aplicação na rede, da mais antiga para a mais recente.
Cada aplicação vê e altera apenas as próprias tags.
`added_by` é o e-mail do membro do painel que adicionou a tag, ou `null` quando ela foi adicionada por uma chave de API.
Use [Adicionar tag de rede](https://docs.didit.me/pt-br/management-api/networks/add-tag.md) e [Remover tag de rede](https://docs.didit.me/pt-br/management-api/networks/remove-tag.md) para alterá-las.
`fraud_tags` não muda: lista as tags que os membros da rede têm.## Resultados dos membros`outcomes` conta as pessoas e empresas da rede que você tem permissão para ver, cada uma contada uma única vez.| Chave | O que conta |
| - | - |
| `approved` | Membros cuja verificação decidida mais recente foi aprovada |
| `declined` | Membros cuja verificação decidida mais recente foi recusada |
| `in_review` | Membros cuja verificação decidida mais recente está em revisão |
| `total` | Membros com pelo menos uma verificação, decidida ou não |Um membro recusado e depois aprovado em uma nova tentativa conta como `approved`.
Um membro cujas verificações estão todas sem decisão (não iniciadas, em andamento, expiradas ou abandonadas) conta apenas em `total`.
As partes envolvidas em transações não passam por nenhuma verificação e não são contadas.## Padrão de fundo das selfies`patterns` contém hoje um único item, com `type` definido como `background`.
O `score` dele, de 0 a 1, é a similaridade média entre todos os pares de fundos das selfies dos membros, com a pessoa ocultada.
Uma pontuação próxima de 1 sugere que as selfies foram tiradas no mesmo lugar.
Paredes lisas de cor parecida também podem ter pontuação alta, então trate a pontuação como evidência para revisão, não como prova.
A pontuação considera a selfie mais recente de cada pessoa, no máximo as 50 mais recentes, e exclui as sessões de verificação de idade.
Ela abrange a rede inteira, não apenas os membros das suas aplicações.| `reason` | `score` | `members` | O que fazer |
| - | - | - | - |
| `null` | 0 a 1 | Selfies comparadas | Use a pontuação. `computed_at` informa quando ela foi calculada. |
| `computing` | `null` | `null` | A pontuação dos membros atuais está sendo calculada. Consulte a rede novamente mais tarde. |
| `not_enough_selfies` | `null` | `0` ou `1` | Menos de dois membros têm uma selfie utilizável. |Uma selfie que não pode ser lida, ou que mostra pouco fundo, não é comparada, então `members` pode ser menor que o número de pessoas na rede.
A pontuação sempre descreve as selfies atuais dos membros.
Quando elas mudam, por exemplo quando um membro entra ou sai, o detalhe informa `computing` até que a nova pontuação esteja pronta, ou `not_enough_selfies` quando restam menos de dois.## Disponibilidade entre organizaçõesOs detalhes trazem os mesmos `sharing_mode`, `cross_org_available` e `cross_org_unavailable_reason` que [listar redes](https://docs.didit.me/pt-br/management-api/networks/list.md#modo-de-compartilhamento-e-sinais-entre-organizações).
Os sinais entre organizações exigem o plano Enterprise e o modo de compartilhamento `global`.## Conteúdos relacionados- [Listar redes](https://docs.didit.me/pt-br/management-api/networks/list.md)
- [Adicionar tag de rede](https://docs.didit.me/pt-br/management-api/networks/add-tag.md)
- [Remover tag de rede](https://docs.didit.me/pt-br/management-api/networks/remove-tag.md)
- [Membros da rede](https://docs.didit.me/pt-br/management-api/networks/members.md)
- [Grafo da rede](https://docs.didit.me/pt-br/management-api/networks/graph.md)


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/
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/{network_uuid}/:
    get:
      tags:
        - Networks
      summary: Obter rede
      description: >-
        Obtenha o detalhe completo de uma única rede: estatísticas, tags de
        fraude e sinais de risco, além do `sharing_mode` da organização e da
        disponibilidade entre organizações, as `tags` da sua aplicação na rede,
        os `outcomes` dos membros e as pontuações de padrões (`patterns`).
        Requer uma chave de API com acesso total, ou `read:networks` para um
        membro do console.
      operationId: get_network
      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: network_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: n3a5e000-0000-4000-8000-000000000001
          description: UUID da rede.
      responses:
        '200':
          description: Detalhes da rede.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkDetailResponse'
              example:
                uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                network_id: N-0042
                name: null
                status: in_review
                risk:
                  score: 82
                  band: high
                  bar: 0.82
                pattern_types:
                  - exact_same_device
                  - same_email
                signal_types:
                  - device
                  - email
                member_counts:
                  total: 3
                  users: 3
                  businesses: 0
                  transaction_parties: 0
                member_status:
                  approved: 1
                  declined: 1
                  in_review: 0
                  not_completed: 1
                signal_coverage:
                  device:
                    signals: 1
                    subjects: 3
                    coverage: 1
                  email:
                    signals: 1
                    subjects: 2
                    coverage: 0.6667
                first_activity_at: '2026-10-01T09:12:44Z'
                last_activity_at: '2026-10-12T16:03:10Z'
                stats:
                  members:
                    total: 3
                    users: 3
                    businesses: 0
                    transaction_parties: 0
                  member_status:
                    approved: 1
                    declined: 1
                    in_review: 0
                    not_completed: 1
                  signals:
                    total: 2
                    by_type:
                      device:
                        signals: 1
                        subjects: 3
                        coverage: 1
                      email:
                        signals: 1
                        subjects: 2
                        coverage: 0.6667
                fraud_tags: []
                risk_signals:
                  residential_proxy_reuse:
                    detected: false
                    signal_count: 0
                    max_subject_count: 0
                  email_intelligence:
                    enriched_signal_count: 1
                    high_risk_count: 0
                    social_profile_count: 0
                  phone_intelligence:
                    enriched_signal_count: 0
                    high_risk_count: 0
                reviewed_at: '2026-10-12T16:30:00Z'
                reviewed_by: reviewer@example.com
                review_reason: Shared device across three new accounts.
                notes_count: 0
                sharing_mode: global
                cross_org_available: true
                cross_org_unavailable_reason: null
                tags:
                  - uuid: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    name: SUSPICIOUS
                    color: '#6366F1'
                    source: custom
                    added_by: null
                    added_at: '2026-10-13T08:15:00Z'
                outcomes:
                  approved: 1
                  declined: 1
                  in_review: 0
                  total: 3
                patterns:
                  - type: background
                    score: 0.8125
                    members: 3
                    reason: null
                    computed_at: '2026-10-13T08:00:00Z'
        '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 `read: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.
        '404':
          description: Rede não encontrada (ou não visível para esta aplicação).
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
      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/n3a5e000-0000-4000-8000-000000000001/'
            \
              -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()

            result = client.networks.retrieve(
                "n3a5e000-0000-4000-8000-000000000001",
            )
            print(result)
        - 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();


            const result = await
            didit.networks.retrieve("n3a5e000-0000-4000-8000-000000000001");

            console.log(result);
        - 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\nresult, err := client.Networks.Retrieve(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            Didit client = new Didit();


            var result =
            client.networks().retrieve("n3a5e000-0000-4000-8000-000000000001");

            System.out.println(result);
        - 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();


            $result =
            $didit->networks->retrieve('n3a5e000-0000-4000-8000-000000000001');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            # and DIDIT_APPLICATION_ID.

            didit = Didit::Client.new


            result =
            didit.networks.retrieve("n3a5e000-0000-4000-8000-000000000001")

            puts result.to_h
        - 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();


            var result = await
            client.Networks.RetrieveAsync("n3a5e000-0000-4000-8000-000000000001");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    NetworkDetailResponse:
      description: >-
        Os detalhes da rede, além do modo de compartilhamento da organização, se
        os sinais entre organizações se aplicam a ela, as tags da sua aplicação
        na rede, os resultados dos membros e as pontuações de padrões.
      allOf:
        - $ref: '#/components/schemas/NetworkDetail'
        - type: object
          properties:
            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
            tags:
              type: array
              items:
                $ref: '#/components/schemas/NetworkTag'
              description: >-
                As tags da sua aplicação na rede, das mais antigas para as mais
                recentes. Cada aplicação vê apenas as próprias tags.
                `fraud_tags` é separado e não muda: as tags que os membros da
                rede carregam.
            outcomes:
              $ref: '#/components/schemas/NetworkOutcomes'
            patterns:
              type: array
              items:
                $ref: '#/components/schemas/NetworkPatternScore'
              description: >-
                Pontuações de padrões em toda a rede. Atualmente, um item,
                `background`.
    NetworkDetail:
      allOf:
        - $ref: '#/components/schemas/NetworkListItem'
        - type: object
          properties:
            stats:
              type: object
              description: Estatísticas agregadas da rede (por exemplo, totais de membros).
            fraud_tags:
              type: array
              items:
                type: object
              description: Tags de padrões de fraude identificadas na rede.
            risk_signals:
              type: object
              description: >-
                Resumos dos sinais de risco: residential_proxy_reuse,
                email_intelligence, phone_intelligence.
            reviewed_at:
              type: string
              format: date-time
              nullable: true
            reviewed_by:
              type: string
              nullable: true
            review_reason:
              type: string
              nullable: true
      properties:
        notes_count:
          type: integer
          minimum: 0
          readOnly: true
          description: Número de notas privadas de analistas nesta investigação.
    NetworkTag:
      type: object
      description: Uma das tags da sua aplicação na rede.
      properties:
        uuid:
          type: string
          format: uuid
          description: O UUID da tag, o mesmo valor que você passa como `tag_uuid`.
        name:
          type: string
        color:
          type: string
          description: Cor hexadecimal, por exemplo, `#6366F1`.
        source:
          type: string
          enum:
            - didit
            - custom
          description: >-
            `didit` para uma tag predefinida da Didit, `custom` para uma tag
            criada pela sua equipe.
        added_by:
          type: string
          nullable: true
          description: >-
            E-mail do membro do console que adicionou a tag. Null quando uma
            chave de API a adicionou.
        added_at:
          type: string
          format: date-time
    NetworkOutcomes:
      type: object
      description: >-
        Situação das pessoas e empresas da rede. Cada membro que você pode ver é
        contado uma vez, pelo status da sua verificação mais recente que chegou
        a uma decisão. As partes de transações não são contadas.
      properties:
        approved:
          type: integer
          description: Membros cuja verificação decidida mais recente foi aprovada.
        declined:
          type: integer
          description: Membros cuja verificação decidida mais recente foi recusada.
        in_review:
          type: integer
          description: Membros cuja verificação decidida mais recente está em revisão.
        total:
          type: integer
          description: >-
            Membros com pelo menos uma verificação, decidida ou não. Um membro
            cujas verificações estão todas sem decisão (não iniciadas, em
            andamento, expiradas ou abandonadas) é contado aqui e em nenhuma
            outra chave.
    NetworkPatternScore:
      type: object
      description: >-
        Quão semelhante é um tipo de dado dos membros em toda a rede. Um padrão
        não é um sinal: nenhum valor compartilhado vincula os membros.
      properties:
        type:
          type: string
          enum:
            - background
          description: >-
            `background`: a similaridade média de todos os pares de fundos das
            selfies dos membros, com a pessoa mascarada. Considera a selfie mais
            recente de cada pessoa, no máximo as 50 mais recentes, e exclui as
            sessões de verificação de idade. Abrange toda a rede, não apenas os
            membros das suas aplicações.
        score:
          type: number
          nullable: true
          minimum: 0
          maximum: 1
          description: >-
            De 0 a 1, arredondado para 4 casas decimais. Null quando `reason`
            está definido.
        members:
          type: integer
          nullable: true
          description: >-
            Quantas selfies de membros a pontuação comparou. Uma selfie que não
            pode ser lida, ou que mostra pouco fundo, não é comparada. Null
            enquanto `computing`; 0 ou 1 com `not_enough_selfies`.
        reason:
          type: string
          enum:
            - computing
            - not_enough_selfies
          nullable: true
          description: >-
            Por que não há pontuação. `computing`: a pontuação dos membros
            atuais está sendo calculada; consulte a rede novamente mais tarde.
            `not_enough_selfies`: menos de dois membros têm uma selfie
            utilizável. Nulo quando há pontuação.
        computed_at:
          type: string
          format: date-time
          nullable: true
          description: Quando a pontuação foi calculada. Nulo enquanto estiver `computing`.
    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
    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.