Pular para o conteúdo principal
PATCH
curl
As chaves dos campos são as que você configurou para o documento no fluxo de verificação (workflow). Consulte Document AI para ver como os documentos e os campos são configurados e o relatório do Document AI para saber onde o resultado aparece na decisão 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 (o session_id retornado por POST /v3/session/). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um 404 em HTML.

Exemplo:

"11111111-2222-3333-4444-555555555555"

documentUuid
string<uuid>
obrigatório

UUID do documento do Document AI (document_ai_documents[].items[].uuid em GET /v3/session/{sessionId}/decision/). Ele deve pertencer à sessão indicada no caminho.

Exemplo:

"44444444-5555-6666-7777-888888888888"

Corpo

application/json
extracted_data
object

Chaves de campo (as chaves que você configurou para o documento) e seus valores corrigidos. Deve ser um objeto JSON; mesclado chave por chave nos dados armazenados. Omita-o em vez de enviar null, que retorna 400.

Exemplo:
status
enum<string>

Novo status de revisão do documento.

Opções disponíveis:
Approved,
Declined,
In Review,
Not Finished
Exemplo:

"Approved"

Resposta

Documento atualizado. Retorna o documento após a mesclagem.

uuid
string<uuid>
obrigatório

Identificador do documento.

document_key
string
obrigatório

O documento configurado ao qual este upload corresponde.

original_filename
string | null
obrigatório

Nome do arquivo com o qual o documento foi enviado.

file_url
string | null
obrigatório

Caminho de armazenamento do arquivo enviado. Não é um link de download: leia o file_url pré-assinado na decisão da sessão para baixar o arquivo.

status
enum<string>
obrigatório

Status de revisão do documento.

Opções disponíveis:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
extracted_data
object | null
obrigatório

Todos os campos extraídos após a mesclagem, indexados pela chave do campo.

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