> ## 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 de linha do tempo de redes de fraude

> Na Didit, obtenha o histórico de uma rede de fraude ou, com contract=2, a linha do tempo paginada de tentativas, transações, logins, regras e casos.



Prompt da API de linha do tempo da rede
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`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: "<source>:<uuid>", unique within the timeline. ingested_at: when Didit stored it.
\- account: the member account {node_id ("vendor_user:<uuid>", "vendor_business:<uuid>" or "transaction_party:<uuid>"), 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.`

\</pre>



      
      

Colar em

Obtenha o histórico de eventos de uma rede.
Sem `contract`, a resposta é o histórico da própria rede, do mais antigo para o mais recente e sem paginação: quando ela foi detectada pela primeira vez, quando cada sinal foi observado pela última vez e sua mudança de status mais recente, com o motivo.
Esse formato não mudou, e `limit`, `cursor` e `event_type` são ignorados.## Linha do tempo tipadaEnvie `contract=2` para ler a linha do tempo tipada.
Ela acrescenta o que as contas dos membros fizeram e o que sua equipe fez a respeito da rede, do mais recente para o mais antigo, uma página por vez.
`contract` aceita apenas `2`; qualquer outro valor retorna `400`.| Parâmetro | Significado |
| - | - |
| `limit` | Eventos por página, de 1 a 500. O padrão é 100. |
| `cursor` | O `next_cursor` da página anterior. Um cursor inválido ou vazio retorna `400`. |
| `event_type` | Os tipos de evento a manter, repetidos ou separados por vírgula, no máximo 20 valores. O padrão é todos os tipos. |A resposta é `{"results": [...], "next_cursor": "..."}`.
Leia a próxima página com `cursor` definido como `next_cursor`, até que `next_cursor` seja `null`.## Tipos de evento| `event_type` | O que registra | Bloco de detalhes |
| - | - | - |
| `network_detected` | A rede foi detectada | Nenhum |
| `signal_observed` | A observação mais recente de um sinal | Nenhum |
| `network_active`, `network_in_review`, `network_resolved`, `network_dismissed` | A mudança de status mais recente da rede, com o motivo em `metadata` | Nenhum |
| `verification_attempt` | Uma sessão de verificação de um membro (uma pessoa ou uma empresa), numerada (`attempt` de `attempt_count`), com os motivos de recusa quando recusada | `verification_attempt` |
| `transaction` | Uma transação da qual um membro participou, datada pela data da transação | `transaction` |
| `login` | Um login ou uma tentativa de login malsucedida que você enviou em nome de um membro pela [API de eventos](https://docs.didit.me/pt-br/transaction-monitoring/events.md) | `login` |
| `rule_hit` | Uma regra ativa que correspondeu a uma transação ou a um evento de um membro | `rule_hit` |
| `case_linked` | Um caso aberto para a rede na sua organização | `case_linked` |
| `note_added` | Uma nota deixada na rede, sem o texto | `note_added` |Eventos `note_added` são retornados apenas para membros do console, nunca para uma chave de API.
Uma transação entre dois membros aparece uma vez para cada um deles, cada uma com seu próprio `account`.
Um acionamento de regra nessa transação aparece uma única vez.
Eventos de login existem apenas para os logins que você envia como eventos: `auth.login`, `security.login_succeeded` e suas formas de falha.## Contas e registrosCada evento de membro traz `account`, o membro a que pertence, e `source_ref`, a sessão, sessão empresarial, transação, evento de monitoramento ou caso do qual ele foi lido.
`ownership` é `owned` quando o registro pertence à aplicação que você chamou, e `organization` quando pertence a outra aplicação da sua organização.
`route` informa o tipo, o UUID e a aplicação do registro; `source_ref` não tem `route` para um evento de monitoramento ou um caso.
Os eventos da própria rede não trazem nem `account` nem `source_ref`.## Conteúdo relacionado- [Obter rede](https://docs.didit.me/pt-br/management-api/networks/get.md)
- [Sinais da rede](https://docs.didit.me/pt-br/management-api/networks/signals.md)
- [Mapa da rede](https://docs.didit.me/pt-br/management-api/networks/map.md)
- [Ingestão de eventos](https://docs.didit.me/pt-br/transaction-monitoring/events.md)


## OpenAPI

````yaml pt-br/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 de verificação de identidade. Autentique-se com o cabeçalho 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: Obter a linha do tempo da rede
      description: >-
        Sem `contract`: os eventos da própria rede (detecção, a observação mais
        recente de cada sinal e a revisão correspondente), do mais antigo ao
        mais recente e sem paginação. `limit`, `cursor` e `event_type` são
        ignorados. Com `contract=2`: a linha do tempo tipada, do mais recente ao
        mais antigo e paginada por cursor. Ela inclui o que as contas membro
        fizeram (tentativas de verificação, transações, logins que você envia
        pela API de eventos e as regras ativas que eles acionaram) e os casos
        abertos para a rede. Eventos `note_added` são retornados apenas para
        membros do console, nunca para uma chave de API. Requer uma chave de API
        com acesso total, ou `read:networks` para um membro do console.
      operationId: get_network_timeline
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID da organização.
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID da aplicação.
        - name: network_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: n3a5e000-0000-4000-8000-000000000001
          description: UUID da rede.
        - name: contract
          in: query
          required: false
          schema:
            type: string
            enum:
              - '2'
          description: >-
            `2` retorna a linha do tempo tipada. Omita-o para obter a linha do
            tempo padrão. Qualquer outro valor retorna 400.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: >-
            Somente para a linha do tempo tipada. Eventos por página, de 1 a
            500. O padrão é 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Somente para a linha do tempo tipada. O `next_cursor` da página
            anterior. Um cursor inválido ou vazio retorna 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: >-
            Somente para a linha do tempo tipada. Tipos de evento a manter,
            repetidos ou separados por vírgula, com no máximo 20 valores. O
            padrão é todos os tipos.
      responses:
        '200':
          description: >-
            Sem `contract`: `{results}`, do mais antigo para o mais recente, sem
            paginação. Com `contract=2`: `{results, next_cursor}`, do mais
            recente para o mais antigo.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/NetworkTimeline'
                  - $ref: '#/components/schemas/NetworkTimelinePage'
              examples:
                Default timeline:
                  summary: Sem 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: Com 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: >-
            Com `contract` presente: um valor inválido de `contract`, `limit`,
            `cursor` ou `event_type`.
          content:
            application/json:
              examples:
                Unsupported contract:
                  summary: Contrato não suportado
                  value:
                    contract:
                      - '"3" is not a valid choice.'
                Invalid cursor:
                  summary: Cursor inválido
                  value:
                    cursor:
                      - This cursor is not valid. Reload the feed.
                Limit too large:
                  summary: Limite muito grande
                  value:
                    limit:
                      - Ensure this value is less than or equal to 500.
                Unknown event type:
                  summary: Tipo de evento desconhecido
                  value:
                    event_type:
                      '0':
                        - '"logout" is not a valid choice.'
        '401':
          description: Credenciais ausentes ou inválidas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros com código, por exemplo
                      `networks_not_entitled`.
              examples:
                Missing or invalid credentials:
                  summary: Credenciais ausentes ou inválidas
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
        '403':
          description: >-
            A chave de API pertence a outra aplicação ou é uma chave com acesso
            restrito: os endpoints de Networks exigem uma chave com acesso
            total. Um token de membro do console precisa de `read:networks`.
            Também é retornado com `code: networks_not_entitled` quando o
            Networks não está habilitado para a organização.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros com código, por exemplo
                      `networks_not_entitled`.
              examples:
                Networks not enabled:
                  summary: Redes não 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: Chave de API restrita
                  value:
                    detail: This API key has no access to this endpoint.
                No permission:
                  summary: Sem permissão
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Rede não encontrada (ou não visível para esta aplicação).
          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: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            $didit = new DiditClient();


            $result =
            $didit->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: >-
        Sem `contract`: os eventos da própria rede, do mais antigo ao mais
        recente, sem paginação.
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/NetworkTimelineEvent'
    NetworkTimelinePage:
      title: Typed timeline page (contract=2)
      type: object
      description: >-
        Com `contract=2`: uma página de eventos tipados, do mais recente para o
        mais antigo.
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/NetworkTypedTimelineEvent'
        next_cursor:
          type: string
          nullable: true
          description: >-
            Passe como `cursor` para ler a próxima página. Nulo na última
            página.
    NetworkTimelineEvent:
      type: object
      properties:
        event_type:
          type: string
          description: >-
            Por exemplo, 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: >-
        Um evento tipado da linha do tempo: os quatro campos padrão, mais seu
        id, quando a Didit o armazenou, a conta de membro e o registro aos quais
        pertence, e o bloco de detalhes do seu tipo de evento. Os demais blocos
        de detalhes são null.
      properties:
        id:
          type: string
          description: '`<source>:<uuid>`, único dentro da linha do tempo.'
          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: Quando ocorreu.
        ingested_at:
          type: string
          format: date-time
          description: Quando a Didit o armazenou.
        label:
          type: string
          description: >-
            Um rótulo curto em inglês, por exemplo `Verification attempt 2 of
            3`.
        metadata:
          type: object
          description: >-
            Para os eventos da própria rede, os mesmos metadados da linha do
            tempo padrão. Vazio nos demais casos.
        account:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineAccount'
          nullable: true
          description: >-
            A conta de membro. Nula para os eventos da própria rede,
            `case_linked` e `note_added`.
        source_ref:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineSourceRef'
          nullable: true
          description: >-
            O registro de origem. Nulo para os eventos da própria rede e para
            `note_added`.
        verification_attempt:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineAttempt'
          nullable: true
          description: Definido em eventos `verification_attempt`.
        transaction:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineTransaction'
          nullable: true
          description: Definido em eventos `transaction`.
        login:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineLogin'
          nullable: true
          description: Definido em eventos `login`.
        rule_hit:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineRuleHit'
          nullable: true
          description: Definido em eventos `rule_hit`.
        case_linked:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineCaseLinked'
          nullable: true
          description: Definido em eventos `case_linked`.
        note_added:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineNoteAdded'
          nullable: true
          description: >-
            Definido em eventos `note_added`. Nunca é retornado a uma chave de
            API.
    NetworkTimelineAccount:
      type: object
      description: A conta de membro à qual o evento pertence.
      properties:
        node_id:
          type: string
          description: >-
            `<kind>:<uuid>`, em que kind é `vendor_user`, `vendor_business` ou
            `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` quando o registro pertence à aplicação que você chamou (no
            caso de um membro do console, a uma aplicação à qual ele recebeu
            acesso). `organization` quando pertence a outra aplicação da sua
            organização.
        route:
          $ref: '#/components/schemas/NetworkTimelineRoute'
    NetworkTimelineSourceRef:
      type: object
      description: O registro do qual o evento foi lido.
      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` quando o registro pertence à aplicação que você chamou (no
            caso de um membro do console, a uma aplicação à qual ele recebeu
            acesso). `organization` quando pertence a outra aplicação da sua
            organização.
        route:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineRoute'
          description: Ausente para `monitoring_event` e `case`.
    NetworkTimelineAttempt:
      type: object
      description: Uma sessão de verificação da conta.
      properties:
        session_id:
          type: string
          format: uuid
          description: >-
            O UUID da sessão ou, no caso de uma empresa, o UUID da sessão de
            empresa.
        session_number:
          type: integer
          nullable: true
        attempt:
          type: integer
          description: >-
            A posição desta sessão entre as sessões da conta, em ordem de
            criação.
        attempt_count:
          type: integer
          description: Quantas sessões a conta tem.
        status:
          type: string
          description: O status da sessão, por exemplo `Approved` ou `Declined`.
        status_changed_at:
          type: string
          format: date-time
          nullable: true
        decline_reasons:
          type: array
          items:
            $ref: '#/components/schemas/NetworkTimelineDeclineReason'
          description: >-
            Somente para uma sessão recusada: seus avisos, do mais antigo para o
            mais recente, uma vez por aviso. Vazio nos demais casos.
    NetworkTimelineTransaction:
      type: object
      description: >-
        Uma transação da qual uma conta membro participou, datada pela data da
        transação.
      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: Nulo quando a transação não tem valor.
        status:
          type: string
        decision_reason_code:
          type: string
          nullable: true
        decision_reason_label:
          type: string
          nullable: true
        party_role:
          type: string
          description: >-
            A função da conta na transação: `APPLICANT`, `REMITTER`,
            `BENEFICIARY` ou `COUNTERPARTY`.
    NetworkTimelineLogin:
      type: object
      description: Um evento de login que você enviou para uma pessoa pela API de eventos.
      properties:
        action:
          type: string
          description: >-
            `<event_category>.<action_type>`: `auth.login` ou
            `security.login_succeeded` para um login, `auth.login_failed` ou
            `security.login_failed` para um login que falhou.
        succeeded:
          type: boolean
        status:
          type: string
          description: O status do evento.
        ip:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineIP'
          nullable: true
          description: Null quando o evento não tem endereço IP.
        device:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineDevice'
          nullable: true
          description: >-
            Null quando o evento não tem impressão digital nem contexto do
            dispositivo.
        is_first_login:
          type: boolean
          description: O primeiro login bem-sucedido registrado da conta.
        is_new_device:
          type: boolean
          description: >-
            Um login bem-sucedido a partir de um dispositivo do qual não veio
            nenhum dos logins bem-sucedidos anteriores da conta. Nunca é true no
            primeiro login.
    NetworkTimelineRuleHit:
      type: object
      description: >-
        Uma regra ativa em produção que correspondeu a uma transação ou evento
        de um membro. Correspondências em modo de teste não são incluídas.
      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: >-
        Um caso aberto para a rede na sua organização. `source_ref.ownership`
        indica se ele pertence à aplicação que você chamou.
      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: Uma nota deixada na rede. O texto da nota não é incluído.
      properties:
        note_id:
          type: string
          format: uuid
        author_email:
          type: string
    NetworkTimelineRoute:
      type: object
      description: >-
        Onde o registro começa: seu tipo, seu UUID e a aplicação à qual
        pertence.
      properties:
        kind:
          type: string
          description: >-
            `user`, `business` ou `transaction_party` para uma conta; `session`,
            `business_session` ou `transaction` para um registro de origem.
        id:
          type: string
          format: uuid
        application_id:
          type: string
          format: uuid
    NetworkTimelineDeclineReason:
      type: object
      properties:
        risk:
          type: string
          description: O código do aviso.
        feature:
          type: string
          description: O recurso que gerou o aviso.
        short_description:
          type: string
    NetworkTimelineAmount:
      type: object
      properties:
        value:
          type: string
          description: Valor decimal como string.
        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: O rótulo do tipo de conexão do endereço, em texto livre.
        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: >-
            Um rótulo de dispositivo legível, construído a partir do contexto de
            dispositivo do evento.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
        a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
        uma data de validade. 401 significa que a chave está errada, revogada ou
        expirada; 403 significa que nenhuma chave foi enviada, que a chave não
        tem acesso a este recurso ou ação, ou que a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.