> ## 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.
# 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ó.
Prompt de l'API de llistat de xarxes
Copia el prompt al porta-retalls
\
\`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,,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.`
\
Enganxa a
Llista les xarxes de frau detectades per a la teva organització.
Per defecte, la llista s'ordena per puntuació de risc, de més alta a més baixa, i després per l'activitat més recent.
Tots els filtres disponibles a la llista de xarxes de la Console s'exposen com a paràmetres de consulta, inclosa la cerca de text lliure `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`.> [!NOTE]
>
> Les aplicacions de sandbox mai tenen xarxes. L'agrupació només s'executa amb dades de producció.## Mode de compartició i senyals entre organitzacionsCada resposta inclou el `sharing_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`. |El pla es comprova primer: per sota del pla Enterprise, el motiu és `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`). |Els filtres diferents de `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ésEls endpoints de xarxes necessiten una [clau d'API](https://docs.didit.me/ca/console/api-keys.md) d'accés complet.
Una clau amb accés restringit rep `403`.
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- [Obtenir xarxa](https://docs.didit.me/ca/management-api/networks/get.md)
- [Graf de la xarxa](https://docs.didit.me/ca/management-api/networks/graph.md)
- [Xarxes (Console)](https://docs.didit.me/ca/console/networks.md)
## OpenAPI
````yaml ca/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 verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/organization/{organization_id}/application/{application_id}/networks/:
get:
tags:
- Networks
summary: Llista les xarxes
description: >-
Llista les xarxes de frau detectades a l'organització d'aquesta
aplicació, per defecte ordenades de major a menor risc. Per defecte, les
xarxes descartades s'exclouen; passa status per incloure-les. Les
aplicacions de sandbox mai tenen xarxes: el clustering exclou
completament les dades de sandbox. Cada resposta inclou el
`sharing_mode` de l'organització i si se li apliquen senyals
interorganitzacionals (`cross_org_available`,
`cross_org_unavailable_reason`). `kpis` agrega les xarxes que
coincideixen amb els teus filtres i `counts` agrega totes les xarxes que
l'aplicació pot veure; passa `summary=false` per ometre tots dos quan
només necessitis la pàgina. Requereix una clau d'API d'accés complet o
`list:networks` per a un membre de la consola.
operationId: list_networks
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de l'organització.
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de l'aplicació.
- name: status
in: query
schema:
type: string
description: >-
Estats separats per comes que cal incloure:
active,in_review,resolved,dismissed. Omet-ho per excloure dismissed.
- name: scope
in: query
schema:
type: string
enum:
- identity
- transactions
description: >-
`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.
- name: signal_type
in: query
schema:
type: string
description: >-
Tipus de senyal separats per comes:
ip_address,device,face,document_number,phone,email,address.
- name: pattern_type
in: query
schema:
type: string
description: >-
Tipus de patró separats per comes, p. ex.
exact_same_device,same_email.
- name: risk_band
in: query
schema:
type: string
description: 'Franges separades per comes: low,medium,high.'
- name: min_size
in: query
schema:
type: integer
description: Nombre mínim de membres.
- name: max_size
in: query
schema:
type: integer
description: Nombre màxim de membres.
- name: assignee
in: query
schema:
type: string
description: >-
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."]}`.
- name: priority
in: query
schema:
type: string
description: >-
Prioritats separades per comes: `low`, `medium`, `high` o `none` per
a xarxes sense prioritat. Qualsevol altre valor retorna 400
`{"priority": "Unknown priority: ."}`.
- name: risk_min
in: query
schema:
type: integer
minimum: 0
maximum: 100
description: >-
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."}`.
- name: has_case
in: query
schema:
type: boolean
description: >-
`true` manté les xarxes per a les quals la teva aplicació ha obert
un cas; `false`, les altres. Qualsevol altre valor s'ignora.
- name: date_from
in: query
schema:
type: string
format: date
description: >-
Límit inferior per a last_activity_at (data o data i hora en format
ISO 8601).
- name: date_to
in: query
schema:
type: string
format: date
description: >-
Límit superior de first_activity_at (data o data i hora en format
ISO 8601).
- name: q
in: query
schema:
type: string
description: >-
Cerca de text lliure pel nom de la xarxa, noms dels membres, el
network_id (N-0001) i tokens exactes de pattern_type.
- name: ordering
in: query
schema:
type: string
description: >-
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.
- name: limit
in: query
schema:
type: integer
default: 100
minimum: 1
maximum: 500
description: Mida de la pàgina, 1-500. Per defecte és 100.
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
description: Desplaçament basat en zero del primer registre.
- name: summary
in: query
schema:
type: boolean
default: true
description: >-
`false` 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.
responses:
'200':
description: >-
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`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
next:
type: integer
nullable: true
description: >-
Desplaçament de la pàgina següent, o null a l'última
pàgina.
previous:
type: integer
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/NetworkListItem'
kpis:
type: object
description: >-
Cada clau és {value, delta} sobre els resultats que
coincideixen amb els filtres actuals. S'omet quan
`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: >-
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ó.
example: global
cross_org_available:
type: boolean
description: >-
Indica si els senyals entre organitzacions s'apliquen a
aquesta organització. Necessiten tant el pla Enterprise
com el mode de compartició `global`.
example: true
cross_org_unavailable_reason:
type: string
enum:
- plan
- sharing_mode
nullable: true
description: >-
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`.
example: null
required:
- count
- next
- previous
- results
- sharing_mode
- cross_org_available
- cross_org_unavailable_reason
'400':
description: Un valor no vàlid de filtre, ordenació, paginació o `summary`.
content:
application/json:
examples:
Invalid summary:
summary: Resum no vàlid
value:
summary:
- Must be "true" or "false".
Invalid scope:
summary: Abast no vàlid
value:
scope:
- Use identity or transactions.
Unsupported ordering:
summary: Criteri d'ordenació no admès
value:
- Unsupported ordering.
'401':
description: Falten les credencials o no són vàlides.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
Present en errors codificats, per exemple
`networks_not_entitled`.
examples:
Missing or invalid credentials:
summary: Falten les credencials o no són vàlides
value:
detail: >-
Authentication credentials were not provided or are
invalid.
'403':
description: >-
La clau d'API pertany a una altra aplicació o és una clau amb accés
restringit: els endpoints de Networks necessiten una clau amb accés
complet. Un token de membre de la consola necessita `list:networks`.
També es retorna amb `code: networks_not_entitled` quan Networks no
està habilitat per a l'organització.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
Present en errors codificats, per exemple
`networks_not_entitled`.
examples:
Networks not enabled:
summary: Xarxes no habilitades
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: Clau d'API restringida
value:
detail: This API key has no access to this endpoint.
No permission:
summary: Sense permís
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: |-
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 seqüencial per organització llegible per a humans, p. ex. N-0001.
name:
type: string
nullable: true
status:
type: string
enum:
- active
- in_review
- resolved
- dismissed
description: >-
Estat del cicle de vida de la xarxa. Distint de l'outcome_status per
sol·licitant dins d'una xarxa
(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: Els patrons d'agrupament detectats en aquesta xarxa.
signal_types:
type: array
items:
type: string
enum:
- ip_address
- device
- face
- document_number
- phone
- email
- address
description: Els diferents tipus de senyals presents en aquesta xarxa.
member_counts:
type: object
description: >-
Recomptes de membres per categoria (p. ex. total, per
outcome_status).
member_status:
type: object
description: Desglossament dels membres per outcome_status.
signal_coverage:
type: object
description: Cobertura dels membres d'aquesta xarxa per signal_type.
first_activity_at:
type: string
format: date-time
nullable: true
last_activity_at:
type: string
format: date-time
nullable: true
NetworkListCounts:
type: object
description: >-
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.
properties:
scopes:
type: object
description: Xarxes visibles per producte.
properties:
all:
type: integer
identity:
type: integer
description: Tota la resta de xarxes.
transactions:
type: integer
description: Xarxes els membres de les quals són tots parts de la transacció.
views:
type: object
description: >-
Xarxes visibles dins del `scope` seleccionat, per estat, més dues
visualitzacions desades.
properties:
all:
type: integer
active:
type: integer
in_review:
type: integer
resolved:
type: integer
dismissed:
type: integer
mine:
type: integer
description: >-
Xarxes assignades al membre de la consola que fa la crida.
Sempre és 0 per a una clau d'API.
high_risk:
type: integer
description: >-
Xarxes amb una puntuació de risc de 80 o més que no s'han
descartat.
facets:
type: object
description: >-
Recomptes per a cada opció de filtre, dins del `scope` i de la
visualització d'estat seleccionats.
properties:
total:
type: integer
description: Xarxes a la visualització de `scope` i estat seleccionada.
last_activity_days:
type: object
description: >-
Xarxes amb activitat en els darrers 7, 30 i 90 dies, indexades
pel nombre de dies.
properties:
'7':
type: integer
'30':
type: integer
'90':
type: integer
risk_min:
type: object
description: >-
Xarxes amb una puntuació de risc d'almenys 50 i almenys 80,
indexades pel llindar.
properties:
'50':
type: integer
'80':
type: integer
signal_types:
type: object
description: Xarxes amb almenys un senyal de cada tipus.
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: Xarxes per prioritat. `none` compta les xarxes sense prioritat.
properties:
low:
type: integer
medium:
type: integer
high:
type: integer
none:
type: integer
assignee:
type: object
description: Xarxes per persona assignada.
properties:
me:
type: integer
description: >-
Assignat al membre de la consola que fa la crida. Sempre és
0 per a una clau d'API.
unassigned:
type: integer
description: No assignat a ningú.
users:
type: array
description: >-
Una entrada per persona assignada, primer les que tenen més
xarxes.
items:
type: object
properties:
uuid:
type: string
format: uuid
full_name:
type: string
description: >-
El nom de la persona assignada, o el seu correu
electrònic quan no s'ha definit cap nom.
email:
type: string
count:
type: integer
has_case:
type: integer
description: Xarxes per a les quals aquesta aplicació ha obert un cas.
min_size:
type: object
description: Xarxes amb almenys 10 membres, indexades per la mida mínima.
properties:
'10':
type: integer
NetworkRiskDisplay:
type: object
properties:
score:
type: integer
description: Puntuació de risc, 0-100.
band:
type: string
enum:
- low
- medium
- high
description: >-
Franja en què es representa la puntuació. high >= 70, medium >= 40;
altrament, low.
bar:
type: number
format: float
description: Valor normalitzat de 0 a 1 per renderitzar una barra de risc.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
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.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.