Pular para o conteúdo principal
PATCH
curl
Os links pré-assinados em extra_files expiram. Obtenha links novos na decisão da sessão quando precisar dos arquivos mais tarde. Para corrigir os dados extraídos de um documento, use Atualizar dados da sessão.

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

UUID da sessão de Verificação de usuários (KYC) à qual o arquivo será adicionado (o session_id retornado por POST /v3/session/). Um ID de sessão de Verificação de empresas (KYB) retorna 404.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Corpo

multipart/form-data
file
file
obrigatório

A imagem ou o PDF. Extensões permitidas: jpg, jpeg, png, webp, tiff, pdf. No máximo 15 MB no envio; o arquivo é então comprimido e rejeitado com 400 se ainda for maior que 2 MB (2.097.152 bytes). Arquivos vazios são rejeitados.

model_type
enum<string>
obrigatório

kyc adiciona o arquivo ao resultado da verificação de identidade, poa ao resultado do Comprovante de endereço.

Opções disponíveis:
kyc,
poa
Exemplo:

"kyc"

file_password
string

Senha de um PDF criptografado. Sem ela, ou com uma senha errada, um PDF criptografado retorna 400.

Resposta

Arquivo adicionado. Retorna todos os arquivos extras desse resultado, incluindo o novo.

extra_files
(string<uri> | null)[]
obrigatório

Links pré-assinados de curta duração para todos os arquivos extras do resultado indicado por model_type, do mais antigo para o mais recente. Cada link é null para uma chave de API com escopo sem media: read. Obtenha links novos a partir da decisão da sessão posteriormente.

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