https://mcp.didit.me/mcp gives a signed-in user 169 ferramentas: 80 de leitura, 62 de escrita e 27 destrutivas.
As 17 ferramentas do Investigator também estão listadas, mas só funcionam depois de o Investigator estar ativado para a sua organização.
Mais duas (didit_org_top_up e didit_org_reveal_application_api_key) estão ocultas em todos os catálogos autenticados por OAuth e só aparecem num servidor stdio local, que acrescenta também cinco ferramentas de configuração da conta (ver auto-alojamento).
Esta página é gerada a partir do registo de ferramentas em didit-protocol/mcp (src/index.ts, a versão que o servidor alojado indica em serverInfo). Os nomes, os tipos e os argumentos obrigatórios vêm da resposta tools/list do próprio servidor; a permissão da função provém de src/permissions.ts.
Como ler a tabela
| Coluna | Significado |
|---|---|
| Tipo | Proveniente das anotações MCP da ferramenta. Leitura permite apenas ler. Escrita cria ou altera algo. Destrutiva elimina ou substitui dados, altera algo que produz efeito imediato (um fluxo publicado, uma decisão sobre uma sessão), revela um segredo ou movimenta dinheiro; os clientes pedem confirmação antes de executar estas ferramentas. As verificações autónomas faturáveis contam como escrita. |
| Âmbito | O âmbito OAuth cujos recursos incluem a permissão da função da ferramenta: didit:verification para sessões, empresas, casos, redes, transações e a lista de bloqueio; didit:management para fluxos, questionários, listas, webhooks, integrações, membros, funções, chaves de API, registos de auditoria, a organização, aplicações, subscrição e utilizadores. Qualquer um significa análises, que ambos os âmbitos incluem, ou uma ferramenta sem verificação por função, que é executada com o âmbito que aprovou. Ver Autenticação. |
| Permissão da função | A permissão que a função da sua organização tem de possuir, tal como o backend da Didit a verifica. Um traço (-) indica que o endpoint está limitado à pertença ou não tem verificação por função. Quando a sua função não tem a permissão, a ferramenta devolve um erro missing_scope que a indica. |
organization_id e application_id para fixar um âmbito. Com uma única organização e uma única aplicação, estes são resolvidos automaticamente; com várias, as ferramentas *_search e didit_analytics abrangem todas, e as ferramentas *_list por aplicação fazem o mesmo quando não indica nenhum âmbito.
didit_session_delete e didit_session_batch_delete recusam-se a ser executadas sem confirm: true nos argumentos, o mesmo acontece com as ferramentas de decisão do Investigator (accept, override, batch_accept, rereview, question_answer, question_dismiss) e com a ferramenta didit_org_reveal_application_api_key, disponível apenas localmente. didit_case_manage precisa desse parâmetro ao apresentar um SAR, e didit_vendor_user_delete e didit_vendor_business_delete precisam dele quando delete_all é true.Descoberta e acesso entre aplicações
Estas ferramentas abrangem, numa única chamada, todas as organizações e aplicações a que tem acesso; cada linha está marcada com a respetiva organização e aplicação.| Ferramenta | Tipo | Âmbito | Permissão da função | O que faz |
|---|---|---|---|---|
didit_context_get | Leitura | Qualquer um | - | Todas as organizações e aplicações a que tem acesso, aninhadas, e também a organização e a aplicação predefinidas quando existe apenas uma. Chame esta ferramenta primeiro. |
didit_session_search | Leitura | didit:verification | list:sessions | Pesquisa sessões de verificação em todas as suas aplicações e organizações, das mais recentes para as mais antigas. |
didit_transaction_search | Leitura | didit:verification | list:transactions | Pesquisa transações monitorizadas em todas as suas aplicações e organizações. |
didit_case_search | Leitura | didit:verification | list:cases | Pesquisa casos de investigação em todas as suas aplicações e organizações. |
didit_vendor_user_search | Leitura | didit:management | list:users | Encontra um cliente final pelo nome, pelo e-mail ou por vendor_data em todas as suas aplicações. |
didit_vendor_business_search | Leitura | didit:verification | list:businesses | Encontra uma empresa KYB em todas as suas aplicações. |
didit_workflow_search | Leitura | didit:management | read:workflows | Encontra um fluxo pelo id ou pelo rótulo em todas as suas aplicações; o resultado indica a organização e a aplicação a que pertence. |
didit_analytics | Leitura | Qualquer um | read:analytics | Análises agregadas para um intervalo de datas (repartição de pedidos, funil de funcionalidades, taxa de conversão) em todas as suas aplicações. |
Sessões (KYC e KYB)
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_session_create | Escrita | didit:verification | create:sessions ou write:sessions | Cria uma sessão de verificação para um fluxo. Devolve session_id, url e session_token. |
didit_session_list | Leitura | didit:verification | list:sessions | Lista as sessões de uma aplicação. Abrange todas as aplicações se não indicar um âmbito. |
didit_session_get_decision | Leitura | didit:verification | read:sessions | A decisão completa e todos os dados extraídos de uma sessão. |
didit_session_get_location_evidence | Leitura | didit:verification | read:sessions | As provas da Precise Location de uma sessão para cada passo de Localização: a configuração que a avaliou, o veredicto, todas as tentativas, os pontos de referência, as distâncias e as áreas. |
didit_session_update_status | Destrutiva | didit:verification | write:sessions | Aprova, recusa ou pede nova submissão de uma sessão. |
didit_session_update_data | Escrita | didit:verification | write:sessions | Corrige os dados extraídos do documento de identificação (substituição pelo revisor). |
didit_session_update_poa_data | Escrita | didit:verification | write:sessions | Corrige os dados extraídos do comprovativo de morada. |
didit_session_delete | Destrutiva | didit:verification | delete:sessions | Elimina permanentemente uma sessão, com os seus dados de verificação e ficheiros multimédia. Requer confirm: true. |
didit_session_batch_delete | Destrutiva | didit:verification | delete:sessions | Elimina permanentemente várias sessões KYC pelo número de sessão, ou todas as sessões KYC da aplicação. Requer confirm: true. As sessões KYB nunca são afetadas. |
didit_session_generate_pdf | Escrita | didit:verification | read:sessions | Gera um relatório de verificação em PDF para uma sessão. |
didit_session_list_reviews | Leitura | didit:verification | read:sessions | O histórico de revisões e o registo de atividade de uma sessão. |
didit_session_add_review | Escrita | didit:verification | write:sessions | Adiciona uma nota de revisão a uma sessão, alterando opcionalmente o seu estado. |
didit_session_share | Escrita | didit:verification | write:sessions | Partilha uma sessão verificada com um parceiro de confiança (KYC reutilizável). |
didit_session_import_shared | Escrita | Qualquer um | — | Importa uma sessão que um parceiro partilhou consigo (KYC reutilizável). |
didit_session_create_import | Escrita | Qualquer um | — | Inicia uma tarefa de importação em massa a partir de um ficheiro CSV ou NDJSON alojado. |
didit_session_get_import_template | Leitura | Qualquer um | — | Descarrega o modelo de importação (cabeçalhos das colunas e formato). |
didit_session_get_import | Leitura | Qualquer um | — | Estado e resumo de uma tarefa de importação em massa. |
didit_session_get_import_errors | Leitura | Qualquer um | — | Falhas por linha de uma tarefa de importação em massa. |
didit_session_explain_decision | Leitura | didit:verification | read:sessions | Porque é que uma sessão terminou como Aprovada, Recusada ou Em análise: a funcionalidade decisiva, cada aviso que teve efeito, cada regra de estado acionada, qualquer substituição pelo revisor e a definição do fluxo associada a cada causa. |
didit_session_webhooks | Leitura | didit:verification | read:sessions | As entregas de webhook associadas a uma sessão nos últimos 30 dias: destino, estado HTTP, temporização, cabeçalhos de assinatura e uma cópia limitada do payload. |
didit_session_webhook_resend | Escrita | didit:verification | create:sessions | Reenvia uma entrega de webhook registada de uma sessão para o endpoint configurado, por exemplo depois de o endpoint ter sido corrigido. |
Fluxos
Os fluxos simples são uma lista plana de funcionalidades; os fluxos em grafo acrescentam ramificações, condições e passos do Document AI. Consulte Avançado: fluxos com ramificações.| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_workflow_list | Leitura | didit:management | read:workflows | Lista os fluxos de verificação. Abrange todas as aplicações se não indicar um âmbito. |
didit_workflow_create | Escrita | didit:management | write:workflows | Cria um fluxo simples e linear a partir de uma lista ordenada de funcionalidades. Publica-o, a menos que passe status: "draft". |
didit_workflow_get | Leitura | didit:management | read:workflows | A configuração completa de um fluxo, incluindo os pontos de dados devolvidos por funcionalidade. |
didit_workflow_update | Destrutiva | didit:management | write:workflows | Altera as definições de topo de um fluxo (rótulo, indicador de predefinição, novas tentativas, expiração, marca branca, listas de permissão). |
didit_workflow_delete | Destrutiva | didit:management | write:workflows | Elimina um fluxo em rascunho. |
didit_workflow_get_graph | Leitura | didit:management | read:workflows | O grafo de nós de um fluxo, com o respetivo estado e editabilidade. As configurações extensas são resumidas, a menos que as peça. |
didit_workflow_get_field_definitions | Leitura | didit:management | read:workflows | Todos os campos em que pode criar ramificações e os operadores aceites por cada um. |
didit_workflow_get_feature_config_schema | Leitura | Um ou outro | — | Todas as chaves de config aceites por cada funcionalidade de fluxo, com tipo, limites, valor predefinido e significado. |
didit_workflow_get_id_verification_methods_catalog | Leitura | didit:management | read:workflows | Por país, as consultas sem documento e as carteiras de identidade digital disponíveis, se estão ativas e os preços do respetivo catálogo de consultas. |
didit_workflow_get_kyb_registry_catalog | Leitura | Um ou outro | — | Por país, os níveis de dados de empresas oferecidos pelos registos e se a monitorização de registos é vendida, com preços. Não é necessária organização nem aplicação. |
didit_workflow_get_branch_fields | Leitura | didit:management | read:workflows | Os campos disponíveis num ponto de ramificação de um grafo candidato. |
didit_workflow_validate_graph | Leitura | didit:management | read:workflows | Validação de um grafo completo em modo de simulação. Não guarda nada. |
didit_workflow_edit_graph | Destrutiva | didit:management | write:workflows | Altera um grafo existente com pequenas operações; o servidor obtém ele próprio o grafo completo e guarda um rascunho. |
didit_workflow_set_graph | Destrutiva | didit:management | write:workflows | Substitui todo o grafo de um fluxo. Guarda um rascunho; a publicação é um passo separado. |
didit_workflow_create_draft | Escrita | didit:management | write:workflows | Cria um rascunho editável a partir de um fluxo publicado. |
didit_workflow_publish | Destrutiva | didit:management | write:workflows | Publica o rascunho pendente para que as novas sessões o utilizem. |
didit_workflow_build_graph | Leitura | didit:management | read:workflows | Constrói um grafo completo a partir de uma especificação simples de funcionalidades, sem guardar nada. |
Assistente de conformidade
Construa um fluxo a partir do seu perfil regulamentar: uma entrevista adaptativa, as obrigações que se aplicam a si com referências e um fluxo gerado para vários países.| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_compliance_interview_next | Leitura | didit:management | read:workflows | A próxima pergunta da entrevista adaptativa de conformidade, ou done quando estiver concluída. Passe todas as respostas recolhidas até ao momento em cada chamada. |
didit_compliance_profile_get | Leitura | didit:management | read:workflows | O seu perfil de conformidade guardado: as respostas da entrevista e os atributos derivados delas. |
didit_compliance_profile_set | Destrutiva | didit:management | write:workflows | Guarda as respostas da entrevista concluída, substituindo qualquer perfil de conformidade existente. |
didit_compliance_requirements | Leitura | didit:management | read:workflows | As obrigações regulamentares que se aplicam a si, com referências, derivadas do perfil guardado. |
didit_compliance_generate_workflow | Leitura | didit:management | read:workflows | Gera um grafo de fluxo para vários países a partir do perfil guardado: um tronco comum com ramificações por país e as verificações exigidas por cada país. |
didit_compliance_check_workflow | Leitura | didit:management | read:workflows | Verifica que obrigações uma versão de fluxo cumpre ou viola, com referências. |
Questionários
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_questionnaire_list | Leitura | didit:management | read:questionnaires | Lista os questionários personalizados de uma aplicação. |
didit_questionnaire_create | Escrita | didit:management | write:questionnaires | Cria um questionário a partir de uma lista ordenada de perguntas. |
didit_questionnaire_append_choices | Escrita | didit:management | write:questionnaires | Acrescenta opções de resposta a uma pergunta de um questionário em rascunho. |
didit_questionnaire_get | Leitura | didit:management | read:questionnaires | As perguntas e opções de um questionário. |
didit_questionnaire_update | Destrutiva | didit:management | write:questionnaires | Atualiza o título, a descrição ou as perguntas de um questionário. |
didit_questionnaire_delete | Destrutiva | didit:management | write:questionnaires | Elimina um questionário. |
APIs de verificação independentes
Chamadas faturáveis únicas, sem sessão. Cada uma delas é um POST que consome créditos, mesmo as que parecem uma consulta (kyb_search, face_search).
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_verify_id | Escrita | didit:verification | create:sessions | Verifica um documento de identidade a partir da imagem da frente (e, opcionalmente, do verso). |
didit_verify_poa | Escrita | didit:verification | create:sessions | Verifica um comprovativo de morada. |
didit_verify_database | Escrita | didit:verification | create:sessions | Valida os dados de identidade em fontes oficiais nacionais e globais. |
didit_verify_kyb_search | Escrita | didit:verification | create:sessions | Pesquisa nos registos oficiais de empresas por nome ou número de registo; devolve candidatos. |
didit_verify_kyb_select | Escrita | didit:verification | create:sessions | Obtém o registo completo de um candidato devolvido por didit_verify_kyb_search. |
didit_verify_passive_liveness | Escrita | didit:verification | create:sessions | Prova de vida passiva a partir de uma única imagem. |
didit_verify_face_match | Escrita | didit:verification | create:sessions | Compara duas imagens faciais (1:1). |
didit_verify_face_search | Escrita | didit:verification | create:sessions | Pesquisa um rosto entre rostos verificados anteriormente (1:N). |
didit_verify_age | Escrita | didit:verification | create:sessions | Estima a idade de uma pessoa a partir de uma imagem facial. |
didit_verify_aml | Escrita | didit:verification | create:sessions | Faz a triagem AML de um nome contra sanções, PEP e listas de vigilância, opcionalmente também contra notícias adversas. |
didit_verify_email_send | Escrita | Qualquer um | — | Envia um código de utilização única para um endereço de e-mail. |
didit_verify_email_check | Escrita | Qualquer um | — | Verifica o código enviado para um endereço de e-mail. |
didit_verify_phone_send | Escrita | Qualquer um | — | Envia um código de utilização única para um número de telefone. |
didit_verify_phone_check | Escrita | Qualquer um | — | Verifica o código enviado para um número de telefone. |
Monitorização de transações
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_transaction_list | Leitura | didit:verification | list:transactions | Lista as transações monitorizadas numa aplicação. Abrange todas as aplicações quando não indica um âmbito. |
didit_transaction_create | Escrita | didit:verification | create:transactions | Submete uma transação para monitorização e avaliação de regras. |
didit_transaction_get | Leitura | didit:verification | list:transactions | Uma transação monitorizada, com o resultado da avaliação de regras. |
didit_transaction_screen_wallet | Escrita | didit:verification | create:transactions | Analisa um endereço de carteira cripto quanto ao risco AML, sem criar uma transação. |
didit_transaction_rule_list | Leitura | didit:verification | list:transactions | Lista as regras de monitorização de transações de uma aplicação. |
didit_transaction_rule_get | Leitura | didit:verification | list:transactions | Uma regra, com as suas condições, agregação, âmbito, ações e contadores. |
didit_transaction_rule_create | Escrita | didit:verification | write:transactions | Cria uma regra personalizada. |
didit_transaction_rule_update | Escrita | didit:verification | write:transactions | Atualiza parcialmente uma regra. |
didit_transaction_rule_delete | Destrutiva | didit:verification | write:transactions | Elimina uma regra personalizada. |
didit_transaction_rule_backtest | Leitura | didit:verification | list:transactions | Executa uma simulação de uma regra hipotética sobre até 10 000 das transações mais recentes. Não grava nada. |
didit_transaction_rule_library_list | Leitura | didit:verification | list:transactions | Consulta a biblioteca de regras predefinidas da Didit, com o estado de instalação. |
didit_transaction_rule_install | Escrita | didit:verification | write:transactions | Instala regras predefinidas por chave da biblioteca ou por pacote. |
didit_transaction_rule_uninstall | Destrutiva | didit:verification | write:transactions | Remove regras predefinidas instaladas por chave da biblioteca ou por pacote. |
didit_transaction_sdk_token | Escrita | Qualquer um | — | Emite um token de curta duração, associado a um utilizador final, para submeter transações a partir dos SDKs do cliente. |
Travel Rule
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_travel_rule_get_settings | Leitura | Qualquer | — | As suas definições da Travel Rule: perfil de VASP, política de negociação, métodos de prova, modos por rede e o seu Travel Address. |
didit_travel_rule_update_settings | Escrita | Qualquer | — | Altere as definições da Travel Rule; envie apenas os campos a alterar. Ativar exige um nome legal. |
didit_travel_rule_search_vasps | Leitura | Qualquer | — | Pesquise o diretório de VASP, com pontuações de diligência devida e as redes em que cada VASP está acessível. |
didit_travel_rule_list_wallet_addresses | Leitura | Qualquer | — | A agenda de endereços de carteiras usada para resolver as transferências recebidas, com o estado de verificação de propriedade de cada endereço. |
didit_travel_rule_add_wallet_address | Escrita | Qualquer | — | Adicione à agenda de endereços uma carteira que controla, opcionalmente como já verificada quanto à propriedade por autodeclaração. |
didit_travel_rule_update_wallet_address | Escrita | Qualquer | — | Atualize os dados do titular de uma entrada da agenda de endereços. |
didit_travel_rule_delete_wallet_address | Destrutiva | Qualquer | — | Elimine uma entrada da agenda de endereços; deixa de corresponder a novas transferências imediatamente. |
didit_travel_rule_confirm_ownership | Destrutiva | Qualquer | — | Confirme ou negue a propriedade da carteira numa transferência que aguarda uma prova de propriedade. |
didit_travel_rule_transfer_action | Destrutiva | Qualquer | — | Conclua uma transferência de saída com o respetivo hash on-chain, cancele uma transferência que ainda não está finalizada ou volte a executar o encaminhamento para a contraparte. |
didit_travel_rule_get_vasp | Leitura | Qualquer | — | Obtenha uma entrada do diretório de VASP pelo id, com os mesmos campos de uma linha de pesquisa: rotas, listagens de redes, alias, contactos e entidades. |
didit_travel_rule_list_networks | Leitura | Qualquer | — | O estado de cada rede da Travel Rule para a sua aplicação, com o motivo, o seu registo de participante e o questionário de diligência devida. |
didit_travel_rule_request_network | Escrita | Qualquer | — | Peça para aderir a uma rede da Travel Rule como participante. O pedido aguarda até o questionário de diligência devida ser aprovado. |
didit_travel_rule_get_network_questionnaire | Leitura | Qualquer | — | O questionário de diligência devida para acesso à rede: estado, respostas guardadas, a nota do revisor e o histórico de estados. |
didit_travel_rule_update_network_questionnaire | Escrita | Qualquer | — | Guarde respostas no rascunho do questionário. Envie apenas as respostas a alterar. |
didit_travel_rule_submit_network_questionnaire | Destrutiva | Qualquer | — | Submeta o questionário guardado para análise. Não pode ser editado enquanto estiver em análise. |
didit_travel_rule_set_counterparty_vasp | Escrita | Qualquer | — | Escolha o VASP da contraparte de uma transferência de saída que não pôde ser encaminhada e volte a executar a troca com esse VASP. |
didit_travel_rule_list_messages | Leitura | Qualquer | — | As mensagens e os pedidos de documentos trocados com o VASP da contraparte numa transferência, da mais antiga para a mais recente. |
didit_travel_rule_send_message | Escrita | Qualquer | — | Envie uma mensagem ou um pedido de documento ao VASP da contraparte de uma transferência. Apenas as transferências com outro cliente da Didit ou por e-mail incluem mensagens. |
didit_travel_rule_list_counterparty_contacts | Leitura | Qualquer | — | Os contactos de conformidade usados para chegar a um VASP da contraparte por e-mail: os da plataforma e os da sua aplicação. |
didit_travel_rule_add_counterparty_contact | Escrita | Qualquer | — | Adicione um contacto de conformidade para um VASP do diretório, exclusivo da sua aplicação. |
didit_travel_rule_delete_counterparty_contact | Destrutiva | Qualquer | — | Elimine um dos contactos de contraparte da sua aplicação. |
didit_travel_rule_get_sandbox_scenarios | Leitura | Qualquer | — | O Didit Test VASP com que as aplicações em sandbox interagem e os cenários (aceitar, recusar, incompatibilidade de nome, inacessível, tempo limite, carteira autocustodiada) que cada endereço de carteira seleciona. |
didit_travel_rule_trigger_test_inbound | Escrita | Qualquer | — | Apenas para aplicações em sandbox: faça com que o Didit Test VASP lhe envie uma transferência recebida ao abrigo da Travel Rule. |
Utilizadores e empresas de fornecedores
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_vendor_user_list | Leitura | didit:management | list:users | Liste os utilizadores verificados agrupados por vendor_data. Abrange todas as aplicações se não indicar um âmbito. |
didit_vendor_user_create | Escrita | didit:management | create:users | Crie manualmente um registo de utilizador. |
didit_vendor_user_get | Leitura | didit:management | read:users | Um utilizador pelo vendor_data. |
didit_vendor_user_update | Escrita | didit:management | write:users | Atualize os campos de perfil de um utilizador. |
didit_vendor_user_update_status | Escrita | didit:management | write:users | Defina o estado de um utilizador como ACTIVE, FLAGGED ou BLOCKED. |
didit_vendor_user_delete | Destrutiva | didit:management | delete:users | Elimine utilizadores em lote pelo vendor_data ou elimine todos os utilizadores. |
didit_vendor_business_list | Leitura | didit:verification | list:businesses | Liste as empresas verificadas agrupadas por vendor_data. Abrange todas as aplicações se não indicar um âmbito. |
didit_vendor_business_create | Escrita | didit:verification | create:businesses | Crie manualmente um registo de empresa. |
didit_vendor_business_get | Leitura | didit:verification | read:businesses | Uma empresa pelo vendor_data. |
didit_vendor_business_update | Escrita | Qualquer | — | Atualize os campos de perfil de uma empresa. |
didit_vendor_business_update_status | Escrita | didit:verification | write:businesses | Defina o estado de uma empresa como ACTIVE, FLAGGED ou BLOCKED. |
didit_vendor_business_delete | Destrutiva | didit:verification | delete:businesses | Elimine empresas em lote pelo vendor_data ou pelo id interno, ou elimine todas as empresas. |
Listas, lista de bloqueio e lista de permissões
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_lists_list | Leitura | didit:management | read:lists | Todas as listas de uma aplicação: listas de bloqueio, listas de permissões e listas personalizadas. |
didit_lists_create | Escrita | didit:management | create:lists | Criar uma lista de permissões ou uma lista personalizada. |
didit_lists_get | Leitura | didit:management | read:lists | Uma lista, pelo UUID. |
didit_lists_update | Escrita | didit:management | write:lists | Renomear uma lista ou alterar a respetiva descrição. |
didit_lists_delete | Destrutiva | didit:management | delete:lists | Eliminar uma lista e todas as suas entradas. |
didit_lists_entries_list | Leitura | didit:management | read:lists | As entradas de uma lista. |
didit_lists_entry_create | Escrita | didit:management | create:lists | Adicionar uma entrada a uma lista, pelo valor ou a partir de uma sessão. |
didit_lists_entry_upload_face | Escrita | didit:management | create:lists | Adicionar um rosto a uma lista facial a partir de uma imagem, sem sessão. |
didit_lists_entry_delete | Destrutiva | didit:management | delete:lists | Remover uma entrada de uma lista. |
didit_blocklist_get | Leitura | didit:verification | read:blocklist | Listar as entradas da lista de bloqueio (auxiliar legado). |
didit_blocklist_add | Escrita | didit:verification | write:blocklist | Adicionar uma entrada à lista de bloqueio (auxiliar legado). |
didit_blocklist_remove | Destrutiva | didit:verification | write:blocklist | Remover uma entrada da lista de bloqueio (auxiliar legado). |
didit_allowlist_add | Escrita | didit:verification | write:blocklist | Adicionar uma entrada à lista de permissões (auxiliar legado). |
Casos
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_case_list | Leitura | didit:verification | list:cases | Listar casos numa aplicação. Abrange todas as aplicações se não indicar um âmbito. |
didit_case_get | Leitura | didit:verification | read:cases | Um caso com os respetivos detalhes. |
didit_case_create | Escrita | didit:verification | write:cases | Abrir um caso. |
didit_case_statistics | Leitura | didit:verification | list:cases | Contagens de casos por estado e estatísticas semelhantes. |
didit_case_manage | Destrutiva | didit:verification | write:cases | Atribuir, resolver, reabrir, escalar, comentar ou atualizar um caso. |
Redes de fraude
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_network_list | Leitura | didit:verification | list:networks | Listar as redes de fraude de uma aplicação, com os filtros e os KPIs da consola. |
didit_network_get | Leitura | didit:verification | read:networks | Uma rede de fraude com os respetivos membros e sinais; grafo, mapa e cronologia, mediante pedido. |
didit_network_membership_get | Leitura | didit:verification | read:networks | As redes de fraude a que uma sessão, sessão empresarial, utilizador, empresa ou transação pertence. |
Investigator
Estas ferramentas aparecem emtools/list para todos os utilizadores com sessão iniciada, mas só funcionam depois de o Investigator estar ativado para a sua organização.
| Ferramenta | Tipo | Âmbito | Permissão de função | O que faz |
|---|---|---|---|---|
didit_investigator_queue_list | Leitura | Qualquer um | — | Listar os relatórios abertos do Investigator, a fila de revisão, com a recomendação e a confiança de cada um. |
didit_investigator_report_get | Leitura | Qualquer um | — | Um relatório do Investigator: recomendação, confiança, risco, narrativa, provas, precedentes e perguntas. |
didit_investigator_record_get | Leitura | Qualquer um | — | A revisão mais recente do Investigator de uma verificação ou de uma transação, abertas ou decididas. |
didit_investigator_accept | Destrutiva | Qualquer um | — | Aceitar a recomendação do Investigator sobre um item; o item fica decidido e registado com o seu nome. |
didit_investigator_override | Destrutiva | Qualquer um | — | Decidir um item com outra ação, uma categoria e um motivo, em vez da recomendação. |
didit_investigator_batch_accept | Destrutiva | Qualquer um | — | Aceitar até 50 recomendações prontas de uma só vez; um item que não possa ser aceite é ignorado com o respetivo motivo. |
didit_investigator_add_note | Escrita | Qualquer um | — | Adicionar um facto sobre um item de um relatório como nota da equipa, que a revisão seguinte lê. |
didit_investigator_rereview | Destrutiva | Qualquer um | — | Pedir ao Investigator que volte a analisar um item; o novo relatório substitui o relatório aberto. |
didit_investigator_question_list | Leitura | Qualquer um | — | As perguntas de política que o Investigator levanta, das mais recentes para as mais antigas. |
didit_investigator_question_get | Leitura | Qualquer um | — | Uma pergunta de política com o histórico da equipa dos últimos 30 dias sobre essa situação e as respostas possíveis. |
didit_investigator_question_answer | Destrutiva | Qualquer um | — | Responder a uma pergunta de política; a maioria das respostas cria uma nova versão da política. |
didit_investigator_question_dismiss | Destrutiva | Qualquer um | — | Fechar uma pergunta de política sem resposta. |
didit_investigator_backtest_start | Escrita | Qualquer um | — | Iniciar um teste retrospetivo gratuito que reexecuta a política atual sobre as decisões dos últimos 30 ou 90 dias. Não decide nada. |
didit_investigator_backtest_get | Leitura | Qualquer um | — | Um teste retrospetivo guardado: concordância por fila, nível e limiar. |
didit_investigator_performance_get | Leitura | Qualquer um | — | A concordância do Investigator com a sua equipa, o volume, o tempo poupado e as substituições nos últimos 7, 30 ou 90 dias. |
didit_investigator_dashboard_get | Leitura | Qualquer um | — | O painel do Investigator: automatização de 30 dias, histórico semanal, despesas e substituições. |
didit_investigator_activity_list | Leitura | Qualquer um | — | O registo de atividade do Investigator, do mais recente para o mais antigo: o que o agente e as pessoas fizeram. |
Relatórios, registo de auditoria e alertas
| Ferramenta | Tipo | Âmbito | Permissão da função | O que faz |
|---|---|---|---|---|
didit_report_list | Leitura | Qualquer um | — | Lista os relatórios de exportação. |
didit_report_get | Leitura | Qualquer um | — | Estado e detalhes de um relatório de exportação. |
didit_report_get_download_url | Leitura | Qualquer um | — | Um URL de transferência assinado para um relatório concluído. |
didit_report_export | Escrita | Qualquer um | — | Inicia uma exportação (sessões, transações, utilizadores ou empresas). |
didit_audit_log_list | Leitura | Qualquer um | — | Entradas do registo de auditoria de uma aplicação: quem alterou o quê. |
didit_alert_list | Leitura | didit:management | read:applications | Os alertas configurados de uma aplicação. |
didit_alert_configure | Escrita | didit:management | write:applications | Configura um alerta por tipo. |
Webhooks
| Ferramenta | Tipo | Âmbito | Permissão da função | O que faz |
|---|---|---|---|---|
didit_webhook_list | Leitura | didit:management | read:webhooks | Os destinos de webhook de uma aplicação. |
didit_webhook_create | Escrita | didit:management | write:webhooks | Cria um destino de webhook. O segredo de assinatura é ocultado na resposta; copie-o a partir da consola. |
didit_webhook_get | Leitura | didit:management | read:webhooks | Um destino de webhook, com o segredo de assinatura ocultado. |
didit_webhook_update | Destrutiva | didit:management | write:webhooks | Altera o URL, a versão, o indicador de ativação ou os eventos subscritos de um destino. |
didit_webhook_delete | Destrutiva | didit:management | write:webhooks | Elimina um destino de webhook. |
Marketplace
| Ferramenta | Tipo | Âmbito | Permissão da função | O que faz |
|---|---|---|---|---|
didit_marketplace_list_catalog | Leitura | didit:management | read:integrations | O marketplace de fornecedores: análise de blockchain, triagem AML, fornecedores de verificação de telefone e bancária e redes Travel Rule, com as credenciais de que cada um necessita. |
didit_marketplace_list_connections | Leitura | didit:management | read:integrations | As ligações ao marketplace e as associações à rede da sua aplicação, com estado e última utilização. Os segredos nunca são devolvidos. |
didit_marketplace_request_integration | Escrita | didit:management | write:integrations | Pede uma integração que ainda não está disponível em autoatendimento; a equipa da Didit dá seguimento ao pedido. |
Organização, membros, faturação e identidade visual
Duas ferramentas deste grupo (didit_org_top_up, didit_org_reveal_application_api_key) estão definidas no servidor, mas ocultas do catálogo de todos os chamadores autenticados por OAuth; só são listadas num servidor stdio local.
| Ferramenta | Tipo | Âmbito | Permissão da função | O que faz |
|---|---|---|---|---|
didit_org_list | Leitura | Qualquer um | — | As organizações a que pertence. |
didit_org_list_applications | Leitura | Qualquer um | — | As aplicações de uma organização. |
didit_org_get_application | Leitura | Qualquer um | — | Detalhes da aplicação, com a chave de API ocultada. |
didit_org_reveal_application_api_key | Destrutiva | Qualquer um | — | Devolve a chave de API da aplicação em bruto. Requer identificadores explícitos e confirm: true. Oculta no conector alojado. |
didit_org_get_balance | Leitura | didit:management | read:subscription | Saldo de créditos e definições de recarga automática. |
didit_org_top_up | Destrutiva | Qualquer um | — | Cria um checkout Stripe para adicionar créditos. Oculta no conector alojado. |
didit_branding_get | Leitura | didit:management | read:customization | A identidade visual (logótipos, cores) aplicada à sua interface de verificação. |
didit_branding_update | Escrita | didit:management | write:customization | Carrega novas imagens de identidade visual. |
didit_org_list_members | Leitura | didit:management | list:members | Os membros de uma organização. |
didit_org_invite_member | Escrita | didit:management | write:members | Convida um membro por e-mail com uma função. |
didit_org_update_member | Escrita | didit:management | write:members | Altera a função de um membro. |
didit_org_remove_member | Destrutiva | didit:management | delete:members | Remove um membro da organização. |
didit_org_list_roles | Leitura | didit:management | list:roles | As funções disponíveis na organização. |
didit_org_list_api_keys | Leitura | didit:management | read:applications | Metadados das chaves de API, com os valores em bruto ocultados. |
Ficheiros de entrada
As ferramentas que recebem um ficheiro (didit_verify_id, didit_verify_poa, didit_verify_passive_liveness, didit_verify_face_match, didit_verify_face_search, didit_verify_age, didit_lists_entry_upload_face, didit_branding_update) aceitam-no numa de duas formas:
*_base64: o conteúdo do ficheiro em linha, como base64 em bruto ou um URLdata:. Use esta forma com o endpoint alojado.*_path: um caminho absoluto na máquina que executa o servidor. Só funciona com um servidor stdio local que partilha um sistema de ficheiros consigo.
Exemplos
Conversas que usam estas ferramentas de ponta a ponta.
Avançado
Funções, comportamento entre aplicações, fluxos com ramificações, webhooks, autoalojamento.