Listar redes de fraude API

curl

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'

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);
}

ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()

iter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

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);
}

<?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());
}

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));
}

{
  "count": 123,
  "next": 123,
  "previous": 123,
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "network_id": "<string>",
      "name": "<string>",
      "status": "active",
      "risk": {
        "score": 123,
        "band": "low",
        "bar": 123
      },
      "pattern_types": [
        "exact_same_device"
      ],
      "signal_types": [
        "ip_address"
      ],
      "member_counts": {},
      "member_status": {},
      "signal_coverage": {},
      "first_activity_at": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z"
    }
  ],
  "sharing_mode": "global",
  "cross_org_available": true,
  "cross_org_unavailable_reason": null,
  "kpis": {
    "active": {},
    "in_review": {},
    "applicants_involved": {},
    "detected_this_period": {},
    "false_positive_rate": {}
  },
  "counts": {
    "scopes": {
      "all": 123,
      "identity": 123,
      "transactions": 123
    },
    "views": {
      "all": 123,
      "active": 123,
      "in_review": 123,
      "resolved": 123,
      "dismissed": 123,
      "mine": 123,
      "high_risk": 123
    },
    "facets": {
      "total": 123,
      "last_activity_days": {
        "7": 123,
        "30": 123,
        "90": 123
      },
      "risk_min": {
        "50": 123,
        "80": 123
      },
      "signal_types": {
        "ip_address": 123,
        "device": 123,
        "face": 123,
        "document_number": 123,
        "phone": 123,
        "email": 123,
        "address": 123
      },
      "priority": {
        "low": 123,
        "medium": 123,
        "high": 123,
        "none": 123
      },
      "assignee": {
        "me": 123,
        "unassigned": 123,
        "users": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "full_name": "<string>",
            "email": "<string>",
            "count": 123
          }
        ]
      },
      "has_case": 123,
      "min_size": {
        "10": 123
      }
    }
  }
}

GET

organization

{organization_id}

application

{application_id}

networks

curl

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'

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);
}

ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()

iter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

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);
}

<?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());
}

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));
}

{
  "count": 123,
  "next": 123,
  "previous": 123,
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "network_id": "<string>",
      "name": "<string>",
      "status": "active",
      "risk": {
        "score": 123,
        "band": "low",
        "bar": 123
      },
      "pattern_types": [
        "exact_same_device"
      ],
      "signal_types": [
        "ip_address"
      ],
      "member_counts": {},
      "member_status": {},
      "signal_coverage": {},
      "first_activity_at": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z"
    }
  ],
  "sharing_mode": "global",
  "cross_org_available": true,
  "cross_org_unavailable_reason": null,
  "kpis": {
    "active": {},
    "in_review": {},
    "applicants_involved": {},
    "detected_this_period": {},
    "false_positive_rate": {}
  },
  "counts": {
    "scopes": {
      "all": 123,
      "identity": 123,
      "transactions": 123
    },
    "views": {
      "all": 123,
      "active": 123,
      "in_review": 123,
      "resolved": 123,
      "dismissed": 123,
      "mine": 123,
      "high_risk": 123
    },
    "facets": {
      "total": 123,
      "last_activity_days": {
        "7": 123,
        "30": 123,
        "90": 123
      },
      "risk_min": {
        "50": 123,
        "80": 123
      },
      "signal_types": {
        "ip_address": 123,
        "device": 123,
        "face": 123,
        "document_number": 123,
        "phone": 123,
        "email": 123,
        "address": 123
      },
      "priority": {
        "low": 123,
        "medium": 123,
        "high": 123,
        "none": 123
      },
      "assignee": {
        "me": 123,
        "unassigned": 123,
        "users": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "full_name": "<string>",
            "email": "<string>",
            "count": 123
          }
        ]
      },
      "has_case": 123,
      "min_size": {
        "10": 123
      }
    }
  }
}

