Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo de alteraçõescurl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Atualizar configuração de webhook API
Atualize na Didit o webhook da aplicação, rode o segredo, defina a retenção de dados e templates biométricos e registe hosts de retorno da wallet.
curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}rotate_secret_key faz a rotação apenas do segredo ao nível da aplicação, que assina as entregas enviadas para o webhook_url legado. Cada destino do webhook assina com o seu próprio secret_shared_key, que este pedido não altera.allowed_return_hosts é descrito em Registe o seu destino de retorno.
biometric_consent_mode (auto, always ou never) define quando o fluxo de verificação pede o consentimento biométrico explícito antes de uma captura facial. Consulte Consentimento biométrico.
Para ler primeiro os valores atuais, chame Obter a configuração do webhook.Autorizações
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.
Corpo
Envie apenas os campos a alterar. Os destinos não são geridos aqui.
URL de webhook legado ao nível da aplicação. O Didit utiliza-o apenas enquanto a aplicação não tiver nenhum destino ativado e, mesmo assim, apenas para status.updated e data.updated. Não cria um destino, e a próxima criação, atualização ou eliminação de um destino substitui-o. Para receber webhooks, crie antes um destino com POST /v3/webhook/destinations/.
2000Versão do payload do webhook_url legado.
v1, v2, v3 true substitui imediatamente a secret_shared_key ao nível da aplicação por um novo valor aleatório; o novo valor está na resposta. Os segredos dos destinos não são alterados. Cada chamada com true gera um novo segredo, pelo que não é idempotente.
Definição legada da aplicação. O fluxo de verificação não a lê.
MOBILE, MOBILE_AND_DESKTOP Janela de eliminação automática em meses (um mês conta como 30 dias), ou null para nenhuma eliminação automática. Uma alteração aplica-se também a sessões existentes: todas as sessões de verificação de utilizadores com uma antiguidade superior à nova janela são eliminadas automaticamente, e essa eliminação é irreversível.
1 <= x <= 120O que acontece ao embedding facial de uma sessão quando a sessão é eliminada. retain_until_user_deleted requer face_retention_days no mesmo pedido ou já definido. Uma alteração aplica-se às eliminações de sessões a partir desse momento; não cria nem elimina definitivamente nenhum template biométrico existente.
delete_with_session, retain_until_user_deleted Período de conservação, em dias, dos templates biométricos sob retain_until_user_deleted.
1 <= x <= 3650Quando o fluxo alojado e os SDKs nativos solicitam à pessoa consentimento biométrico explícito antes de uma captura de rosto. auto (predefinição) solicita apenas quando se aplica um acionador: um estado declarado, o IP da pessoa ou o emissor do documento de identificação situa-se em Illinois, Texas ou Colorado, ou a pessoa aparenta estar nos EUA sem um estado conhecido. always solicita a todas as pessoas cujo fluxo capture um rosto. never nunca apresenta o passo, e recolhe o consentimento por sua conta antes da selfie. Cada alteração é registada no registo de auditoria. Consulte Consentimento biométrico.
auto, always, never Substitui toda a lista de anfitriões de retorno da carteira de Digital ID. Apenas nomes de anfitrião simples, como shop.example.com: sem esquema, porta, caminho ou caráter universal. Os valores são convertidos para minúsculas e os duplicados são eliminados. Envie [] para limpar a lista.
20253Substitui toda a lista de origens permitidas. Origens (por exemplo https://app.example.com; http apenas para localhost) nas quais o fluxo de verificação alojado pode ser incorporado e para as quais pode redirecionar o utilizador com um callback de sessão. As chamadas servidor a servidor não são afetadas. Uma lista vazia significa sem restrições. A Didit armazena cada origem em minúsculas sem uma porta predefinida. Uma entrada inválida falha com 400 em allowed_domains. Envie [] para remover a restrição.
50300["https://app.example.com"]
Resposta
A configuração completa após a atualização, com a mesma estrutura de GET /v3/webhook/. Quando rodar o segredo, guarde a nova secret_shared_key antes de descartar a resposta.
Configuração de webhooks ao nível da aplicação, política de conservação e anfitriões de retorno de carteira Digital ID, com todos os destinos de webhook.
URL de webhook ao nível da aplicação (legado). O Didit apenas envia para este URL enquanto a aplicação não tiver nenhum destino ativado, e apenas envia status.updated e data.updated. Cada criação, atualização ou eliminação de um destino define-o para o URL do destino ativado mais antigo, ou null quando nenhum estiver ativado.
Versão do payload do webhook_url legado. Cada destino tem o seu próprio webhook_version.
v1, v2, v3 Segredo de assinatura ao nível da aplicação (token de 43 carateres seguro para URL). Assina apenas entregas para o webhook_url legado; cada destino assina com a sua própria secret_shared_key. Chamadas autenticadas com chave de API recebem-no sempre na íntegra; utilizadores da Consola sem read:webhooks recebem uma cadeia de carateres vazia.
Definição legada da aplicação. O fluxo de verificação não a lê: as opções de captura são configuradas por fluxo.
MOBILE, MOBILE_AND_DESKTOP Janela de eliminação automática. As sessões de verificação de utilizadores criadas há mais meses do que este valor (um mês conta como 30 dias) são eliminadas automaticamente, e essa eliminação é irreversível. null significa que as sessões nunca são eliminadas automaticamente. Consulte Conservação de dados.
1 <= x <= 120O que acontece ao embedding facial de uma sessão quando a sessão é eliminada. delete_with_session (predefinição) elimina-o com a sessão. retain_until_user_deleted é a opção de adesão à conservação de templates biométricos: um template biométrico sem imagem associado ao Utilizador é gerido separadamente até que o seu período de conservação termine, o Utilizador seja eliminado ou o elimine definitivamente.
delete_with_session, retain_until_user_deleted Período de conservação, em dias, dos templates biométricos sob retain_until_user_deleted. Obrigatório quando essa política está definida.
1 <= x <= 3650Todos os tipos de eventos que um destino pode subscrever, com uma etiqueta de exibição.
Show child attributes
Show child attributes
Nomes de anfitrião (correspondência exata, apenas HTTPS) para os quais uma verificação autónoma de carteira de Identidade Digital pode reenviar o utilizador com o seu return_url. O seu domínio de marca branca também é sempre permitido. Consulte Registar o seu destino de retorno.
20253Todos os destinos de webhook da aplicação, do mais antigo para o mais recente, cada um com o respetivo segredo de assinatura. Apenas de leitura aqui: faça a gestão dos destinos com os endpoints /v3/webhook/destinations/.
Show child attributes
Show child attributes
Quando o fluxo alojado e os SDKs nativos solicitam à pessoa consentimento biométrico explícito antes de uma captura de rosto. auto (predefinição) solicita apenas quando se aplica um acionador: um estado declarado, o IP da pessoa ou o emissor do documento de identificação situa-se em Illinois, Texas ou Colorado, ou a pessoa aparenta estar nos EUA sem um estado conhecido. always solicita a todas as pessoas cujo fluxo capture um rosto. never nunca apresenta o passo, e recolhe o consentimento por sua conta antes da selfie. Cada alteração é registada no registo de auditoria. Consulte Consentimento biométrico.
auto, always, never Origens (por exemplo https://app.example.com; http apenas para localhost) nas quais o fluxo de verificação alojado pode ser incorporado e para as quais pode redirecionar o utilizador com um retorno de chamada da sessão. As chamadas servidor a servidor não são afetadas. Uma lista vazia significa nenhuma restrição. A Didit armazena cada origem em minúsculas sem uma porta predefinida. Uma entrada inválida falha com 400 em allowed_domains.
50300["https://app.example.com"]