> ## 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
> Lista las redes de fraude que Didit detecta en tu organización, con filtros por estado, señal, patrón, riesgo, tamaño y fecha, y tu modo de compartición.
Prompt de la API para listar redes
Copiar el prompt al portapapeles
\
\`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.`
\
Pegar en
Lista las redes de fraude detectadas para tu organización.
De forma predeterminada, la lista se ordena por puntuación de riesgo, de mayor a menor, y después por la actividad más reciente.
Cada filtro disponible en la lista de redes de la Console se expone como parámetro de consulta, incluida la búsqueda de texto libre `q` y los mismos chips de estado, señal, patrón y franja de riesgo.
Los parámetros `assignee`, `priority`, `risk_min` y `has_case` corresponden a las opciones de persona asignada, prioridad, riesgo mínimo y caso vinculado que contabiliza `counts.facets`.
`assignee=me` requiere un token de miembro de la consola; con una clave de API devuelve `400`.> [!NOTE]
>
> Las aplicaciones de sandbox nunca tienen redes. La agrupación se ejecuta solo con datos de producción.## Modo de compartición y señales entre organizacionesCada respuesta incluye los campos `sharing_mode`, `cross_org_available` y `cross_org_unavailable_reason` de tu organización.| Campo | Significado |
| - | - |
| `sharing_mode` | El modo de compartición entre organizaciones de la organización. Solo `global` compara redes entre organizaciones; `private` y `off` las limitan al historial propio de la organización. |
| `cross_org_available` | Si las señales entre organizaciones se aplican a tu organización. Requieren tanto el plan Enterprise como el modo de compartición `global`. |
| `cross_org_unavailable_reason` | `plan` cuando tu plan no incluye la red de fraude entre organizaciones (requiere el plan Enterprise), sea cual sea tu modo de compartición. `sharing_mode` cuando el plan la incluye pero tu modo de compartición es `private` u `off`. `null` cuando `cross_org_available` es `true`. |El plan se comprueba primero: con un plan inferior al Enterprise, el motivo es `plan` incluso cuando tu modo de compartición es `global`.## Recuentos y el parámetro summary`kpis` agrega las redes que coinciden con tus filtros y `counts` agrega todas las redes que tu aplicación puede ver, por lo que ambos son más costosos que la propia página.
Pasa `summary=false` cuando solo necesites la página y su `count`: en ese caso, la respuesta omite `kpis` y `counts`.
`summary` solo acepta `true` o `false`; cualquier otro valor devuelve `400`.`counts` contiene las cifras de las vistas y las opciones de filtro de la lista, y cada red se cuenta una sola vez:| Clave | Qué cuenta |
| - | - |
| `scopes` | Todas las redes visibles (`all`), divididas en `transactions` (todos los miembros son partes de una transacción) e `identity` (todas las demás redes). |
| `views` | Las redes visibles dentro del `scope` seleccionado (`all`), por estado (`active`, `in_review`, `resolved`, `dismissed`), asignadas al miembro de la consola que realiza la solicitud (`mine`) y `high_risk` (puntuación de riesgo de 80 o más, no descartadas). |
| `facets` | Las redes en el `scope` y la vista de `status` seleccionados (`total`), por actividad reciente (`last_activity_days`: 7, 30, 90), riesgo mínimo (`risk_min`: 50, 80), tipo de señal, prioridad (incluido `none`), persona asignada (`me`, `unassigned` y una entrada por cada persona asignada en `users`), redes para las que tu aplicación abrió un caso (`has_case`) y redes con al menos 10 miembros (`min_size`). |Los filtros distintos de `scope` y `status` no modifican `counts`.
`views.mine` y `facets.assignee.me` son siempre `0` con una clave de API, ya que ningún miembro de la consola realiza la solicitud.## AccesoLos endpoints de Networks requieren una [clave de API](https://docs.didit.me/es/console/api-keys.md) con acceso completo.
Con una clave con acceso restringido, se recibe un `403`.
Un token de miembro de la consola requiere `list:networks`.
Cuando Networks no está habilitado para tu organización, todos los endpoints de Networks devuelven `403` con `"code": "networks_not_entitled"`.## Relacionado- [Obtener red](https://docs.didit.me/es/management-api/networks/get.md)
- [Grafo de la red](https://docs.didit.me/es/management-api/networks/graph.md)
- [Redes (Console)](https://docs.didit.me/es/console/networks.md)
## OpenAPI
````yaml es/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ón de identidad. Autentícate con el encabezado 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 las redes de fraude detectadas en la organización de esta
aplicación, ordenadas por defecto de mayor a menor riesgo. Por defecto
se excluyen las redes descartadas; pasa status para incluirlas. Las
aplicaciones de sandbox nunca tienen redes: la agrupación excluye por
completo los datos de sandbox. Cada respuesta incluye el `sharing_mode`
de la organización e indica si se le aplican señales entre
organizaciones (`cross_org_available`, `cross_org_unavailable_reason`).
`kpis` agrega las redes que coinciden con tus filtros y `counts` agrega
todas las redes que la aplicación puede ver; pasa `summary=false` para
omitir ambos cuando solo necesites la página. Requiere una clave de API
con acceso completo, o `list:networks` para un miembro de la consola.
operationId: list_networks
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de la organización.
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID de la aplicación.
- name: status
in: query
schema:
type: string
description: >-
Estados que se incluirán, separados por comas:
active,in_review,resolved,dismissed. Si se omite, se excluyen los
descartados.
- name: scope
in: query
schema:
type: string
enum:
- identity
- transactions
description: >-
`transactions` conserva las redes cuyos miembros son todos partes de
transacciones; `identity` conserva todas las demás redes. Omítelo
para obtener ambas. También acota `counts.views` y `counts.facets`.
Cualquier otro valor devuelve 400.
- name: signal_type
in: query
schema:
type: string
description: >-
Tipos de señal separados por comas:
ip_address,device,face,document_number,phone,email,address.
- name: pattern_type
in: query
schema:
type: string
description: >-
Tipos de patrón separados por comas, por ejemplo,
exact_same_device,same_email.
- name: risk_band
in: query
schema:
type: string
description: 'Bandas separadas por comas: low,medium,high.'
- name: min_size
in: query
schema:
type: integer
description: Número mínimo de miembros.
- name: max_size
in: query
schema:
type: integer
description: Número máximo de miembros.
- name: assignee
in: query
schema:
type: string
description: >-
Asignados separados por comas: `unassigned`, correos electrónicos de
miembros (se comparan sin distinguir mayúsculas de minúsculas) o
`me` para el miembro de la consola que hace la llamada. Una red
coincide con cualquier valor. `me` requiere un token de miembro de
la consola: con una clave de API se obtiene un 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 comas: `low`, `medium`, `high` o `none`
para redes sin prioridad. Cualquier otro valor devuelve 400
`{"priority": "Unknown priority: ."}`.
- name: risk_min
in: query
schema:
type: integer
minimum: 0
maximum: 100
description: >-
Puntuación de riesgo mínima, un número entero de 0 a 100. Un valor
que no sea un número entero devuelve 400 `{"risk_min": "Use a whole
number from 0 to 100."}`.
- name: has_case
in: query
schema:
type: boolean
description: >-
`true` conserva las redes para las que tu aplicación abrió un caso;
`false`, las demás. Cualquier otro valor se ignora.
- name: date_from
in: query
schema:
type: string
format: date
description: Límite inferior de last_activity_at (fecha o fecha y hora ISO 8601).
- name: date_to
in: query
schema:
type: string
format: date
description: >-
Límite superior de first_activity_at (fecha o fecha y hora ISO
8601).
- name: q
in: query
schema:
type: string
description: >-
Búsqueda en texto libre por nombre de la red, nombres de los
miembros, el network_id (N-0001) y tokens exactos de pattern_type.
- name: ordering
in: query
schema:
type: string
description: >-
Uno de risk_score, -risk_score, last_activity_at, -last_activity_at,
first_activity_at, -first_activity_at, network_number,
-network_number. Valor predeterminado:
-risk_score,-last_activity_at.
- name: limit
in: query
schema:
type: integer
default: 100
minimum: 1
maximum: 500
description: Tamaño de página, de 1 a 500. El valor predeterminado es 100.
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
description: Desplazamiento, empezando en cero, del primer registro.
- name: summary
in: query
schema:
type: boolean
default: true
description: >-
`false` devuelve solo la página y su `count`, sin `kpis` ni
`counts`. El valor predeterminado es `true`. Cualquier valor
distinto de `true` o `false` devuelve 400.
responses:
'200':
description: >-
Lista paginada de redes, con el modo de compartición de la
organización y la disponibilidad entre organizaciones, además de
`kpis` y `counts` salvo que `summary=false`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
next:
type: integer
nullable: true
description: >-
Desplazamiento (offset) de la página siguiente, o null en
la última página.
previous:
type: integer
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/NetworkListItem'
kpis:
type: object
description: >-
Cada clave es {value, delta} sobre los resultados que
coinciden con los filtros actuales. Se omite cuando
`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 modo de uso compartido entre organizaciones de la
organización. Solo `global` compara redes entre
organizaciones; `private` y `off` las limitan al historial
propio de la organización.
example: global
cross_org_available:
type: boolean
description: >-
Indica si las señales entre organizaciones se aplican a
esta organización. Requieren tanto el plan Enterprise como
el modo de compartición `global`.
example: true
cross_org_unavailable_reason:
type: string
enum:
- plan
- sharing_mode
nullable: true
description: >-
Por qué no se aplican las señales entre organizaciones,
comprobado en este orden. `plan`: el plan de la
organización no incluye la red de fraude entre
organizaciones (requiere el plan Enterprise), sea cual sea
el modo de compartición. `sharing_mode`: el plan la
incluye, pero el modo de compartición es `private` u
`off`. Null cuando `cross_org_available` es `true`.
example: null
required:
- count
- next
- previous
- results
- sharing_mode
- cross_org_available
- cross_org_unavailable_reason
'400':
description: Valor de filtro, ordenación, paginación o `summary` no válido.
content:
application/json:
examples:
Invalid summary:
summary: Resumen no válido
value:
summary:
- Must be "true" or "false".
Invalid scope:
summary: Alcance no válido
value:
scope:
- Use identity or transactions.
Unsupported ordering:
summary: Ordenación no admitida
value:
- Unsupported ordering.
'401':
description: Credenciales ausentes o no válidas.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
Presente en errores con código, por ejemplo
`networks_not_entitled`.
examples:
Missing or invalid credentials:
summary: Credenciales ausentes o no válidas
value:
detail: >-
Authentication credentials were not provided or are
invalid.
'403':
description: >-
La clave de API pertenece a otra aplicación o es una clave con
acceso restringido: los endpoints de Networks necesitan una clave de
acceso completo. Un token de miembro de la consola necesita
`list:networks`. También se devuelve con `code:
networks_not_entitled` cuando Networks no está habilitado para la
organización.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
Presente en errores con código, por ejemplo
`networks_not_entitled`.
examples:
Networks not enabled:
summary: Redes no 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: Clave de API restringida
value:
detail: This API key has no access to this endpoint.
No permission:
summary: Sin permiso
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 secuencial legible por organización, p. ej. N-0001.
name:
type: string
nullable: true
status:
type: string
enum:
- active
- in_review
- resolved
- dismissed
description: >-
Estado del ciclo de vida de la red. Es distinto del outcome_status
de cada solicitante dentro de una red
(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: Los patrones de agrupamiento detectados en esta red.
signal_types:
type: array
items:
type: string
enum:
- ip_address
- device
- face
- document_number
- phone
- email
- address
description: Los distintos tipos de señal presentes en esta red.
member_counts:
type: object
description: >-
Recuentos de miembros por categoría (p. ej., total, por
outcome_status).
member_status:
type: object
description: Desglose de los miembros por outcome_status.
signal_coverage:
type: object
description: Cobertura por signal_type de los miembros de esta red.
first_activity_at:
type: string
format: date-time
nullable: true
last_activity_at:
type: string
format: date-time
nullable: true
NetworkListCounts:
type: object
description: >-
Recuentos de redes para las vistas y las opciones de filtro de la lista;
cada red se cuenta una sola vez. Solo se devuelven cuando `summary` no
es `false`. `scopes` cuenta todas las redes visibles para la aplicación.
`views` cuenta las redes visibles dentro del `scope` seleccionado.
`facets` cuenta las redes del `scope` y la vista de `status`
seleccionados (las redes descartadas quedan fuera salvo que `status` las
incluya). Los demás filtros de la lista no modifican estos recuentos.
properties:
scopes:
type: object
description: Redes visibles por producto.
properties:
all:
type: integer
identity:
type: integer
description: Todas las demás redes.
transactions:
type: integer
description: Redes cuyos miembros son todos partes de transacciones.
views:
type: object
description: >-
Redes visibles dentro del `scope` seleccionado, por estado, más dos
vistas guardadas.
properties:
all:
type: integer
active:
type: integer
in_review:
type: integer
resolved:
type: integer
dismissed:
type: integer
mine:
type: integer
description: >-
Redes asignadas al miembro de la consola que realiza la llamada.
Siempre 0 para una clave de API.
high_risk:
type: integer
description: >-
Redes con una puntuación de riesgo de 80 o más que no están
descartadas.
facets:
type: object
description: >-
Recuentos de cada opción de filtro, dentro del `scope` seleccionado
y de la vista de estado.
properties:
total:
type: integer
description: Redes del `scope` y la vista de estado seleccionados.
last_activity_days:
type: object
description: >-
Redes con actividad en los últimos 7, 30 y 90 días, indexadas
por el número de días.
properties:
'7':
type: integer
'30':
type: integer
'90':
type: integer
risk_min:
type: object
description: >-
Redes con una puntuación de riesgo de al menos 50 y de al menos
80, indexadas por el umbral.
properties:
'50':
type: integer
'80':
type: integer
signal_types:
type: object
description: Redes con al menos una señal 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 prioridad. `none` cuenta las redes sin prioridad.
properties:
low:
type: integer
medium:
type: integer
high:
type: integer
none:
type: integer
assignee:
type: object
description: Redes por persona asignada.
properties:
me:
type: integer
description: >-
Asignados al miembro de la consola que hace la llamada.
Siempre es 0 para una clave de API.
unassigned:
type: integer
description: Sin asignar.
users:
type: array
description: Una entrada por persona asignada, de más a menos redes.
items:
type: object
properties:
uuid:
type: string
format: uuid
full_name:
type: string
description: >-
El nombre de la persona asignada, o su correo
electrónico cuando no tiene un nombre definido.
email:
type: string
count:
type: integer
has_case:
type: integer
description: Redes para las que esta aplicación abrió un caso.
min_size:
type: object
description: Redes con al menos 10 miembros, indexadas por el tamaño mínimo.
properties:
'10':
type: integer
NetworkRiskDisplay:
type: object
properties:
score:
type: integer
description: Puntuación de riesgo, de 0 a 100.
band:
type: string
enum:
- low
- medium
- high
description: >-
Banda con la que se muestra la puntuación. high >= 70, medium >= 40;
en otro caso, low.
bar:
type: number
format: float
description: Valor normalizado de 0 a 1 para representar una barra de riesgo.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clave de API de tu aplicación, que encontrarás en Developers -> API
keys en la Business Console. La clave principal tiene acceso completo.
Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
a una lista de direcciones IP y a una fecha de caducidad. 401 significa
que la clave es incorrecta, se revocó o expiró; 403 significa que no se
envió ninguna clave, que la clave no tiene acceso a este recurso o
acción, o que la solicitud provino de una dirección fuera de su lista de
IP; 404 en una ruta de sesión significa que la sesión está fuera de los
flujos o estados de la clave. Una clave sin acceso a contenido
multimedia recibe las URL de imágenes, videos y PDF como null, y una
clave sin permiso de escritura en sesiones recibe los enlaces y tokens
de sesión como null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.