Lista as redes de fraude detetadas para a sua organização. Por predefinição, a lista é ordenada pela pontuação de risco, da mais alta para a mais baixa, e depois pela atividade mais recente. Todos os filtros disponíveis na lista de Networks da Consola são expostos como parâmetros de consulta, incluindo a pesquisa de texto livre através de q e os mesmos chips de estado, sinal, padrão e nível de risco. Os parâmetros assignee, priority, risk_min e has_case correspondem às opções de responsável atribuído, prioridade, risco mínimo e caso associado que o counts.facets contabiliza. assignee=me requer um token de membro da Consola; com uma chave de API, devolve 400.

As aplicações sandbox nunca têm redes. A clusterização só é executada com dados de produção.

Modo de partilha e sinais entre organizações

Cada resposta inclui o sharing_mode, o cross_org_available e o cross_org_unavailable_reason da sua organização.

Campo	Significado
`sharing_mode`	O modo de partilha entre organizações da organização. Apenas `global` compara redes entre organizações; `private` e `off` limitam-nas ao histórico da própria organização.
`cross_org_available`	Indica se os sinais entre organizações se aplicam à sua organização. Exigem simultaneamente o plano Enterprise e o modo de partilha `global`.
`cross_org_unavailable_reason`	`plan` quando o seu plano não inclui a rede de fraude entre organizações (requer o plano Enterprise), independentemente do modo de partilha. `sharing_mode` quando o plano a inclui, mas o seu modo de partilha é `private` ou `off`. `null` quando `cross_org_available` é `true`.

O plano é verificado em primeiro lugar: abaixo do plano Enterprise, o motivo é plan, mesmo que o seu modo de partilha seja global.

Contagens e o parâmetro summary

Os kpis agregam as redes que correspondem aos seus filtros, e os counts agregam todas as redes que a sua aplicação pode ver, pelo que 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 omite então kpis e counts. summary aceita apenas true ou false; qualquer outro valor devolve 400. Os counts contêm os números por trás das vistas e das opções de filtro da lista, contando cada rede uma única vez:

