Primers passos
Integració / SDK
Verificació d'usuaris
Verificació d'empreses
Monitoratge de transaccions
Registre de canviscurl -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'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)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());
}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
endusing 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
}
}
}
}Llistar xarxes de frau: API de Didit
Llista les xarxes de frau de Didit, filtrades per estat, senyal, patró, nivell de risc, mida i data, amb el mode de compartició.
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'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)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());
}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
endusing 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
}
}
}
}q i els mateixos xips d’estat, senyal, patró i franja de risc.
Els paràmetres assignee, priority, risk_min i has_case coincideixen amb les opcions d’assignat, prioritat, risc mínim i cas enllaçat que compta counts.facets.
assignee=me necessita un token de membre de la consola; amb una clau d’API retorna 400.
Mode de compartició i senyals entre organitzacions
Cada resposta inclou elsharing_mode, el cross_org_available i el cross_org_unavailable_reason de la teva organització.
| Camp | Significat |
|---|---|
sharing_mode | El mode de compartició entre organitzacions de l’organització. Només global compara xarxes entre organitzacions; private i off limiten les xarxes a l’historial propi de l’organització. |
cross_org_available | Si els senyals entre organitzacions s’apliquen a la teva organització. Necessiten tant el pla Enterprise com el mode de compartició global. |
cross_org_unavailable_reason | plan quan el teu pla no inclou la xarxa de frau entre organitzacions (necessita el pla Enterprise), sigui quin sigui el teu mode de compartició. sharing_mode quan el pla la inclou però el teu mode de compartició és private o off. null quan cross_org_available és true. |
plan fins i tot quan el teu mode de compartició és global.
Recomptes i el paràmetre summary
kpis agrega les xarxes que coincideixen amb els teus filtres i counts agrega totes les xarxes que la teva aplicació pot veure, de manera que totes dues costen més que la pàgina en si.
Passa summary=false quan només necessitis la pàgina i el seu count: la resposta aleshores omet kpis i counts.
summary accepta només true o false; qualsevol altre valor retorna 400.
counts conté els números que hi ha darrere de les vistes de la llista i de les opcions de filtre, comptant cada xarxa una sola vegada:
| Clau | Què compta |
|---|---|
scopes | Totes les xarxes visibles (all), dividides en transactions (on tots els membres són parts d’una transacció) i identity (totes les altres xarxes). |
views | Xarxes visibles dins de l’scope seleccionat (all), per estat (active, in_review, resolved, dismissed), assignades al membre de la consola que fa la crida (mine), i high_risk (puntuació de risc de 80 o més, no descartades). |
facets | Xarxes dins de l’scope i de la vista d’status seleccionats (total), per activitat recent (last_activity_days: 7, 30, 90), risc mínim (risk_min: 50, 80), tipus de senyal, prioritat (incloent none), assignat (me, unassigned, i una entrada per a cada assignat a users), xarxes per a les quals la teva aplicació ha obert un cas (has_case), i xarxes amb almenys 10 membres (min_size). |
scope i status no canvien counts.
views.mine i facets.assignee.me són sempre 0 amb una clau d’API, ja que cap membre de la consola fa la crida.
Accés
Els endpoints de xarxes necessiten una clau d’API d’accés complet. Una clau amb accés restringit rep403.
Un token de membre de la consola necessita list:networks.
Quan les xarxes no estan habilitades per a la teva organització, tots els endpoints de xarxes retornen 403 amb "code": "networks_not_entitled".
Relacionat
Autoritzacions
La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.
Paràmetres de ruta
UUID de l'organització.
UUID de l'aplicació.
Paràmetres de consulta
Estats separats per comes que cal incloure: active,in_review,resolved,dismissed. Omet-ho per excloure dismissed.
transactions conserva les xarxes els membres de les quals són tots parts de la transacció; identity conserva totes les altres xarxes. Omet-ho per a ambdues. També redueix counts.views i counts.facets. Qualsevol altre valor retorna 400.
identity, transactions Tipus de senyal separats per comes: ip_address,device,face,document_number,phone,email,address.
Tipus de patró separats per comes, p. ex. exact_same_device,same_email.
Franges separades per comes: low,medium,high.
Nombre mínim de membres.
Nombre màxim de membres.
Assignats separats per comes: unassigned, correus electrònics de membres (coincidència sense distingir majúscules de minúscules), o me per al membre de la consola que fa la crida. Una xarxa coincideix amb qualsevol valor. me necessita un token de membre de la consola: una clau d'API rep 400 {"assignee": ["\"me\" needs a user token; an API key has no assignee identity."]}.
Prioritats separades per comes: low, medium, high o none per a xarxes sense prioritat. Qualsevol altre valor retorna 400 {"priority": "Unknown priority: <values>."}.
Puntuació de risc mínima, un nombre enter del 0 al 100. Un valor que no sigui un nombre enter retorna 400 {"risk_min": "Use a whole number from 0 to 100."}.
0 <= x <= 100true manté les xarxes per a les quals la teva aplicació ha obert un cas; false, les altres. Qualsevol altre valor s'ignora.
Límit inferior per a last_activity_at (data o data i hora en format ISO 8601).
Límit superior de first_activity_at (data o data i hora en format ISO 8601).
Cerca de text lliure pel nom de la xarxa, noms dels membres, el network_id (N-0001) i tokens exactes de pattern_type.
Un de risk_score, -risk_score, last_activity_at, -last_activity_at, first_activity_at, -first_activity_at, network_number, -network_number. Per defecte és -risk_score,-last_activity_at.
Mida de la pàgina, 1-500. Per defecte és 100.
1 <= x <= 500Desplaçament basat en zero del primer registre.
x >= 0false retorna només la pàgina i el seu count, sense kpis ni counts. Per defecte és true. Qualsevol valor diferent de true o false retorna 400.
Resposta
Llista paginada de xarxes, amb el mode de compartició de l'organització i la disponibilitat entre organitzacions, a més de kpis i counts tret que summary=false.
Desplaçament de la pàgina següent, o null a l'última pàgina.
Show child attributes
Show child attributes
El mode de compartició entre organitzacions de l'organització. Només global compara xarxes entre organitzacions; private i off les mantenen a l'historial propi de l'organització.
off, private, global "global"
Indica si els senyals entre organitzacions s'apliquen a aquesta organització. Necessiten tant el pla Enterprise com el mode de compartició global.
true
Per què no s'apliquen els senyals interorganitzacionals, comprovats en aquest ordre. plan: el pla de l'organització no inclou la xarxa de frau interorganitzacional (necessita el pla Enterprise), independentment del mode de compartició. sharing_mode: el pla la inclou, però el mode de compartició és private o off. Null quan cross_org_available és true.
plan, sharing_mode null
Cada clau és {value, delta} sobre els resultats que coincideixen amb els filtres actuals. S'omet quan summary=false.
Show child attributes
Show child attributes
Recomptes de xarxes per a les visualitzacions i les opcions de filtre de la llista, comptant cada xarxa una sola vegada. Només es retorna quan summary no és false. scopes compta totes les xarxes visibles per a l'aplicació. views compta les xarxes visibles dins del scope seleccionat. facets compta les xarxes a la visualització de scope i status seleccionada (les xarxes descartades s'exclouen tret que status les inclogui). La resta de filtres de la llista no modifiquen aquests recomptes.
Show child attributes
Show child attributes