Autenticação da API: Pedidos Seguros à API de KYC

Encontrar a sua chave de API

No Didit, as chaves de API estão associadas ao âmbito de uma Aplicação específica na sua conta. Uma Aplicação é um espaço de trabalho onde pode configurar fluxos e gerir verificações para um projeto ou ambiente específico. Cada Aplicação recebe uma chave de API primária com acesso total quando a cria. Pode adicionar mais chaves além desta, cada uma apenas com o acesso de que um serviço ou parceiro necessita. Para encontrar as suas chaves:

Iniciar sessão na Business Console

Aceda à Didit Business Console e inicie sessão.

Selecionar a sua Aplicação

Escolha a Aplicação com a qual pretende trabalhar a partir do menu pendente no topo.

Abrir as chaves de API

Navegue até Developers -> API keys na barra lateral esquerda.

Copiar ou criar uma chave

A chave Primária é o segredo da própria Aplicação. Crie uma nova chave para atribuir a um serviço ou parceiro o seu próprio segredo, com o acesso de que necessita.

A sua chave de API é um segredo — trate-a como uma palavra-passe.A chave primária concede acesso total à API em nome da sua Aplicação. Nunca a exponha em código de frontend, repositórios públicos ou bundles do lado do cliente. Mantenha-a sempre exclusivamente no lado do servidor.

Formato da chave de API

As novas chaves de API começam com sk_live_ para uma aplicação em produção ou sk_test_ para uma aplicação em sandbox, seguidas de 43 carateres seguros para URL (letras, dígitos, - e _). As chaves criadas antes deste formato não têm prefixo e continuam a funcionar sem alterações. Envie a chave completa, prefixo incluído, no cabeçalho x-api-key, e não rejeite uma chave por não ter prefixo.

Encontrar o seu ID da organização

O seu ID da organização é o UUID que identifica a sua organização. É utilizado em caminhos da API com âmbito de organização, tais como /auth/v2/organizations/me/{org_id}/applications/. Pode copiá-lo diretamente da Business Console, sem necessidade de efetuar chamadas de API:

Abrir as definições da organização

Na Didit Business Console, aceda a Definições da Organização.

Copiar o ID da organização

O campo ID da organização mostra o UUID da sua organização junto ao nome da mesma, com um botão para copiar para a área de transferência.

Fazer pedidos autenticados

Para autenticar um pedido à API, inclua a sua chave de API secreta no cabeçalho HTTP x-api-key. Eis um exemplo de um pedido autenticado para o endpoint Create Session:

cURL

curl --request POST \
     --url https://verification.didit.me/v3/session/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY' \
     --data '
{
  "workflow_id": "WORKFLOW_ID",
  "vendor_data": "USER_ID",
  "callback": "CALLBACK_URL"
}
'

Tratamento de erros

Se a sua chave de API estiver incorreta, malformada ou revogada, a API devolve 401 Unauthorized:

{
  "detail": "Authentication credentials were not provided or are invalid."
}

Uma chave expirada também devolve 401, com "detail": "This API key has expired.". Um pedido sem chave devolve 403 com "detail": "You do not have permission to perform this action.".

Código de estado	Significado
401	A chave de API está incorreta, malformada, revogada ou expirada
403	Não foi enviada nenhuma chave de API, a chave não tem acesso ao recurso ou ação solicitada, ou o pedido teve origem num endereço fora da lista de IP da chave
403 com `"code": "application_deleted"`	A chave pertence a uma aplicação que foi eliminada. A API responde com isto durante alguns minutos após a eliminação e, em seguida, recusa a chave como qualquer chave inválida. Não tente novamente: a aplicação e as suas chaves já não existem.
404	Numa rota de sessão: a sessão está fora dos fluxos ou estados da chave

A página Erros da API lista todos os estados, corpos e códigos.

Chaves de API com âmbito limitado

Atribua a cada serviço ou parceiro a sua própria chave em vez de partilhar a primária. Cada chave tem o seu próprio nível de acesso a cada recurso: sem acesso, de leitura ou de escrita (sessões, decisões, ficheiros multimédia, pessoas, empresas, transações, fluxos, webhooks, definições da aplicação, analítica), e limites opcionais a determinados fluxos, apenas a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. Pode fazer a rotação de uma chave, mantendo uma sobreposição de 24 horas, e revogá-la de imediato. As chaves criadas antes da introdução do acesso com âmbito limitado mantêm o acesso total. Consulte Chaves de API para conhecer as predefinições, os recursos que cada uma abrange e como a API responde a uma chave com âmbito limitado.

Se receber um erro 401, verifique se está a utilizar a chave de API correta para a Aplicação certa e confirme que esta não foi regenerada.

Visão geral

Preços

Fluxos e verificação

Revisão e operações

Entidades (utilizadores e empresas)

Definições e personalização

Segurança e conformidade

Didit Academy

Recursos

Autenticação da API: Pedidos Seguros à API de KYC

Encontrar a sua chave de API

Formato da chave de API

Encontrar o seu ID da organização

Fazer pedidos autenticados

Tratamento de erros

Chaves de API com âmbito limitado

​Encontrar a sua chave de API

​Formato da chave de API

​Encontrar o seu ID da organização

​Fazer pedidos autenticados

​Tratamento de erros

​Chaves de API com âmbito limitado

Encontrar a sua chave de API

Formato da chave de API

Encontrar o seu ID da organização

Fazer pedidos autenticados

Tratamento de erros

Chaves de API com âmbito limitado