Pular para o conteúdo principal
GET
cURL

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

settings_uuid
string<uuid>
obrigatório

UUID da versão do fluxo (o valor uuid retornado 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 ativação de recurso, limiar, ação de aviso, configuração de documentos permitidos, o workflow_graph, a política de novas tentativas, os callbacks e os preços). O exemplo abaixo está abreviado. Observações: features é uma string unida por " + " (por exemplo, "OCR + LIVENESS"), os preços são números JSON e is_editable é true somente para versões draft.

Os campos abaixo são tipados; o objeto também traz todas as outras colunas da configuração do fluxo de verificação (ativação de recursos, 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 da versão (settings_uuid). Cada versão de um fluxo tem o seu próprio.

workflow_id
string<uuid>

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

workflow_label
string

Nome de exibição do fluxo.

workflow_type
enum<string> | null

Modelo do fluxo. null para fluxos em grafo criados sem 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 de verificação (workflow) padrão da aplicação.

is_archived
boolean

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 usadas 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ública que inicia uma sessão com este fluxo.

workflow_graph
object | null

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

features
string

Recursos ativados unidos 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 barato do fluxo.

max_price
number | null

Preço do caminho mais caro do fluxo.

special_add_on_prices
object | null

Preços de complementos específicos da organização, ou null quando nenhum está definido.

max_retry_attempts
integer

Novas tentativas permitidas após uma verificação recusada.

retry_window_days
integer | null

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

session_expiration_time
integer

Segundos até a expiração de uma sessão não concluída.

questionnaire
object | null

O questionário vinculado ao fluxo, ou null.

kyb_role_settings
object[]

Configurações de verificação por função para as pessoas-chave do KYB.

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

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

is_bank_verification_enabled
boolean

Indica se um fluxo simples de KYC ou KYB executa a Verificação bancária. Ela é executada após as etapas de contato (e a Verificação de localização) e antes da validação de banco de dados, da AML e da análise de IP. A Verificação bancária ainda não está disponível para todos: ativá-la é recusado onde quer que ela não esteja habilitada.

bank_verification_config
object

Configurações de verificação bancária de um fluxo simples, com as mesmas chaves aceitas por um nó BANK_VERIFICATION (por exemplo, bank_countries e bank_method_order). Chaves desconhecidas são descartadas. Todas as chaves são opcionais e uma chave ausente mantém seu valor padrão, então {} significa todos os valores padrão. Consulte Configurações de verificação bancária.

Exemplo:
is_geolocation_enabled
boolean

Indica se um fluxo simples de KYC executa a Verificação de localização. Ela é executada após as etapas de contato e antes da Verificação bancária e da validação de banco de dados. Fluxos de empresas (KYB) não podem executá-la.

geolocation_config
object

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

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