> ## 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.

# Adicionar Etiqueta a Rede de Fraude API

> Adicione uma etiqueta da sua aplicação a uma rede de fraude na Didit. Devolve o detalhe da rede com as respetivas etiquetas.



Prompt da API para adicionar etiqueta de rede
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Put one of my application's tags on a fraud network through the Management API.

Endpoint:
POST https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/

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, from list networks.

Request body:
\{"tag_uuid": "<uuid of one of my application's tags>"}

Example call:
curl -X POST "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'

Behavior:
\- 201 when the tag was added, 200 when it was already on the network (left as it is). Safe to retry.
\- Both return the network detail (same shape as get network). Its tags array lists my application's tags on the network, oldest first: {uuid, name, color, source (didit|custom), added_by, added_at}.
\- added_by is null when an API key adds the tag, and the console member's email when a member does.
\- Each application sees and changes only its own tags. fraud_tags (the tags the members carry) is not affected.

Failure modes:
\- 400: tag_uuid missing or not a UUID. {"tag_uuid": ["This field is required."]}
\- 404: {"detail": "Network not found."} (the network does not exist or has no member visible to this application), or {"detail": "Tag not found."} (the tag does not exist or belongs to another 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 write:networks.
\- 403 with {"code": "networks_not_entitled"}: Networks is not enabled for the organization.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Colar em

Coloque uma das etiquetas da sua aplicação numa rede, por exemplo para a marcar para seguimento ou para registar a conclusão da sua equipa.
Indique o UUID da etiqueta, retirado das etiquetas da sua aplicação, como `tag_uuid`.
Uma etiqueta que pertença a outra aplicação devolve `404`, tal como uma etiqueta que não existe.A resposta é o [detalhe completo da rede](https://docs.didit.me/pt/management-api/networks/get.md), com `201` quando a etiqueta foi adicionada e `200` quando já estava na rede.
Voltar a chamar o endpoint com a mesma etiqueta não altera nada, por isso pode tentar novamente sem risco.`tags` lista as etiquetas da sua aplicação na rede, da mais antiga para a mais recente.
`added_by` é `null` quando uma chave de API adicionou a etiqueta, e o e-mail do membro da consola quando foi um membro a adicioná-la.
As `fraud_tags` da rede, as etiquetas que os respetivos membros têm, não são afetadas.## Relacionados- [Remover etiqueta de rede](https://docs.didit.me/pt/management-api/networks/remove-tag.md)
- [Obter rede](https://docs.didit.me/pt/management-api/networks/get.md)
- [Listar redes](https://docs.didit.me/pt/management-api/networks/list.md)


## OpenAPI

````yaml pt/openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/
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}/tags/add/:
    post:
      tags:
        - Networks
      summary: Adicionar uma etiqueta a uma rede
      description: >-
        Coloca uma das etiquetas da sua aplicação na rede. Devolve os detalhes
        da rede, cuja propriedade `tags` lista as etiquetas da sua aplicação na
        rede, com `201` quando a etiqueta foi adicionada e `200` quando já se
        encontrava na rede. Uma etiqueta que pertença a outra aplicação, ou que
        não exista, devolve 404 `Tag not found.`. Requer uma chave de API de
        acesso total, ou `write:networks` para um membro da consola.
      operationId: add_network_tag
      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: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: UUID da rede.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkTagRequest'
            example:
              tag_uuid: 7c9e6679-7425-40de-944b-e07fc1f90ae7
      responses:
        '200':
          description: >-
            A etiqueta já se encontrava na rede e foi mantida como estava.
            Devolve os detalhes da rede.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkDetailResponse'
              example:
                uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                network_id: N-0042
                name: null
                status: in_review
                risk:
                  score: 82
                  band: high
                  bar: 0.82
                pattern_types:
                  - exact_same_device
                  - same_email
                signal_types:
                  - device
                  - email
                member_counts:
                  total: 3
                  users: 3
                  businesses: 0
                  transaction_parties: 0
                member_status:
                  approved: 1
                  declined: 1
                  in_review: 0
                  not_completed: 1
                signal_coverage:
                  device:
                    signals: 1
                    subjects: 3
                    coverage: 1
                  email:
                    signals: 1
                    subjects: 2
                    coverage: 0.6667
                first_activity_at: '2026-10-01T09:12:44Z'
                last_activity_at: '2026-10-12T16:03:10Z'
                stats:
                  members:
                    total: 3
                    users: 3
                    businesses: 0
                    transaction_parties: 0
                  member_status:
                    approved: 1
                    declined: 1
                    in_review: 0
                    not_completed: 1
                  signals:
                    total: 2
                    by_type:
                      device:
                        signals: 1
                        subjects: 3
                        coverage: 1
                      email:
                        signals: 1
                        subjects: 2
                        coverage: 0.6667
                fraud_tags: []
                risk_signals:
                  residential_proxy_reuse:
                    detected: false
                    signal_count: 0
                    max_subject_count: 0
                  email_intelligence:
                    enriched_signal_count: 1
                    high_risk_count: 0
                    social_profile_count: 0
                  phone_intelligence:
                    enriched_signal_count: 0
                    high_risk_count: 0
                reviewed_at: '2026-10-12T16:30:00Z'
                reviewed_by: reviewer@example.com
                review_reason: Shared device across three new accounts.
                notes_count: 0
                sharing_mode: global
                cross_org_available: true
                cross_org_unavailable_reason: null
                tags:
                  - uuid: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    name: SUSPICIOUS
                    color: '#6366F1'
                    source: custom
                    added_by: null
                    added_at: '2026-10-13T08:15:00Z'
                outcomes:
                  approved: 1
                  declined: 1
                  in_review: 0
                  total: 3
                patterns:
                  - type: background
                    score: 0.8125
                    members: 3
                    reason: null
                    computed_at: '2026-10-13T08:00:00Z'
        '201':
          description: A etiqueta foi adicionada. Devolve os detalhes da rede.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkDetailResponse'
              example:
                uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                network_id: N-0042
                name: null
                status: in_review
                risk:
                  score: 82
                  band: high
                  bar: 0.82
                pattern_types:
                  - exact_same_device
                  - same_email
                signal_types:
                  - device
                  - email
                member_counts:
                  total: 3
                  users: 3
                  businesses: 0
                  transaction_parties: 0
                member_status:
                  approved: 1
                  declined: 1
                  in_review: 0
                  not_completed: 1
                signal_coverage:
                  device:
                    signals: 1
                    subjects: 3
                    coverage: 1
                  email:
                    signals: 1
                    subjects: 2
                    coverage: 0.6667
                first_activity_at: '2026-10-01T09:12:44Z'
                last_activity_at: '2026-10-12T16:03:10Z'
                stats:
                  members:
                    total: 3
                    users: 3
                    businesses: 0
                    transaction_parties: 0
                  member_status:
                    approved: 1
                    declined: 1
                    in_review: 0
                    not_completed: 1
                  signals:
                    total: 2
                    by_type:
                      device:
                        signals: 1
                        subjects: 3
                        coverage: 1
                      email:
                        signals: 1
                        subjects: 2
                        coverage: 0.6667
                fraud_tags: []
                risk_signals:
                  residential_proxy_reuse:
                    detected: false
                    signal_count: 0
                    max_subject_count: 0
                  email_intelligence:
                    enriched_signal_count: 1
                    high_risk_count: 0
                    social_profile_count: 0
                  phone_intelligence:
                    enriched_signal_count: 0
                    high_risk_count: 0
                reviewed_at: '2026-10-12T16:30:00Z'
                reviewed_by: reviewer@example.com
                review_reason: Shared device across three new accounts.
                notes_count: 0
                sharing_mode: global
                cross_org_available: true
                cross_org_unavailable_reason: null
                tags:
                  - uuid: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    name: SUSPICIOUS
                    color: '#6366F1'
                    source: custom
                    added_by: null
                    added_at: '2026-10-13T08:15:00Z'
                outcomes:
                  approved: 1
                  declined: 1
                  in_review: 0
                  total: 3
                patterns:
                  - type: background
                    score: 0.8125
                    members: 3
                    reason: null
                    computed_at: '2026-10-13T08:00:00Z'
        '400':
          description: 'Corpo inválido: o `tag_uuid` está em falta ou não é um UUID.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  tag_uuid:
                    type: array
                    items:
                      type: string
              examples:
                Missing tag_uuid:
                  summary: tag_uuid em falta
                  value:
                    tag_uuid:
                      - This field is required.
                Invalid tag_uuid:
                  summary: tag_uuid inválido
                  value:
                    tag_uuid:
                      - Must be a valid UUID.
        '401':
          description: Credenciais em falta ou inválidas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros codificados, por exemplo
                      `networks_not_entitled`.
              examples:
                Missing or invalid credentials:
                  summary: Credenciais em falta 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 necessitam de uma chave de acesso
            total. Um token de membro da consola necessita de `write:networks`.
            Também é devolvido com `code: networks_not_entitled` quando o
            Networks não está ativado para a organização.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros codificados, por exemplo
                      `networks_not_entitled`.
              examples:
                Networks not enabled:
                  summary: Redes não ativadas
                  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: Não encontrado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    description: >-
                      Presente em erros codificados, por exemplo
                      `networks_not_entitled`.
              examples:
                Network not found:
                  summary: Rede não encontrada
                  value:
                    detail: Network not found.
                Tag not found:
                  summary: Etiqueta não encontrada
                  value:
                    detail: Tag not found.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/tags/add/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
        - 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.add_tag(
                "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                tag_uuid="7c9e6679-7425-40de-944b-e07fc1f90ae7",
            )
            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.addTag("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
              tag_uuid: "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            });

            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.AddTag(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.NetworkTagRequest{\n\tTagUUID: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.NetworkTagRequest;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            Didit client = new Didit();


            var result =
            client.networks().addTag("3fa85f64-5717-4562-b3fc-2c963f66afa6",
            NetworkTagRequest.builder()
                    .tagUuid("7c9e6679-7425-40de-944b-e07fc1f90ae7")
                    .build());
            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->addTag('3fa85f64-5717-4562-b3fc-2c963f66afa6', [
                'tag_uuid' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
            ]);

            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.add_tag(
              "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              tag_uuid: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
            )
            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.AddTagAsync("3fa85f64-5717-4562-b3fc-2c963f66afa6",
            new NetworkTagRequest

            {
                TagUuid = "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    NetworkTagRequest:
      type: object
      required:
        - tag_uuid
      properties:
        tag_uuid:
          type: string
          format: uuid
          description: UUID de uma das etiquetas da sua aplicação.
      example:
        tag_uuid: 7c9e6679-7425-40de-944b-e07fc1f90ae7
    NetworkDetailResponse:
      description: >-
        Os detalhes da rede, mais o modo de partilha da organização, se os
        sinais entre organizações se aplicam à mesma, as etiquetas da sua
        aplicação na rede, os resultados dos membros e as pontuações de padrões.
      allOf:
        - $ref: '#/components/schemas/NetworkDetail'
        - type: object
          properties:
            sharing_mode:
              type: string
              enum:
                - 'off'
                - private
                - global
              description: >-
                O modo de partilha entre organizações da organização. Apenas
                `global` compara redes entre organizações; `private` e `off`
                restringem-nas ao próprio histórico da organização.
              example: global
            cross_org_available:
              type: boolean
              description: >-
                Se os sinais entre organizações se aplicam a esta organização.
                Exigem tanto o plano Enterprise como o modo de partilha
                `global`.
              example: true
            cross_org_unavailable_reason:
              type: string
              enum:
                - plan
                - sharing_mode
              nullable: true
              description: >-
                O motivo pelo qual os sinais interorganizacionais não se
                aplicam, verificados por esta ordem. `plan`: o plano da
                organização não inclui a rede de fraude interorganizacional
                (requer o plano Enterprise), independentemente do modo de
                partilha. `sharing_mode`: o plano inclui-a, mas o modo de
                partilha é `private` ou `off`. Nulo quando `cross_org_available`
                é `true`.
              example: null
            tags:
              type: array
              items:
                $ref: '#/components/schemas/NetworkTag'
              description: >-
                As etiquetas da sua aplicação na rede, as mais antigas primeiro.
                Cada aplicação vê apenas as suas próprias etiquetas.
                `fraud_tags` é separado e não se altera: as etiquetas que os
                membros da rede possuem.
            outcomes:
              $ref: '#/components/schemas/NetworkOutcomes'
            patterns:
              type: array
              items:
                $ref: '#/components/schemas/NetworkPatternScore'
              description: >-
                Pontuações de padrão em toda a rede. Atualmente um item,
                `background`.
    NetworkDetail:
      allOf:
        - $ref: '#/components/schemas/NetworkListItem'
        - type: object
          properties:
            stats:
              type: object
              description: >-
                Estatísticas agregadas para a rede (por exemplo, totais de
                membros).
            fraud_tags:
              type: array
              items:
                type: object
              description: Etiquetas de padrões de fraude identificadas na rede.
            risk_signals:
              type: object
              description: >-
                Resumos de sinais de risco: residential_proxy_reuse,
                email_intelligence, phone_intelligence.
            reviewed_at:
              type: string
              format: date-time
              nullable: true
            reviewed_by:
              type: string
              nullable: true
            review_reason:
              type: string
              nullable: true
      properties:
        notes_count:
          type: integer
          minimum: 0
          readOnly: true
          description: Número de notas privadas do analista nesta investigação.
    NetworkTag:
      type: object
      description: Uma das etiquetas da sua aplicação na rede.
      properties:
        uuid:
          type: string
          format: uuid
          description: O UUID da etiqueta, o mesmo valor transmitido como `tag_uuid`.
        name:
          type: string
        color:
          type: string
          description: Cor hexadecimal, por exemplo `#6366F1`.
        source:
          type: string
          enum:
            - didit
            - custom
          description: >-
            `didit` para uma etiqueta predefinida da Didit, `custom` para uma
            etiqueta criada pela sua equipa.
        added_by:
          type: string
          nullable: true
          description: >-
            E-mail do membro da consola que adicionou a etiqueta. Null quando
            adicionada por uma chave de API.
        added_at:
          type: string
          format: date-time
    NetworkOutcomes:
      type: object
      description: >-
        O estado em que se encontram as pessoas e empresas da rede. Cada membro
        que possa ver conta uma vez, pelo estado da sua verificação mais recente
        que tenha chegado a uma decisão. As partes da transação não são
        contabilizadas.
      properties:
        approved:
          type: integer
          description: Membros cuja verificação decidida mais recente foi aprovada.
        declined:
          type: integer
          description: Membros cuja verificação decidida mais recente foi recusada.
        in_review:
          type: integer
          description: Membros cuja verificação decidida mais recente está em análise.
        total:
          type: integer
          description: >-
            Membros com pelo menos uma verificação, decidida ou não. Um membro
            cujas verificações estejam todas indecisas (não iniciadas, em curso,
            expiradas ou abandonadas) é contabilizado aqui e em nenhuma outra
            chave.
    NetworkPatternScore:
      type: object
      description: >-
        O quão semelhantes são os dados de um determinado tipo dos membros em
        toda a rede. Um padrão não é um sinal: nenhum valor partilhado liga os
        membros.
      properties:
        type:
          type: string
          enum:
            - background
          description: >-
            `background`: a similaridade média de cada par de fundos das selfies
            dos membros, com a pessoa ocultada. Lê a selfie mais recente de cada
            pessoa, no máximo as 50 mais recentes, e exclui sessões de validação
            da idade. Abrange toda a rede, não apenas os membros das suas
            aplicações.
        score:
          type: number
          nullable: true
          minimum: 0
          maximum: 1
          description: >-
            De 0 a 1, arredondado a 4 casas decimais. Null quando `reason` está
            definido.
        members:
          type: integer
          nullable: true
          description: >-
            Quantas selfies de membros a pontuação comparou. Uma selfie que não
            possa ser lida, ou que mostre muito pouco fundo, não é comparada.
            Nulo enquanto estiver em `computing`; 0 ou 1 com
            `not_enough_selfies`.
        reason:
          type: string
          enum:
            - computing
            - not_enough_selfies
          nullable: true
          description: >-
            O motivo pelo qual não há pontuação. `computing`: a pontuação para
            os membros atuais está a ser calculada; consulte novamente a rede
            mais tarde. `not_enough_selfies`: menos de dois membros têm uma
            selfie utilizável. Nulo quando existe uma pontuação.
        computed_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quando a pontuação foi calculada. Nulo enquanto estiver em
            `computing`.
    NetworkListItem:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        network_id:
          type: string
          description: 'ID sequencial legível por humanos por organização, ex.: N-0001.'
        name:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - active
            - in_review
            - resolved
            - dismissed
          description: >-
            Estado do ciclo de vida da rede. Distinto do outcome_status por
            requerente dentro de uma rede
            (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: Os padrões de agrupamento detetados nesta rede.
        signal_types:
          type: array
          items:
            type: string
            enum:
              - ip_address
              - device
              - face
              - document_number
              - phone
              - email
              - address
          description: Os tipos de sinal distintos presentes nesta rede.
        member_counts:
          type: object
          description: >-
            Contagens de membros por categoria (por ex., total, por
            outcome_status).
        member_status:
          type: object
          description: Distribuição de membros por outcome_status.
        signal_coverage:
          type: object
          description: Cobertura dos membros desta rede por signal_type.
        first_activity_at:
          type: string
          format: date-time
          nullable: true
        last_activity_at:
          type: string
          format: date-time
          nullable: true
    NetworkRiskDisplay:
      type: object
      properties:
        score:
          type: integer
          description: Pontuação de risco, 0-100.
        band:
          type: string
          enum:
            - low
            - medium
            - high
          description: >-
            Faixa em que a pontuação é apresentada. high >= 70, medium >= 40,
            caso contrário low.
        bar:
          type: number
          format: float
          description: Valor normalizado de 0-1 para renderizar uma barra de risco.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, a partir de Programadores -> Chaves de
        API na Business Console. A chave principal tem acesso total. Uma chave
        nomeada pode ter o âmbito definido: nenhum, 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á
        incorreta, 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 o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs
        como nulos, e uma chave sem permissão de escrita em sessões recebe
        ligações de sessão e tokens como nulos. Consulte
        https://docs.didit.me/console/api-keys.

````

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