> ## 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 Relatório PDF de Triagem de Carteiras

> Gere um PDF de triagem de carteira com a marca Didit, reenviando o JSON do endpoint de triagem. Sem estado, sem chamada ao fornecedor, sem faturação extra.



Prompt do PDF de triagem de carteiras
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Render a previously returned on-demand wallet-screening result as a Didit-branded PDF, through the Didit Management API.

Endpoint:
POST https://verification.didit.me/v3/wallet-screening/pdf/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Turn a wallet-screening JSON result into a downloadable PDF report. This is stateless: nothing is persisted, no provider is called again, and there is no additional billing.

Prerequisites:
\- You must already have the exact JSON body that POST /v3/wallet-screening/ returned, including its report_signature field. This endpoint does not accept a hand-built or edited payload.

Request body (application/json):
\- The full, unmodified response body from POST /v3/wallet-screening/ (or its console equivalent), including report_signature.

Example call:
curl -X POST "https://verification.didit.me/v3/wallet-screening/pdf/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d "$RESULT" \
-o wallet_screening_report.pdf

Response:
\- Body is binary (application/pdf). DO NOT parse as JSON.
\- Content-Type: application/pdf
\- Content-Disposition: attachment; filename=wallet_screening_<address>.pdf

Failure modes:
\- 400 - the body is not a JSON object matching the wallet-screening result shape, or report_signature is missing or invalid (the result was edited, truncated, or hand-built instead of reposted verbatim).
\- 401 - missing or invalid x-api-key.

