Saltar para o conteúdo principal
GET
cURL

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

settings_uuid
string<uuid>
obrigatório

UUID por versão do fluxo (o valor uuid devolvido pelo endpoint de listagem). Cada versão de um fluxo tem o seu próprio settings_uuid.

Resposta

Configuração completa do fluxo. O formato é a serialização bruta de VerificationSettings (~190 campos: cada alternador de funcionalidade, limiar, ação de aviso, configuração de documentos permitidos, o workflow_graph, política de nova tentativa, callbacks e preços). O exemplo abaixo está abreviado. Notas: features é uma cadeia de carateres unida por " + " (por exemplo, "OCR + LIVENESS"), os preços são números JSON e is_editable é true apenas para versões draft.

Os campos abaixo são tipados; o objeto também contém todas as outras colunas da configuração do fluxo (comutadores de funcionalidades, limiares, ações de aviso, documentos permitidos, callbacks) como propriedades adicionais. Os campos que não se aplicam ao workflow_type são null.

uuid
string<uuid>

Identificador por versão (settings_uuid). Cada versão de um fluxo tem o seu próprio.

workflow_id
string<uuid>

Identificador estável partilhado por todas as versões do fluxo. As sessões criadas com ele utilizam a versão publicada mais recente.

workflow_label
string

Nome de apresentação do fluxo.

workflow_type
enum<string> | null

Modelo de fluxo. null para fluxos em grafo criados sem um modelo.

Opções disponíveis:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Se este é o fluxo predefinido da aplicação.

is_archived
boolean

Os fluxos arquivados não podem iniciar novas sessões.

version
integer

Número da versão dentro do fluxo.

status
enum<string>

As versões de rascunho são editáveis; as versões publicadas são imutáveis e utilizadas para novas sessões.

Opções disponíveis:
draft,
published
published_at
string<date-time> | null

Quando esta versão foi publicada. null para rascunhos.

is_simple_workflow
boolean

true quando o fluxo não tem um workflow_graph personalizado.

is_editable
boolean

true apenas para versões draft.

workflow_url
string<uri>

URL público que inicia uma sessão com este fluxo.

workflow_graph
object | null

Estrutura em grafo do fluxo (nós e arestas). null para fluxos simples.

features
string

Funcionalidades ativadas unidas por " + ", por exemplo "OCR + LIVENESS".

total_price
number | null

Preço por sessão; para fluxos em grafo, o caminho mais caro.

min_price
number | null

Preço do caminho mais económico ao longo do fluxo.

max_price
number | null

Preço do caminho mais caro ao longo do fluxo.

special_add_on_prices
object | null

Preços de suplementos específicos da organização, ou null quando nenhum estiver definido.

max_retry_attempts
integer

Tentativas permitidas após uma verificação recusada.

retry_window_days
integer | null

Dias durante os quais as tentativas adicionais são permitidas.

session_expiration_time
integer

Segundos até uma sessão inacabada expirar.

questionnaire
object | null

O questionário associado ao fluxo, ou null.

kyb_role_settings
object[]

Definições de verificação por função para pessoas-chave de KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Quais os níveis de Assinatura eletrónica que podem assinar neste momento. Verifique antes de definir signature_level. Devolvido em fluxos de kyc, kyb e de grafo.

is_bank_verification_enabled
boolean

Se um fluxo simples de KYC ou KYB executa a verificação bancária. É executada após os passos de contacto (e a verificação de localização) e antes da validação de base de dados, AML e análise de IP. A verificação bancária ainda não está disponível de forma geral: a sua ativação é recusada onde não estiver ativada.

bank_verification_config
object

Definições de verificação bancária de um fluxo simples, com as mesmas chaves que um nó BANK_VERIFICATION aceita (por exemplo, bank_countries e bank_method_order). Chaves desconhecidas são ignoradas. Todas as chaves são opcionais e uma chave ausente mantém o seu valor predefinido, pelo que {} significa todas as predefinições. Consulte Definições de verificação bancária.

Exemplo:
is_geolocation_enabled
boolean

Se um fluxo simples de KYC executa a verificação de localização. É executada após os passos de contacto e antes da verificação bancária e da validação de base de dados. Os fluxos de empresas (KYB) não a podem executar.

geolocation_config
object

Definições de verificação de localização de um fluxo simples, com as mesmas chaves que um nó GEOLOCATION aceita (por exemplo is_geolocation_geofencing_enabled e geolocation_max_attempts). As chaves desconhecidas são ignoradas. Todas as chaves são opcionais e uma chave ausente mantém o seu valor padrão, pelo que {} significa todos os valores padrão.

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