API de imagem de assinatura: PNG da assinatura adotada

Python

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

content = client.sessions.signatures.download_field_image(
    "11111111-2222-3333-4444-555555555555",
    "feature_signature",
    "11111111-2222-3333-4444-555555555555",
)
with open("download.png", "wb") as file:
    file.write(content)

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.sessions.signatures.downloadFieldImage(
  "11111111-2222-3333-4444-555555555555",
  "feature_signature",
  "11111111-2222-3333-4444-555555555555",
);
await writeFile("download.png", Buffer.from(await content.arrayBuffer()));

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

resp, err := client.Sessions.Signatures.DownloadFieldImage(ctx, "11111111-2222-3333-4444-555555555555", "feature_signature", "11111111-2222-3333-4444-555555555555")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()
file, err := os.Create("download.png")
if err != nil {
	log.Fatal(err)
}
defer file.Close()
if _, err := io.Copy(file, resp.Body); err != nil {
	log.Fatal(err)
}

import java.nio.file.Path;
import me.didit.Didit;

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

client.sessions().signatures().downloadFieldImage("11111111-2222-3333-4444-555555555555", "feature_signature", "11111111-2222-3333-4444-555555555555")
        .writeTo(Path.of("download.png"));

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$content = $didit->sessions->signatures->downloadFieldImage('11111111-2222-3333-4444-555555555555', 'feature_signature', '11111111-2222-3333-4444-555555555555');
$content->saveTo('download.png');

require "didit"

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

content = didit.sessions.signatures.download_field_image(
  "11111111-2222-3333-4444-555555555555",
  "feature_signature",
  "11111111-2222-3333-4444-555555555555"
)
File.binwrite("download.png", content)

using System;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var content = await client.Sessions.Signatures.DownloadFieldImageAsync("11111111-2222-3333-4444-555555555555", "feature_signature", "11111111-2222-3333-4444-555555555555");
await content.SaveToAsync("download.png");

"<string>"

{
  "code": "signature_document_changed",
  "detail": "signature_document_changed"
}

{
  "detail": "You do not have permission to perform this action."
}

{
  "code": "signature_field_not_found",
  "detail": "signature_field_not_found"
}

GET

session

{sessionId}

signatures

{nodeId}

fields

{fieldId}

image

Python

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

content = client.sessions.signatures.download_field_image(
    "11111111-2222-3333-4444-555555555555",
    "feature_signature",
    "11111111-2222-3333-4444-555555555555",
)
with open("download.png", "wb") as file:
    file.write(content)

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.sessions.signatures.downloadFieldImage(
  "11111111-2222-3333-4444-555555555555",
  "feature_signature",
  "11111111-2222-3333-4444-555555555555",
);
await writeFile("download.png", Buffer.from(await content.arrayBuffer()));

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

resp, err := client.Sessions.Signatures.DownloadFieldImage(ctx, "11111111-2222-3333-4444-555555555555", "feature_signature", "11111111-2222-3333-4444-555555555555")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()
file, err := os.Create("download.png")
if err != nil {
	log.Fatal(err)
}
defer file.Close()
if _, err := io.Copy(file, resp.Body); err != nil {
	log.Fatal(err)
}

import java.nio.file.Path;
import me.didit.Didit;

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

client.sessions().signatures().downloadFieldImage("11111111-2222-3333-4444-555555555555", "feature_signature", "11111111-2222-3333-4444-555555555555")
        .writeTo(Path.of("download.png"));

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$content = $didit->sessions->signatures->downloadFieldImage('11111111-2222-3333-4444-555555555555', 'feature_signature', '11111111-2222-3333-4444-555555555555');
$content->saveTo('download.png');

require "didit"

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

content = didit.sessions.signatures.download_field_image(
  "11111111-2222-3333-4444-555555555555",
  "feature_signature",
  "11111111-2222-3333-4444-555555555555"
)
File.binwrite("download.png", content)

using System;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var content = await client.Sessions.Signatures.DownloadFieldImageAsync("11111111-2222-3333-4444-555555555555", "feature_signature", "11111111-2222-3333-4444-555555555555");
await content.SaveToAsync("download.png");

"<string>"

{
  "code": "signature_document_changed",
  "detail": "signature_document_changed"
}

{
  "detail": "You do not have permission to perform this action."
}

{
  "code": "signature_field_not_found",
  "detail": "signature_field_not_found"
}

Retorna, em PNG, a assinatura ou as iniciais que um signatário aplicou a um campo. O caminho está no image_url do campo, em signatures[].documents[].fields[], então você não precisa montá-lo. É necessária a permissão read:sessions.

curl -L 'https://verification.didit.me/v3/session/{session_id}/signatures/{node_id}/fields/{field_id}/image/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -o signature.png

Uma assinatura desenhada é a imagem que o signatário desenhou, e é essa imagem que é carimbada no PDF assinado. Uma assinatura digitada é o nome verificado do signatário no estilo de caligrafia que ele escolheu, e o PDF assinado a contém como texto nesse mesmo estilo. Como prova da assinatura em si, use o documento assinado e as evidências. Um campo que não pertence ao signatário, ou que não tem assinatura ou iniciais aplicadas, retorna 404 com signature_field_not_found. Uma imagem armazenada cujo SHA-256 não corresponde mais ao registrado retorna 400 com signature_document_changed. Depois que você exclui a sessão, a rota retorna 404.

Relacionados

Autorizações

x-api-key

string

header

obrigatório

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.

Parâmetros de caminho

sessionId

string<uuid>

obrigatório

A sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB).

Exemplo:

"11111111-2222-3333-4444-555555555555"

nodeId

string

obrigatório

A etapa de Assinatura eletrônica: node_id do item em signatures[].

Exemplo:

"feature_signature"

fieldId

string<uuid>

obrigatório

O campo na cópia deste signatário, como no image_url do campo.

Resposta

A imagem.

The response is of type file.

Última modificação em 1 de novembro de 2026

​Relacionados

Autorizações

Parâmetros de caminho

Resposta

Relacionados