> ## 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
> 通过 Didit 获取欺诈网络的事件历史；传入 contract=2 时，返回成员尝试、交易、登录、规则命中和关联案件的分页时间线。
网络时间线 API 提示词
将提示词复制到剪贴板
\
\`Retrieve a fraud network's event timeline through the Management API.
Endpoint:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/
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.
Two shapes, chosen by the contract query parameter:
1\. Default (no contract parameter): unchanged.
Response 200: {"results": [NetworkTimelineEvent, ...]}, oldest first, not paginated.
Each event has event_type (network_detected, signal_observed, network_active, network_in_review, network_resolved, network_dismissed), occurred_at, label, and metadata (event-specific, e.g. {network_id} for detection, {signal_type, subject_count, is_hub} for a signal observation, {reason} for a status change).
limit, cursor and event_type are ignored in this mode.
2\. Typed timeline (contract=2, opt-in):
Query params:
\- contract=2: required for this mode. Any other value is a 400.
\- limit: 1 to 500, default 100.
\- cursor: the previous page's next_cursor. An invalid or empty cursor is a 400 ("This cursor is not valid. Reload the feed.").
\- event_type: repeat it or pass a comma-separated list, at most 20 values. Defaults to every type: network_detected, signal_observed, network_active, network_in_review, network_resolved, network_dismissed, verification_attempt, transaction, login, rule_hit, case_linked, note_added.
Response 200: {"results": [NetworkTypedTimelineEvent, ...], "next_cursor": string|null}, newest first. Keep calling with cursor=next_cursor until next_cursor is null.
Each typed event has:
\- event_type, occurred_at, label, metadata: as in the default shape (metadata is {} for events that are not the network's own).
\- id: ":", unique within the timeline. ingested_at: when Didit stored it.
\- account: the member account {node_id ("vendor_user:", "vendor_business:" or "transaction_party:"), node_type (account|business_account|transaction_party), uuid, vendor_data, display_name, ownership (owned|organization), route {kind, id, application_id}}. Null for the network's own events, case_linked and note_added.
\- source_ref: the record it was read from {kind (session|business_session|transaction|monitoring_event|case), id, ownership, route}. route is absent for monitoring_event and case. Null for the network's own events and note_added.
\- ownership: owned when the record belongs to the application I called, organization when it belongs to another application of my organization.
\- One detail block per event type, the others null:
\- verification_attempt {session_id, session_number, attempt, attempt_count, status, status_changed_at, decline_reasons [{risk, feature, short_description}] (declined sessions only)}
\- transaction {transaction_id, transaction_number, transaction_type, action_type, amount {value, currency, direction} or null, status, decision_reason_code, decision_reason_label, party_role}
\- login {action (auth.login, security.login_succeeded, auth.login_failed or security.login_failed), succeeded, status, ip {address, country_code, city, connection_type (free text), is_vpn_or_tor, is_data_center} or null, device {fingerprint, label} or null, is_first_login, is_new_device}
\- rule_hit {rule_id, rule_title, rule_category, rule_source, severity, score_delta, status_target, action_summary}
\- case_linked {case_id, case_number, status, author_email, author_name}
\- note_added {note_id, author_email}: never returned to an API key, only to console members.
Example call:
curl -X GET "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/?contract=2&limit=50&event_type=verification_attempt,login" \
-H "x-api-key: YOUR_API_KEY"
Failure modes:
\- 400 (contract mode only): {"contract": [...]}, {"limit": [...]}, {"cursor": ["This cursor is not valid. Reload the feed."]} or {"event_type": {...}}.
\- 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: none, pure read.
For the full integration shape, see /integration/integration-prompt.`
\
粘贴到
获取某个网络的事件历史。
不传 `contract` 时，响应返回网络自身的历史记录，按时间从旧到新排列且不分页：包括网络首次被检测到的时间、每个信号最近一次被观察到的时间，以及网络最近一次状态变更及其原因。
此结构保持不变，`limit`、`cursor` 和 `event_type` 会被忽略。## 类型化时间线如需读取类型化时间线，请传入 `contract=2`。
时间线会额外包含成员账户的行为，以及贵团队针对该网络采取的操作，按时间从新到旧排列，每次返回一页。
`contract` 只接受 `2`；其他任何值都会返回 `400`。| 参数 | 含义 |
| - | - |
| `limit` | 每页事件数，范围 1 到 500。默认值为 100。 |
| `cursor` | 上一页的 `next_cursor`。无效或为空的游标会返回 `400`。 |
| `event_type` | 要保留的事件类型，可重复传入或用逗号分隔，最多 20 个值。默认包含所有类型。 |响应格式为 `{"results": [...], "next_cursor": "..."}`。
将 `cursor` 设为 `next_cursor` 即可读取下一页，直到 `next_cursor` 为 `null` 为止。## 事件类型| `event_type` | 记录内容 | 详情块 |
| - | - | - |
| `network_detected` | 网络被检测到 | 无 |
| `signal_observed` | 信号的最新观察记录 | 无 |
| `network_active`, `network_in_review`, `network_resolved`, `network_dismissed` | 网络的最新状态变更，其原因记录在 `metadata` 中 | 无 |
| `verification_attempt` | 成员（个人或企业）的一次验证会话，带序号（第 `attempt` 次，共 `attempt_count` 次），若被拒绝则包含拒绝原因 | `verification_attempt` |
| `transaction` | 成员参与的一笔交易，按交易日期记录 | `transaction` |
| `login` | 您通过 [事件 API](https://docs.didit.me/zh/transaction-monitoring/events.md) 为成员发布的一次登录或登录失败 | `login` |
| `rule_hit` | 命中成员交易或事件的生效规则 | `rule_hit` |
| `case_linked` | 贵组织为该网络创建的一个案件 | `case_linked` |
| `note_added` | 添加到该网络上的备注，不含备注内容 | `note_added` |`note_added` 事件仅返回给控制台成员，绝不会返回给 API 密钥。
两名成员之间的交易会分别针对每位成员各出现一次，每条记录都带有各自的 `account`。
该交易的一次规则命中只出现一次。
登录事件仅针对您作为事件发布的登录记录存在：`auth.login`、`security.login_succeeded` 及其失败形式。## 账户与记录每条成员事件都包含 `account`（其所属的成员）和 `source_ref`（读取该事件所依据的会话、企业会话、交易、监控事件或案件）。
`ownership` 在记录属于您调用的应用时为 `owned`，当记录属于贵组织的其他应用时为 `organization`。
`route` 给出记录的类型、UUID 和应用；对于监控事件或案件，`source_ref` 不包含 `route`。
网络自身的事件既不包含 `account`，也不包含 `source_ref`。## 相关内容- [获取网络](https://docs.didit.me/zh/management-api/networks/get.md)
- [网络信号](https://docs.didit.me/zh/management-api/networks/signals.md)
- [网络图](https://docs.didit.me/zh/management-api/networks/map.md)
- [事件接入](https://docs.didit.me/zh/transaction-monitoring/events.md)
## OpenAPI
````yaml zh/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: 身份证件验证 API。使用 x-api-key 请求头进行身份验证。
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/:
get:
tags:
- Networks
summary: 获取网络时间线
description: >-
不带 `contract`：网络自身事件（检测、每个信号的最新观察结果及其审核），按时间从旧到新排序且不分页。`limit`、`cursor`
和 `event_type` 会被忽略。带
`contract=2`：类型化时间线，按时间从新到旧排序并通过游标分页。它还会添加成员账户的操作记录（验证尝试、交易、您通过事件 API
提交的登录记录以及它们命中的生效规则）以及为该网络开启的案件。`note_added` 事件仅返回给控制台成员，绝不返回给 API
密钥。需要完全访问权限的 API 密钥，或控制台成员具备 `read:networks` 权限。
operationId: get_network_timeline
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: 组织 UUID。
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: 应用 UUID。
- name: network_uuid
in: path
required: true
schema:
type: string
format: uuid
example: n3a5e000-0000-4000-8000-000000000001
description: 网络 UUID。
- name: contract
in: query
required: false
schema:
type: string
enum:
- '2'
description: '`2` 返回带类型的时间线。省略则返回默认时间线。任何其他值都会返回 400。'
- name: limit
in: query
required: false
schema:
type: integer
default: 100
minimum: 1
maximum: 500
description: 仅适用于类型化时间线。每页事件数，1 到 500。默认为 100。
- name: cursor
in: query
required: false
schema:
type: string
description: 仅适用于类型化时间线。上一页的 `next_cursor`。无效或空的游标返回 400。
- name: event_type
in: query
required: false
style: form
explode: true
schema:
type: array
maxItems: 20
items:
type: string
enum:
- network_detected
- signal_observed
- network_active
- network_in_review
- network_resolved
- network_dismissed
- verification_attempt
- transaction
- login
- rule_hit
- case_linked
- note_added
description: 仅适用于类型化时间线。要保留的事件类型，可重复或以逗号分隔，最多 20 个值。默认为所有类型。
responses:
'200':
description: >-
不带 `contract` 时：`{results}`，最旧的排在最前，不分页。带 `contract=2` 时：`{results,
next_cursor}`，最新的排在最前。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NetworkTimeline'
- $ref: '#/components/schemas/NetworkTimelinePage'
examples:
Default timeline:
summary: 不带 contract
value:
results:
- event_type: network_detected
occurred_at: '2026-10-01T09:12:44Z'
label: Network detected
metadata:
network_id: N-0042
- event_type: signal_observed
occurred_at: '2026-10-12T16:03:10Z'
label: device observed
metadata:
signal_type: device
subject_count: 3
is_hub: false
- event_type: network_in_review
occurred_at: '2026-10-12T16:30:00Z'
label: Network in_review
metadata:
reason: Shared device across three new accounts.
Typed timeline:
summary: 配合 contract=2
value:
results:
- id: monitoring_event:9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e
event_type: login
occurred_at: '2026-10-12T18:41:02Z'
ingested_at: '2026-10-12T18:41:03Z'
label: Login
metadata: {}
account:
node_id: vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
node_type: account
uuid: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
vendor_data: user-1042
display_name: Alex Example
ownership: owned
route:
kind: user
id: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
source_ref:
kind: monitoring_event
id: 9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e
ownership: owned
verification_attempt: null
transaction: null
login:
action: auth.login
succeeded: true
status: APPROVED
ip:
address: 203.0.113.24
country_code: ES
city: Madrid
connection_type: null
is_vpn_or_tor: false
is_data_center: false
device:
fingerprint: fp_0a1b2c3d
label: Chrome · Android
is_first_login: false
is_new_device: true
rule_hit: null
case_linked: null
note_added: null
- id: session:1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
event_type: verification_attempt
occurred_at: '2026-10-12T16:03:10Z'
ingested_at: '2026-10-12T16:03:10Z'
label: Verification attempt 2 of 2
metadata: {}
account:
node_id: vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
node_type: account
uuid: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
vendor_data: user-1042
display_name: Alex Example
ownership: owned
route:
kind: user
id: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
source_ref:
kind: session
id: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
ownership: owned
route:
kind: session
id: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
verification_attempt:
session_id: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
session_number: 1287
attempt: 2
attempt_count: 2
status: Approved
status_changed_at: '2026-10-12T16:05:41Z'
decline_reasons: []
transaction: null
login: null
rule_hit: null
case_linked: null
note_added: null
- id: signal_observed:8d7c6b5a-4e3f-4a2b-9c1d-0e9f8a7b6c5d
event_type: signal_observed
occurred_at: '2026-10-12T16:03:10Z'
ingested_at: '2026-10-01T09:12:44Z'
label: device observed
metadata:
signal_type: device
subject_count: 3
is_hub: false
account: null
source_ref: null
verification_attempt: null
transaction: null
login: null
rule_hit: null
case_linked: null
note_added: null
next_cursor: >-
eyJ0IjoiMjAyNi0xMC0xMlQxNjowMzoxMCswMDowMCIsImMiOiIyMDI2LTEwLTAxVDA5OjEyOjQ0KzAwOjAwIiwiciI6MSwidSI6IjhkN2M2YjVhLTRlM2YtNGEyYi05YzFkLTBlOWY4YTdiNmM1ZCJ9
'400':
description: 当存在 `contract` 时：无效的 `contract`、`limit`、`cursor` 或 `event_type` 值。
content:
application/json:
examples:
Unsupported contract:
summary: 不支持的合约
value:
contract:
- '"3" is not a valid choice.'
Invalid cursor:
summary: 无效的游标
value:
cursor:
- This cursor is not valid. Reload the feed.
Limit too large:
summary: 限制过大
value:
limit:
- Ensure this value is less than or equal to 500.
Unknown event type:
summary: 未知事件类型
value:
event_type:
'0':
- '"logout" is not a valid choice.'
'401':
description: 凭据缺失或无效。
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: 在带代码的错误中存在，例如 `networks_not_entitled`。
examples:
Missing or invalid credentials:
summary: 凭据缺失或无效
value:
detail: >-
Authentication credentials were not provided or are
invalid.
'403':
description: >-
API 密钥属于另一个应用，或者是一个访问权限受限的密钥：Networks endpoint 需要具有完全访问权限的密钥。控制台成员
token 需要 `read:networks` 权限。若组织未启用 Networks，也会返回 `code:
networks_not_entitled`。
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: 在带代码的错误中存在，例如 `networks_not_entitled`。
examples:
Networks not enabled:
summary: 网络未启用
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: 受限的 API 密钥
value:
detail: This API key has no access to this endpoint.
No permission:
summary: 无权限
value:
detail: You do not have permission to perform this action.
'404':
description: 未找到网络（或对当前应用不可见）。
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/timeline/'
\
-H 'x-api-key: YOUR_API_KEY'
- lang: curl
label: curl (typed timeline)
source: >-
curl -X GET
'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/timeline/?contract=2&limit=50&event_type=verification_attempt,login'
\
-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_timeline(
"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.retrieveTimeline("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.RetrieveTimeline(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveTimelineParams{})\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().retrieveTimeline("n3a5e000-0000-4000-8000-000000000001");
System.out.println(result);
- lang: php
label: PHP
source: >-
networks->retrieveTimeline('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_timeline("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.RetrieveTimelineAsync("n3a5e000-0000-4000-8000-000000000001");
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
NetworkTimeline:
title: Default timeline (no contract)
type: object
description: 不带 `contract`：网络自身事件，按时间从旧到新排序，不分页。
properties:
results:
type: array
items:
$ref: '#/components/schemas/NetworkTimelineEvent'
NetworkTimelinePage:
title: Typed timeline page (contract=2)
type: object
description: 配合 `contract=2`：一页类型化事件，最新的排在最前。
properties:
results:
type: array
items:
$ref: '#/components/schemas/NetworkTypedTimelineEvent'
next_cursor:
type: string
nullable: true
description: 作为 `cursor` 传入以读取下一页。在最后一页为 null。
NetworkTimelineEvent:
type: object
properties:
event_type:
type: string
description: >-
例如
network_detected、signal_observed、network_in_review、network_resolved、network_dismissed。
occurred_at:
type: string
format: date-time
nullable: true
label:
type: string
metadata:
type: object
NetworkTypedTimelineEvent:
type: object
description: >-
一个具有类型的时间线事件：四个默认字段，加上其 id、Didit 存储它的时间、它所属的成员账户和记录，以及其事件类型的详情块。其他详情块为
null。
properties:
id:
type: string
description: '`:`，在时间线内唯一。'
example: session:3fa85f64-5717-4562-b3fc-2c963f66afa6
event_type:
type: string
enum:
- network_detected
- signal_observed
- network_active
- network_in_review
- network_resolved
- network_dismissed
- verification_attempt
- transaction
- login
- rule_hit
- case_linked
- note_added
occurred_at:
type: string
format: date-time
description: 发生时间。
ingested_at:
type: string
format: date-time
description: Didit 存储的时间。
label:
type: string
description: 简短的英文标签，例如 `Verification attempt 2 of 3`。
metadata:
type: object
description: 对于网络自身的事件，为与默认时间线相同的元数据。其他情况为空。
account:
allOf:
- $ref: '#/components/schemas/NetworkTimelineAccount'
nullable: true
description: 成员账户。对于网络本身的事件、`case_linked` 和 `note_added`，该值为 null。
source_ref:
allOf:
- $ref: '#/components/schemas/NetworkTimelineSourceRef'
nullable: true
description: 源记录。对于网络自身的事件和 `note_added` 为 Null。
verification_attempt:
allOf:
- $ref: '#/components/schemas/NetworkTimelineAttempt'
nullable: true
description: 在 `verification_attempt` 事件发生时设置。
transaction:
allOf:
- $ref: '#/components/schemas/NetworkTimelineTransaction'
nullable: true
description: 在 `transaction` 事件发生时设置。
login:
allOf:
- $ref: '#/components/schemas/NetworkTimelineLogin'
nullable: true
description: 在 `login` 事件发生时设置。
rule_hit:
allOf:
- $ref: '#/components/schemas/NetworkTimelineRuleHit'
nullable: true
description: 在 `rule_hit` 事件发生时设置。
case_linked:
allOf:
- $ref: '#/components/schemas/NetworkTimelineCaseLinked'
nullable: true
description: 在 `case_linked` 事件发生时设置。
note_added:
allOf:
- $ref: '#/components/schemas/NetworkTimelineNoteAdded'
nullable: true
description: 在 `note_added` 事件发生时设置。绝不返回给 API 密钥。
NetworkTimelineAccount:
type: object
description: 该事件所属的成员账户。
properties:
node_id:
type: string
description: >-
`:`，其中 kind 为 `vendor_user`、`vendor_business` 或
`transaction_party`。
example: vendor_user:3fa85f64-5717-4562-b3fc-2c963f66afa6
node_type:
type: string
enum:
- account
- business_account
- transaction_party
uuid:
type: string
format: uuid
vendor_data:
type: string
nullable: true
display_name:
type: string
nullable: true
ownership:
type: string
enum:
- owned
- organization
description: >-
当记录属于您调用的应用时为 `owned`（对于控制台成员，则为其被授予权限的应用）。当属于您组织下的另一个应用时为
`organization`。
route:
$ref: '#/components/schemas/NetworkTimelineRoute'
NetworkTimelineSourceRef:
type: object
description: 读取该事件所依据的记录。
properties:
kind:
type: string
enum:
- session
- business_session
- transaction
- monitoring_event
- case
id:
type: string
format: uuid
ownership:
type: string
enum:
- owned
- organization
description: >-
当记录属于您调用的应用时为 `owned`（对于控制台成员，则为其被授予权限的应用）。当属于您组织下的另一个应用时为
`organization`。
route:
allOf:
- $ref: '#/components/schemas/NetworkTimelineRoute'
description: 在 `monitoring_event` 和 `case` 中不存在。
NetworkTimelineAttempt:
type: object
description: 该账户的一个验证会话。
properties:
session_id:
type: string
format: uuid
description: 会话 UUID，对于企业则为企业会话 UUID。
session_number:
type: integer
nullable: true
attempt:
type: integer
description: 此会话在该账户的所有会话中的位置，按创建顺序排列。
attempt_count:
type: integer
description: 该账户拥有的会话数量。
status:
type: string
description: 会话状态，例如 `Approved` 或 `Declined`。
status_changed_at:
type: string
format: date-time
nullable: true
decline_reasons:
type: array
items:
$ref: '#/components/schemas/NetworkTimelineDeclineReason'
description: 仅适用于已拒绝的会话：其警告列表，按时间从旧到新排序，每个警告仅出现一次。其他情况为空。
NetworkTimelineTransaction:
type: object
description: 成员账户参与的交易，按其交易日期标注日期。
properties:
transaction_id:
type: string
format: uuid
transaction_number:
type: integer
nullable: true
transaction_type:
type: string
action_type:
type: string
amount:
allOf:
- $ref: '#/components/schemas/NetworkTimelineAmount'
nullable: true
description: 当交易没有金额时为 null。
status:
type: string
decision_reason_code:
type: string
nullable: true
decision_reason_label:
type: string
nullable: true
party_role:
type: string
description: 账户在交易中的角色：`APPLICANT`、`REMITTER`、`BENEFICIARY` 或 `COUNTERPARTY`。
NetworkTimelineLogin:
type: object
description: 您通过事件 API 为某人发布的登录事件。
properties:
action:
type: string
description: >-
`.`：登录成功对应 `auth.login` 或
`security.login_succeeded`，登录失败对应 `auth.login_failed` 或
`security.login_failed`。
succeeded:
type: boolean
status:
type: string
description: 事件的状态。
ip:
allOf:
- $ref: '#/components/schemas/NetworkTimelineIP'
nullable: true
description: 当事件没有地址时为 null。
device:
allOf:
- $ref: '#/components/schemas/NetworkTimelineDevice'
nullable: true
description: 当事件没有设备指纹或上下文时为 null。
is_first_login:
type: boolean
description: 记录中该账户首次成功的登录。
is_new_device:
type: boolean
description: 来自该账户以往成功登录均未出现过的设备的成功登录。首次登录时绝不为 true。
NetworkTimelineRuleHit:
type: object
description: 命中成员交易或事件的已启用规则。不包括测试模式下的命中。
properties:
rule_id:
type: string
format: uuid
rule_title:
type: string
rule_category:
type: string
rule_source:
type: string
severity:
type: string
nullable: true
score_delta:
type: integer
status_target:
type: string
nullable: true
action_summary:
type: string
nullable: true
NetworkTimelineCaseLinked:
type: object
description: 为您的组织中的网络打开的案件。`source_ref.ownership` 表明它是否属于您调用的应用。
properties:
case_id:
type: string
format: uuid
case_number:
type: string
nullable: true
status:
type: string
author_email:
type: string
nullable: true
author_name:
type: string
nullable: true
NetworkTimelineNoteAdded:
type: object
description: 留在网络上的备注。不包含备注文本。
properties:
note_id:
type: string
format: uuid
author_email:
type: string
NetworkTimelineRoute:
type: object
description: 打开记录的位置：其种类、UUID 以及所属的应用。
properties:
kind:
type: string
description: >-
账户为 `user`、`business` 或 `transaction_party`；源记录为
`session`、`business_session` 或 `transaction`。
id:
type: string
format: uuid
application_id:
type: string
format: uuid
NetworkTimelineDeclineReason:
type: object
properties:
risk:
type: string
description: 警告代码。
feature:
type: string
description: 触发该警告的功能。
short_description:
type: string
NetworkTimelineAmount:
type: object
properties:
value:
type: string
description: 字符串形式的十进制金额。
currency:
type: string
direction:
type: string
nullable: true
NetworkTimelineIP:
type: object
properties:
address:
type: string
country_code:
type: string
nullable: true
city:
type: string
nullable: true
connection_type:
type: string
nullable: true
description: 地址的连接类型标签，为自由文本格式。
is_vpn_or_tor:
type: boolean
is_data_center:
type: boolean
NetworkTimelineDevice:
type: object
properties:
fingerprint:
type: string
nullable: true
label:
type: string
nullable: true
description: 根据事件的设备上下文构建的易读设备标签。
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
您的应用 API 密钥，可在 Business Console 的“开发者 -> API
密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
https://docs.didit.me/console/api-keys。
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.