Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo de alteraçõesAs chaves criadas antes do acesso limitado continuam a ter acesso total.
Nada muda para elas até que edite o respetivo acesso.
Onde encontrar as chaves
Na Consola Empresarial, selecione a sua aplicação e abra Developers -> API keys. A lista mostra todas as chaves da aplicação, com o respetivo estado, os pedidos dos últimos 30 dias, quem a criou, o respetivo acesso e a data da última utilização. Clique numa chave para a pré-visualizar à direita, ou abra a respetiva página completa para ver a utilização, o acesso, os pedidos recentes, um trecho de início rápido e a atividade. As chaves pertencem a uma única aplicação e funcionam apenas para ela. Uma chave herda o ambiente da aplicação: as chaves de uma aplicação sandbox nunca criam verificações faturadas.URLs de redirecionamento e domínios permitidos
Abra Developers > API keys > Redirects and domains para definir duas listas para a aplicação e o ambiente selecionados.
Quando a lista Domínios permitidos tem entradas, o Criar sessão rejeita um
callback que não esteja em nenhuma delas, com um erro 400.
Uma lista vazia significa que não há restrição.
As chamadas servidor a servidor não são afetadas.
Criar uma chave
1
Detalhes
Dê à chave o nome do serviço que a vai usar e escolha quando expira: nunca, em 30 dias, em 90 dias, num ano ou numa data à sua escolha.
Uma chave expirada deixa de funcionar no fim desse dia, em UTC.
2
Acesso
Comece por uma predefinição e depois ajuste-a recurso a recurso.
A chave nunca pode fazer mais do que isto.
3
Revisão
A consola indica de forma clara o que a chave pode e não pode fazer, antes de a entregar.
4
Chave secreta
Copie o segredo e guarde-o no seu gestor de segredos.
Esta é a única vez em que o segredo completo é mostrado.
Se o perder, rode a chave para obter um novo.
Predefinições
Recursos
A leitura abrange os pedidosGET a um recurso; a escrita abrange também POST, PUT, PATCH e DELETE.
Uma chave com acesso personalizado funciona na API pública: nos endpoints de sessão, de utilizador, de empresa, de transação, de fluxo e de webhook, e nas verificações autónomas.
Os endpoints que só a Business Console usa respondem
403 a esta chave; exigem uma chave com acesso total.
Uma chave sem leitura de Multimédia recebe as decisões das sessões com todos os URLs de imagens, vídeos e PDFs definidos como null, e os endpoints de relatórios PDF respondem 403.
Uma chave sem escrita em Sessões nunca recebe a ligação de verificação nem o token de sessão de uma sessão, uma vez que quem os tiver pode concluir a verificação em nome do utilizador final: esses campos são devolvidos com o valor null.
Pelo mesmo motivo, criar uma pessoa com send_verification_link: true requer escrita em Sessões além de escrita em Pessoas, porque cria uma sessão e envia a respetiva ligação por e-mail.
Sem isso, a chamada responde 403 e não cria nada.
Limites
Uma chave limitada a alguns fluxos ou a sessões aprovadas funciona nos endpoints de sessões, onde o limite pode ser aplicado.
Não pode ter acesso a pessoas, empresas, transações ou análises, e não pode executar verificações autónomas.
Como a API responde a uma chave com restrições
As listas de sessões devolvem apenas as sessões que os limites da chave permitem.
Editar acesso
Abra o menu, a pré-visualização ou a página de uma chave e escolha Edit access. Altere a predefinição, os recursos, os limites ou a expiração, e depois reveja apenas o que muda, antes e depois. O segredo mantém-se, pelo que não é necessário voltar a implementar nada, e o novo acesso aplica-se no prazo de um minuto. O segredo principal tem sempre acesso total e não pode ser editado.Rodar uma chave
Rodar substitui o segredo de uma chave. O novo segredo é mostrado uma única vez, e o segredo atual continua a funcionar durante 24 horas, para que possa implementar o novo sem interrupção do serviço. Passado esse prazo, todos os pedidos feitos com o segredo antigo respondem401.
O segredo principal é rodado da mesma forma, com a mesma sobreposição de 24 horas.
Revogar uma chave
A revogação desativa imediatamente uma chave: todos os pedidos feitos com ela respondem401.
Não pode ser desfeita.
O segredo principal não pode ser revogado; em alternativa, rode-o.