Saltar para o conteúdo principal
PATCH
curl
As chaves dos campos são as que configurou para o documento no fluxo. Consulte o Document AI para saber 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

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.

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 de Verificação de utilizadores (KYC) e de Verificação de empresas (KYB): o servidor resolve o ID em ambos os tipos de sessão. Deve ser um UUID bem formatado; um valor mal formatado não corresponde à rota e retorna um 404 em HTML.

Exemplo:

"11111111-2222-3333-4444-555555555555"

documentUuid
string<uuid>
obrigatório

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

Exemplo:

"44444444-5555-6666-7777-888888888888"

Corpo

application/json
extracted_data
object

Chaves dos campos (as chaves que configurou para o documento) e os respetivos valores corrigidos. Tem de ser um objeto JSON; é intercalado chave a chave nos dados armazenados. Omita este campo em vez de enviar null, o que devolve 400.

Exemplo:
status
enum<string>

Novo estado de revisão do documento.

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

"Approved"

Resposta

Documento atualizado. Devolve o documento após a intercalação.

uuid
string<uuid>
obrigatório

Identificador do documento.

document_key
string
obrigatório

O documento configurado a que este carregamento corresponde.

original_filename
string | null
obrigatório

Nome do ficheiro com o qual o documento foi carregado.

file_url
string | null
obrigatório

Caminho de armazenamento do ficheiro carregado. Não é uma ligação de transferência: leia o file_url pré-assinado a partir da decisão da sessão para transferir o ficheiro.

status
enum<string>
obrigatório

Estado 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 união, indexados pela chave do campo.

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