Chave	O que conta
`scopes`	Todas as redes visíveis (`all`), divididas em `transactions` (todos os membros são partes de transações) e `identity` (todas as outras redes).
`views`	Redes visíveis dentro do `scope` selecionado (`all`), por estado (`active`, `in_review`, `resolved`, `dismissed`), atribuídas ao membro da Consola que faz o pedido (`mine`) e `high_risk` (pontuação de risco de 80 ou mais, não descartadas).
`facets`	Redes no `scope` e na vista de estado (`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 atribuído (`me`, `unassigned` e uma entrada por responsável em `users`), redes para as quais a sua aplicação abriu um caso (`has_case`) e redes com pelo menos 10 membros (`min_size`).

Os filtros diferentes de scope e status não alteram os counts. views.mine e facets.assignee.me são sempre 0 com uma chave de API, uma vez que nenhum membro da Consola está a fazer o pedido.

Acesso

Os endpoints de Networks requerem uma chave de API com acesso total. Uma chave com acesso restrito recebe 403. Um token de membro da Consola requer list:networks. Quando o Networks não está ativado para a sua organização, todos os endpoints de Networks devolvem 403 com "code": "networks_not_entitled".

Relacionados

Autorizações

x-api-key

string

header

obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

UUID da organização.

application_id

string<uuid>

obrigatório

UUID da aplicação.

Parâmetros de consulta

status

string

Estados a incluir separados por vírgulas: active,in_review,resolved,dismissed. Omita para excluir dismissed.

scope

enum<string>

transactions mantém as redes cujos membros são todos partes da transação; identity mantém todas as outras redes. Omita para incluir ambas. Também restringe counts.views e counts.facets. Qualquer outro valor devolve 400.

Opções disponíveis:

identity,

transactions

signal_type

string

Tipos de sinal separados por vírgulas: ip_address,device,face,document_number,phone,email,address.

pattern_type

string

Tipos de padrão separados por vírgulas, por exemplo, exact_same_device,same_email.

risk_band

string

Intervalos separados por vírgulas: low,medium,high.

min_size

integer

Número mínimo de membros.

max_size

integer

Número máximo de membros.

assignee

string

Responsáveis atribuídos separados por vírgulas: unassigned, e-mails dos membros (correspondência sem distinção de maiúsculas e minúsculas) ou me para o membro da consola que efetua a chamada. Uma rede corresponde a qualquer valor. me necessita de um token de membro da consola: uma chave de API recebe 400 {"assignee": ["\"me\" needs a user token; an API key has no assignee identity."]}.

priority

string

Prioridades separadas por vírgulas: low, medium, high, ou none para redes sem prioridade. Qualquer outro valor devolve 400 {"priority": "Unknown priority: <values>."}.

risk_min

integer

Pontuação de risco mínima, um número inteiro de 0 a 100. Um valor que não seja um número inteiro devolve 400 {"risk_min": "Use a whole number from 0 to 100."}.

Intervalo necessário: 0 <= x <= 100

has_case

boolean

true mantém as redes para as quais a sua aplicação abriu um caso, false as outras. Qualquer outro valor é ignorado.

date_from

string<date>

Limite inferior para last_activity_at (data ou datetime ISO 8601).

date_to

string<date>

Limite superior de first_activity_at (data ou data e hora ISO 8601).

string

Pesquisa em texto livre pelo nome da rede, nomes dos membros, o network_id (N-0001) e tokens exatos de pattern_type.

ordering

string

Um de risk_score, -risk_score, last_activity_at, -last_activity_at, first_activity_at, -first_activity_at, network_number, -network_number. O valor predefinido é -risk_score,-last_activity_at.

limit

integer

padrão:100

Tamanho da página, 1-500. A predefinição é 100.

Intervalo necessário: 1 <= x <= 500

offset

integer

padrão:0

Offset de base zero do primeiro registo.

Intervalo necessário: x >= 0

summary

boolean

padrão:true

false devolve apenas a página e a respetiva count, sem kpis e counts. O valor predefinido é true. Qualquer valor diferente de true ou false devolve 400.

Resposta

Lista paginada de redes, com o modo de partilha da organização e a disponibilidade interorganizações, além de kpis e counts, a menos que summary=false.

count

integer

obrigatório

integer | null

obrigatório

Offset da página seguinte, ou null na última página.

integer | null

obrigatório

results

object[]

obrigatório

Show child attributes

O modo de partilha entre organizações da organização. Apenas global compara redes entre organizações; private e off restringem-nas ao próprio histórico da organização.

Opções disponíveis:

off,

private,

global

Exemplo:

"global"

cross_org_available

boolean

obrigatório

Se os sinais entre organizações se aplicam a esta organização. Exigem tanto o plano Enterprise como o modo de partilha global.

Exemplo:

true

cross_org_unavailable_reason

enum<string> | null

obrigatório

O motivo pelo qual os sinais interorganizacionais não se aplicam, verificados por esta ordem. plan: o plano da organização não inclui a rede de fraude interorganizacional (requer o plano Enterprise), independentemente do modo de partilha. sharing_mode: o plano inclui-a, mas o modo de partilha é private ou off. Nulo quando cross_org_available é true.

Opções disponíveis:

plan,

sharing_mode

Exemplo:

null

kpis

object

Cada chave é {value, delta} sobre os resultados correspondentes aos filtros atuais. Omitido quando summary=false.

Show child attributes

counts

object

Contagens de redes para as vistas da lista e opções de filtro, sendo cada rede contada uma vez. Devolvido apenas quando summary não for 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 vista de status selecionados (redes dispensadas são excluídas, exceto se status as incluir). Os outros filtros da lista não alteram estas contagens.

Show child attributes

Última modificação em 7 de novembro de 2026

​Modo de partilha e sinais entre organizações

​Contagens e o parâmetro summary

​Acesso

​Relacionados

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta

Modo de partilha e sinais entre organizações

Contagens e o parâmetro summary

Acesso

Relacionados