Saltar para o conteúdo principal
O SDK oficial da Didit para Node.js e TypeScript. Funciona com Node.js 18 ou posterior, Bun, Deno e ambientes de execução edge com fetch, inclui compilações para módulos ES e CommonJS e não tem dependências em tempo de execução. Consulte a visão geral dos SDKs de servidor para ver o que todos os SDKs partilham.

Instalação

O pacote é o @didit-protocol/sdk-node no npm. O código-fonte e o registo de alterações estão em didit-protocol/sdk-node no GitHub.

Configurar o cliente

new Didit() lê DIDIT_API_KEY do ambiente em Node.js, Bun e Deno (com --allow-env). Os ambientes de execução edge não têm ambiente de processo, por isso passe a chave como opção nesses casos: new Didit({ apiKey: env.DIDIT_API_KEY }). Passe opções para substituir este valor, ou para definir os identificadores da organização e da aplicação de que precisam as chamadas específicas da aplicação (casos, redes, relatórios regulatórios). O timeout está em milissegundos.
Com CommonJS, use const { Didit } = require("@didit-protocol/sdk-node");.

Criar uma sessão

Crie uma sessão de verificação para um fluxo e envie o seu utilizador para o respetivo URL. Os campos do pedido mantêm os nomes próprios da API.

Ler a decisão

Quando o utilizador terminar (ou quando o webhook chegar), leia a decisão. Cada resultado de funcionalidade é uma lista com uma entrada por nó do fluxo, e as datas e horas são objetos Date.

Verificar um webhook

Passe o corpo bruto (não o JSON analisado) e os cabeçalhos do pedido: um objeto req.headers do Node.js ou do Express, um objeto Headers do Fetch ou pares [name, value] (o tipo WebhookHeaders). verify devolve uma promessa e rejeita com WebhookVerificationError em qualquer entrega que não seja válida e recente.
Com Express, leia o corpo com express.raw({ type: "application/json" }) e chame handleWebhook(req.body, req.headers). Durante a rotação do segredo, passe ambos: [newSecret, oldSecret]. Consulte Webhooks para ver os eventos e o esquema de assinatura.

Analisar uma transação

Envie um pagamento, um levantamento ou uma transferência de criptoativos para a monitorização de transações; a resposta inclui o respetivo estado e a pontuação de risco.

Verificar tokens de Authentication

Authentication verifica os tokens de acesso que o seu emissor da Authentication assina, no seu backend, sem chamar a Didit em cada pedido. Também troca códigos, renova tokens, verifica e revoga sessões e executa step-ups de autenticação.
A verificação de tokens faz as validações descritas em Verificar um token no seu servidor, com base no emissor e nas chaves de assinatura da sua aplicação.

Erros

Listas e ficheiros

As páginas de endpoints de servidor da referência da API incluem um exemplo em Node.js para a respetiva operação, exceto os endpoints e campos que ainda não estão disponíveis na versão 1.0.1, indicados na visão geral.
Última modificação em 7 de novembro de 2026