For the underlying screening call, see /management-api/transactions/screen-wallet.`

\</pre>



      
      

Colar em

## Por que não tem estadoA triagem de carteiras independente não grava nada na tabela de transações, por isso não existe um registo guardado a partir do qual este endpoint possa gerar o PDF. Em vez disso, volta a enviar o JSON exato que `POST /v3/wallet-screening/` já devolveu, e a Didit transforma esse payload num PDF sem voltar a chamar um fornecedor.## O campo `report_signature`Cada resposta de `POST /v3/wallet-screening/` inclui agora um campo `report_signature`, uma assinatura opaca específica da sua aplicação. Este endpoint verifica-a antes de gerar o PDF, para que quem chama não consiga alterar `risk_score`, `severity`, `sanctions_hit` ou qualquer outro campo e obter um PDF com aspeto legítimo e com a marca Didit para um resultado que a Didit nunca produziu.Reenvie sempre o corpo completo da resposta **sem alterações**, incluindo `report_signature`. Reordenar as chaves é aceitável; alterar qualquer valor assinado não é.```bash theme={null}
# 1. Run the screening and save the full response
RESULT=$(curl -s -X POST https://verification.didit.me/v3/wallet-screening/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wallet_address": "0x28c6c06298d514db089934071355e5743bf21d60", "blockchain": "ETH"}')

# 2. Repost it verbatim to render the PDF
curl -X POST https://verification.didit.me/v3/wallet-screening/pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d "$RESULT" \
  -o wallet_screening_report.pdf
```## FaturaçãoNão é feita nenhuma chamada a um fornecedor e nada é faturado: isto apenas volta a gerar um resultado pelo qual já pagou quando chamou `POST /v3/wallet-screening/`.## Erros| Estado | Significado |
| - | - |
| `400` | O corpo não é um objeto JSON que corresponda à estrutura do resultado de triagem de carteiras, ou `report_signature` está em falta ou não corresponde aos campos reenviados. |
| `401` | `x-api-key` em falta ou inválida. |## Próximos passos> [card] [Triagem de carteiras](https://docs.didit.me/pt/management-api/transactions/screen-wallet.md)
>
> Execute a triagem de carteiras subjacente mediante pedido e obtenha o resultado JSON para reenviar aqui.> [card] [Triagem de carteiras a pedido](https://docs.didit.me/pt/transaction-monitoring/wallet-screening.md)
>
> Visão geral do endpoint de triagem de carteiras independente e do modelo de resultados.


## OpenAPI

````yaml pt/openapi-25.json POST /v3/wallet-screening/pdf/
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/wallet-screening/pdf/:
    post:
      tags:
        - Transactions
      summary: Renderizar o resultado de uma triagem de carteiras em PDF
      description: >-
        Complemento sem estado para `POST /v3/wallet-screening/`: envie
        novamente o corpo JSON exato devolvido por esse endpoint — incluindo a
        `report_signature` adicionada — e receba um PDF com a marca Didit do
        mesmo resultado. Nenhum fornecedor é chamado e nada é faturado ou
        persistido; isto apenas volta a compor um resultado que a Didit já
        produziu. A assinatura vincula o PDF a um resultado não modificado:
        editar `risk_score`, `severity`, `sanctions_hit` ou qualquer outro campo
        assinado antes do reenvio falha com `400`.
      operationId: screenWalletPdf
      requestBody:
        required: true
        description: >-
          O objeto JSON não modificado devolvido por `POST
          /v3/wallet-screening/`, incluindo `report_signature`.
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/WalletScreeningResult'
              required:
                - report_signature
              description: >-
                O mesmo formato que a resposta de `POST /v3/wallet-screening/` —
                transmita esse corpo de resposta textualmente, incluindo
                `report_signature`.
      responses:
        '200':
          description: >-
            O documento PDF renderizado, devolvido diretamente como binário
            `application/pdf` — não há invólucro JSON.
          headers:
            Content-Disposition:
              description: >-
                `attachment; filename=wallet_screening_{address}.pdf`, derivado
                de `wallet_address` (ou `transaction_hash`) no resultado
                republicado.
              schema:
                type: string
                example: >-
                  attachment;
                  filename=wallet_screening_0x28c6c06298d514db0899.pdf
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: >-
            O corpo não é um objeto JSON correspondente à estrutura de
            resultados de triagem de carteiras, ou `report_signature` está em
            falta ou não corresponde aos campos reenviados (editados ou
            truncados antes do reenvio).
          content:
            application/json:
              schema:
                type: object
              examples:
                Not an object:
                  value:
                    non_field_errors:
                      - >-
                        Expected a JSON object matching a wallet-screening
                        result.
                Missing or invalid signature:
                  value:
                    report_signature:
                      - >-
                        This wallet-screening result is missing or fails its
                        report signature - repost the exact JSON returned by the
                        wallet-screening endpoint, unmodified.
        '401':
          description: '`x-api-key` em falta ou inválido.'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            # $RESULT is the saved JSON body from POST /v3/wallet-screening/

            curl -X POST
            'https://verification.didit.me/v3/wallet-screening/pdf/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d "$RESULT" \
              -o wallet_screening_report.pdf
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            content = client.wallet_screening.screen_pdf(
                provider="your-provider",
                screening_type="WALLET_SCREENING",
                risk_score=1,
                severity="UNKNOWN",
                status="SCREENED",
                summary="your-summary",
                wallet_address="your-wallet-address",
                blockchain="your-blockchain",
                source_of_funds=[{}],
                destination_of_funds=[{}],
                counterparty_connections=[{}],
                sanctions_hit=True,
                dominant_risk_category="your-dominant-risk-category",
                report_signature="your-report-signature",
            )
            with open("download.pdf", "wb") as file:
                file.write(content)
        - lang: javascript
          label: Node.js
          source: >-
            import { writeFile } from "node:fs/promises";

            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const content = await didit.walletScreening.screenPdf({
              provider: "your-provider",
              screening_type: "WALLET_SCREENING",
              risk_score: 1,
              severity: "UNKNOWN",
              status: "SCREENED",
              summary: "your-summary",
              wallet_address: "your-wallet-address",
              blockchain: "your-blockchain",
              source_of_funds: [{}],
              destination_of_funds: [{}],
              counterparty_connections: [{}],
              sanctions_hit: true,
              dominant_risk_category: "your-dominant-risk-category",
              report_signature: "your-report-signature",
            });

            await writeFile("download.pdf", Buffer.from(await
            content.arrayBuffer()));
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.WalletScreening.ScreenPDF(ctx, didit.WalletScreeningResultParam{\n\tProvider:                \"your-provider\",\n\tScreeningType:           \"WALLET_SCREENING\",\n\tRiskScore:               1,\n\tSeverity:                \"UNKNOWN\",\n\tStatus:                  \"SCREENED\",\n\tSummary:                 \"your-summary\",\n\tWalletAddress:           \"your-wallet-address\",\n\tBlockchain:              \"your-blockchain\",\n\tSourceOfFunds:           []didit.WalletScreeningResultParamSourceOfFunds{{}},\n\tDestinationOfFunds:      []didit.WalletScreeningResultParamDestinationOfFunds{{}},\n\tCounterpartyConnections: []didit.WalletScreeningResultParamCounterpartyConnections{{}},\n\tSanctionsHit:            true,\n\tDominantRiskCategory:    didit.String(\"your-dominant-risk-category\"),\n\tReportSignature:         \"your-report-signature\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import java.nio.file.Path;
            import java.util.List;
            import me.didit.Didit;
            import me.didit.types.WalletScreeningResult;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            client.walletScreening().screenPdf(WalletScreeningResult.builder()
                    .provider("your-provider")
                    .screeningType(WalletScreeningResult.ScreeningType.of("WALLET_SCREENING"))
                    .riskScore(1L)
                    .severity(WalletScreeningResult.Severity.of("UNKNOWN"))
                    .status(WalletScreeningResult.Status.of("SCREENED"))
                    .summary("your-summary")
                    .walletAddress("your-wallet-address")
                    .blockchain("your-blockchain")
                    .sourceOfFunds(List.of(WalletScreeningResult.SourceOfFunds.builder()
                            .build()))
                    .destinationOfFunds(List.of(WalletScreeningResult.DestinationOfFunds.builder()
                            .build()))
                    .counterpartyConnections(List.of(WalletScreeningResult.CounterpartyConnections.builder()
                            .build()))
                    .sanctionsHit(true)
                    .dominantRiskCategory("your-dominant-risk-category")
                    .reportSignature("your-report-signature")
                    .build())
                    .writeTo(Path.of("download.pdf"));
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $content = $didit->walletScreening->screenPdf([
                'provider' => 'your-provider',
                'screening_type' => 'WALLET_SCREENING',
                'risk_score' => 1,
                'severity' => 'UNKNOWN',
                'status' => 'SCREENED',
                'summary' => 'your-summary',
                'wallet_address' => 'your-wallet-address',
                'blockchain' => 'your-blockchain',
                'source_of_funds' => [[]],
                'destination_of_funds' => [[]],
                'counterparty_connections' => [[]],
                'sanctions_hit' => true,
                'dominant_risk_category' => 'your-dominant-risk-category',
                'report_signature' => 'your-report-signature',
            ]);
            $content->saveTo('download.pdf');
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            content = didit.wallet_screening.screen_pdf(
              provider: "your-provider",
              screening_type: "WALLET_SCREENING",
              risk_score: 1,
              severity: "UNKNOWN",
              status: "SCREENED",
              summary: "your-summary",
              wallet_address: "your-wallet-address",
              blockchain: "your-blockchain",
              source_of_funds: [{}],
              destination_of_funds: [{}],
              counterparty_connections: [{}],
              sanctions_hit: true,
              dominant_risk_category: "your-dominant-risk-category",
              report_signature: "your-report-signature"
            )
            File.binwrite("download.pdf", content)
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var content = await client.WalletScreening.ScreenPdfAsync(new
            WalletScreeningResult

            {
                Provider = "your-provider",
                ScreeningType = "WALLET_SCREENING",
                RiskScore = 1,
                Severity = "UNKNOWN",
                Status = "SCREENED",
                Summary = "your-summary",
                WalletAddress = "your-wallet-address",
                Blockchain = "your-blockchain",
                SourceOfFunds = new WalletScreeningResultSourceOfFunds[] { new() },
                DestinationOfFunds = new WalletScreeningResultDestinationOfFunds[] { new() },
                CounterpartyConnections = new WalletScreeningResultCounterpartyConnections[] { new() },
                SanctionsHit = true,
                DominantRiskCategory = "your-dominant-risk-category",
                ReportSignature = "your-report-signature",
            });

            await content.SaveToAsync("download.pdf");
components:
  schemas:
    WalletScreeningResult:
      type: object
      properties:
        provider:
          type: string
          description: >-
            Fornecedor que realizou a triagem (por exemplo, `merklescience`,
            `crystal`).
        screening_type:
          type: string
          enum:
            - WALLET_SCREENING
          description: Sempre `WALLET_SCREENING` para este endpoint.
        risk_score:
          type: integer
          description: >-
            Pontuação de risco normalizada de 0-100. Um valor mais alto
            significa maior exposição a entidades de risco. A Merkle Science
            classifica um endereço de 0 a 5, o que mapeia para 0, 15, 35, 55, 75
            ou 95.
        severity:
          type: string
          enum:
            - UNKNOWN
            - LOW
            - MEDIUM
            - HIGH
            - CRITICAL
          description: >-
            Intervalo de risco derivado de `risk_score`: `0-9` UNKNOWN, `10-39`
            LOW, `40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` é a
            faixa mais baixa, não um estado separado sem dados: um `risk_score`
            de 0 (o caso comum de endereço limpo) significa que não há avaliação
            adversa, enquanto uma pontuação diferente de zero no intervalo de 1
            a 9 é um sinal real, mas abaixo de LOW - leia o `risk_score`, não
            apenas a faixa. Nunca trate `UNKNOWN` como uma classificação
            afirmativa de baixo risco ou limpa; não a apresente como aprovação.
        status:
          type: string
          enum:
            - SCREENED
            - PENDING
            - ERROR
          description: Estado do resultado da triagem.
        summary:
          type: string
          description: Resumo legível por humanos do resultado da triagem.
        wallet_address:
          type: string
          description: O endereço submetido a triagem, devolvido tal como foi recebido.
        transaction_hash:
          type: string
          nullable: true
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. É sempre `null` num resultado de triagem de carteiras.
        blockchain:
          type: string
          description: A blockchain que foi analisada.
        block_timestamp:
          type: string
          nullable: true
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. É sempre `null` num resultado de triagem de carteiras.
        total_value_usd:
          type: number
          nullable: true
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. É sempre `null` num resultado de triagem de carteiras.
        fee_usd:
          type: number
          nullable: true
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. É sempre `null` num resultado de triagem de carteiras.
        sender_rows:
          type: array
          items:
            type: object
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. Está sempre vazio num resultado de triagem de carteiras.
        receiver_rows:
          type: array
          items:
            type: object
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. Está sempre vazio num resultado de triagem de carteiras.
        transaction_flows:
          type: array
          items:
            type: object
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. Está sempre vazio num resultado de triagem de carteiras.
        transaction_flows_status:
          type: string
          nullable: true
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. É sempre `null` num resultado de triagem de carteiras.
        transaction_flows_error:
          type: string
          nullable: true
          description: >-
            Campo de triagem de transações, partilhado com o formato do
            resultado. É sempre `null` num resultado de triagem de carteiras.
        source_of_funds:
          type: array
          description: >-
            De onde o endereço recebeu fundos, atribuídos por entidade. Cada
            entrada é um detalhe de exposição.
          items:
            type: object
            properties:
              category:
                type: string
                description: >-
                  Categoria de risco normalizada, por exemplo,
                  `exchange_licensed`, `dex`, `defi`, `payment_processor`,
                  `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`,
                  `high_risk_exchange`.
              percentage:
                type: number
                description: Percentagem da exposição total da direção, 0-100.
              amount_usd:
                type: number
                nullable: true
                description: Valor em USD atribuído a esta entidade.
              entity_name:
                type: string
                nullable: true
                description: >-
                  Nome da entidade atribuída, por exemplo uma exchange, um
                  misturador ou um grupo sancionado.
              entity_type:
                type: string
                nullable: true
                description: >-
                  Tipo de entidade do fornecedor (por exemplo, `Exchange`,
                  `DeFi`, `Sanctions`, `Theft`).
              entity_subtype:
                type: string
                nullable: true
                description: >-
                  Subtipo mais granular (p. ex., `Mandatory KYC and AML`,
                  `OFAC`, `Yield Aggregator`).
              hops:
                type: integer
                nullable: true
                description: >-
                  Número de saltos até à entidade (1 para uma contraparte
                  direta), quando o fornecedor indicar um. Sempre `null` para a
                  Merkle Science, que apenas indica se a exposição é direta ou
                  indireta: utilize `exposure_type`.
              description:
                type: string
                nullable: true
                description: >-
                  `entity_type / entity_subtype`, tal como o fornecedor rotula a
                  entidade.
              is_direct:
                type: boolean
                description: True quando `exposure_type` é `direct`.
              exposure_direction:
                type: string
                enum:
                  - incoming
                  - outgoing
                  - connected
                description: >-
                  Indica se os fundos provieram (`incoming`) ou foram enviados
                  para (`outgoing`) esta entidade.
              exposure_type:
                type: string
                enum:
                  - direct
                  - indirect
                description: Exposição `direct` (1 salto) ou `indirect` (múltiplos saltos).
              provider_entity_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para a entidade.
              provider_entity_type_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para `entity_type`.
              provider_entity_subtype_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para `entity_subtype`.
              country:
                type: string
                nullable: true
                description: >-
                  País principal da entidade, segundo a norma ISO 3166-1
                  alpha-2. Vazio ou `null` quando o fornecedor não o conhece.
              raw_amount:
                type: number
                nullable: true
                description: >-
                  Montante na própria unidade do ativo, quando o fornecedor o
                  reporta.
              raw_currency:
                type: string
                nullable: true
                description: Unidade de `raw_amount`, quando o fornecedor a comunica.
        destination_of_funds:
          type: array
          description: >-
            Para onde o endereço enviou fundos, atribuídos por entidade. Mesma
            estrutura de itens que `source_of_funds` com `exposure_direction` =
            `outgoing`.
          items:
            type: object
            properties:
              category:
                type: string
                description: >-
                  Categoria de risco normalizada, por exemplo,
                  `exchange_licensed`, `dex`, `defi`, `payment_processor`,
                  `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`,
                  `high_risk_exchange`.
              percentage:
                type: number
                description: Percentagem da exposição total da direção, 0-100.
              amount_usd:
                type: number
                nullable: true
                description: Valor em USD atribuído a esta entidade.
              entity_name:
                type: string
                nullable: true
                description: >-
                  Nome da entidade atribuída, por exemplo uma exchange, um
                  misturador ou um grupo sancionado.
              entity_type:
                type: string
                nullable: true
                description: >-
                  Tipo de entidade do fornecedor (por exemplo, `Exchange`,
                  `DeFi`, `Sanctions`, `Theft`).
              entity_subtype:
                type: string
                nullable: true
                description: >-
                  Subtipo mais granular (p. ex., `Mandatory KYC and AML`,
                  `OFAC`, `Yield Aggregator`).
              hops:
                type: integer
                nullable: true
                description: >-
                  Número de saltos até à entidade (1 para uma contraparte
                  direta), quando o fornecedor indicar um. Sempre `null` para a
                  Merkle Science, que apenas indica se a exposição é direta ou
                  indireta: utilize `exposure_type`.
              description:
                type: string
                nullable: true
                description: >-
                  `entity_type / entity_subtype`, tal como o fornecedor rotula a
                  entidade.
              is_direct:
                type: boolean
                description: True quando `exposure_type` é `direct`.
              exposure_direction:
                type: string
                enum:
                  - incoming
                  - outgoing
                  - connected
                description: >-
                  Indica se os fundos provieram (`incoming`) ou foram enviados
                  para (`outgoing`) esta entidade.
              exposure_type:
                type: string
                enum:
                  - direct
                  - indirect
                description: Exposição `direct` (1 salto) ou `indirect` (múltiplos saltos).
              provider_entity_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para a entidade.
              provider_entity_type_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para `entity_type`.
              provider_entity_subtype_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para `entity_subtype`.
              country:
                type: string
                nullable: true
                description: >-
                  País principal da entidade, segundo a norma ISO 3166-1
                  alpha-2. Vazio ou `null` quando o fornecedor não o conhece.
              raw_amount:
                type: number
                nullable: true
                description: >-
                  Montante na própria unidade do ativo, quando o fornecedor o
                  reporta.
              raw_currency:
                type: string
                nullable: true
                description: Unidade de `raw_amount`, quando o fornecedor a comunica.
        counterparty_connections:
          type: array
          description: >-
            Entidades às quais o fornecedor atribui o endereço submetido a
            triagem. Para a Merkle Science, estas provêm das etiquetas de
            proprietário e utilizador do próprio endereço, pelo que a mesma
            entidade pode surgir duas vezes, e não transportam fluxos de fundos:
            `received_usd`, `sent_usd`, `received_hops` e `sent_hops` são `null`
            e `percentage` é 0. Não efetue o encaminhamento com base em
            `risk_level` ou `is_direct` aqui: utilize `sanctions_hit`,
            `dominant_risk_category` e `risk_factors[].is_high_risk` para o
            veredito, e `exposure_type` em
            `source_of_funds`/`destination_of_funds` para aferir a ligação
            direta.
          items:
            type: object
            properties:
              entity_name:
                type: string
                nullable: true
                description: Nome da entidade atribuída.
              entity_type:
                type: string
                nullable: true
                description: Tipo de entidade do fornecedor.
              entity_subtype:
                type: string
                nullable: true
                description: Subtipo de entidade do fornecedor.
              risk_level:
                type: string
                description: >-
                  Em minúsculas e dependente do fornecedor. Para a Merkle
                  Science, é o próprio grau de risco de 0 a 5 do endereço
                  (`no_risk`, `low`, `medium_low`, `medium`, `high`,
                  `critical`), elevado para `high` quando a categoria da
                  entidade é de alto risco; não é um grau separado da entidade.
              categories:
                type: array
                items:
                  type: string
                description: Categorias de risco normalizadas da entidade.
              received_usd:
                type: number
                nullable: true
                description: USD recebidos da entidade, quando comunicado pelo fornecedor.
              sent_usd:
                type: number
                nullable: true
                description: >-
                  USD enviados para a entidade, quando comunicado pelo
                  fornecedor.
              received_hops:
                type: integer
                nullable: true
                description: >-
                  Saltos até à entidade no lado recetor, quando o fornecedor os
                  comunica.
              sent_hops:
                type: integer
                nullable: true
                description: >-
                  Saltos até à entidade no lado emissor, quando o fornecedor os
                  comunica.
              percentage:
                type: number
                description: >-
                  Percentagem de exposição do endereço, quando comunicada pelo
                  fornecedor; caso contrário, 0.
              is_direct:
                type: boolean
                description: >-
                  Sempre `true` para a Merkle Science, cujas ligações são
                  atribuições em vez de contrapartes.
              country:
                type: string
                nullable: true
                description: País da entidade, quando conhecido.
              provider_entity_id:
                type: string
                nullable: true
                description: O identificador próprio do fornecedor para a entidade.
        network_nodes:
          type: array
          items:
            type: object
          description: >-
            Nós do grafo de exposição para triagem de transações. Vazio no
            resultado de uma triagem de carteiras.
        network_edges:
          type: array
          items:
            type: object
          description: >-
            Arestas do grafo de exposição para triagem de transações. Vazio no
            resultado de uma triagem de carteiras.
        sanctions_hit:
          type: boolean
          description: True se o endereço tiver exposição direta ou indireta a sanções.
        pep_counterparty:
          type: boolean
          description: >-
            Exposição como pessoa politicamente exposta. `null` quando não há
            qualquer conclusão de PEP disponível, o que corresponde a todos os
            resultados atualmente porque nenhum fornecedor o comunica; `false`
            apenas para um resultado de triagem explicitamente negativo. Não
            interprete `null` como uma verificação de PEP concluída.
          nullable: true
        dominant_risk_category:
          type: string
          nullable: true
          description: >-
            Categoria de alto risco com maior peso, ou `null` quando nenhuma é
            dominante (ex.: `sanctioned`, `mixer`, `stolen_funds`).
        risk_factors:
          type: array
          description: >-
            Explicação classificada de `risk_score`: o que produziu este
            veredito. Os fornecedores avaliam um endereço no seu próprio modelo
            e devolvem apenas um veredito (a Merkle Science devolve um número
            inteiro de 0 a 5), pelo que a pontuação por si só não é acionável.
            Com os elementos de maior risco primeiro e, depois, ordenada pelo
            valor movimentado através de cada fator, limitada aos cinco mais
            fortes; `source_of_funds` e `destination_of_funds` incluem sempre o
            detalhe completo. Um `risk_score` elevado sem nenhuma entrada
            `is_high_risk` significa que o fornecedor não reportou sanções nem
            qualquer correspondência com entidades atribuídas e avaliou o
            endereço puramente no seu próprio modelo de exposição - o `summary`
            indica isto explicitamente.
          items:
            type: object
            properties:
              source:
                type: string
                enum:
                  - attribution
                  - exposure
                description: >-
                  `attribution` é o que o fornecedor indica que o próprio
                  endereço é (a sua própria etiqueta ou cluster); `exposure` é
                  para onde os respetivos fundos foram efetivamente
                  movimentados.
              category:
                type: string
                description: >-
                  Categoria de risco normalizada, o mesmo vocabulário da
                  desagregação de exposição.
              label:
                type: string
                description: >-
                  A redação própria do fornecedor para o fator (por ex.
                  `Gambling / Crypto only`), que é também o que veria na consola
                  do fornecedor.
              entity_name:
                type: string
                nullable: true
                description: >-
                  Entidade atribuída por trás do motor, por exemplo, um site de
                  apostas ou uma exchange.
              direction:
                type: string
                enum:
                  - incoming
                  - outgoing
                  - connected
                  - unknown
                  - attribution
                description: >-
                  Direção do fluxo de fundos, `attribution` quando o fator
                  determinante é a própria etiqueta do endereço, ou `unknown`
                  quando o fornecedor não comunicou uma direção.
              exposure_type:
                type: string
                enum:
                  - direct
                  - indirect
                  - unknown
                  - attribution
                description: >-
                  `direct` (1 salto) ou `indirect` (múltiplos saltos),
                  `attribution` para a própria etiqueta do endereço, ou
                  `unknown` quando o fornecedor não indicou a quantos saltos de
                  distância está a contraparte. Trate `unknown` como não
                  classificado, e não como `direct`.
              amount_usd:
                type: number
                format: float
                nullable: true
                description: Valor em USD atribuído a este fator.
              percentage:
                type: number
                format: float
                description: >-
                  Percentagem do volume TOTAL analisado do endereço, combinando
                  ambas as direções - ao contrário de `percentage` dentro de
                  `source_of_funds`/`destination_of_funds`, que é normalizado
                  por direção. Comparável e somável em toda a lista.
              is_high_risk:
                type: boolean
                description: >-
                  Indica se a categoria é considerada de alto risco pela Didit
                  (`sanctioned`, `mixer`, `stolen_funds`, `ransomware`, `scam`,
                  `darknet_market`, `terrorist_financing`, `child_exploitation`,
                  `hacked_exchange`, `high_risk_exchange`, `seized_funds`).
              description:
                type: string
                description: >-
                  Apresentação numa única linha do fator determinante, p. ex.,
                  `9.01% indirect outgoing exposure to Gambling / Crypto only
                  (Example Gambling)`.
        raw_response:
          type: object
          additionalProperties: true
          description: >-
            O payload próprio do fornecedor. O seu formato é específico do
            fornecedor e pode mudar sem aviso prévio: leia os campos
            normalizados em vez de o analisar diretamente.
        report_signature:
          type: string
          description: >-
            Assinatura HMAC-SHA256 opaca sobre este resultado exato, com âmbito
            restrito à sua aplicação. Não tem significado por si só — reenvie o
            corpo completo da resposta, sem modificações e incluindo este campo,
            para `POST /v3/wallet-screening/pdf/` para o renderizar como um PDF.
            O endpoint de PDF rejeita o pedido com `400` se `report_signature`
            estiver em falta ou se qualquer campo assinado (por exemplo,
            `risk_score`, `severity`, `sanctions_hit`) tiver sido editado antes
            do reenvio.
      required:
        - provider
        - screening_type
        - risk_score
        - severity
        - status
        - summary
        - wallet_address
        - blockchain
        - sanctions_hit
        - dominant_risk_category
        - source_of_funds
        - destination_of_funds
        - counterparty_connections
        - report_signature
  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.