Primeiros passos
Integração / SDKs
Verificação de usuários
Verificação de empresas
Monitoramento de transações
Registro de alteraçõesAs chaves criadas antes da existência do acesso com escopo mantêm acesso total.
Nada muda para elas até que você edite o acesso delas.
Onde encontrá-las
No Business Console, selecione sua aplicação e abra Developers -> API keys. A lista mostra todas as chaves da aplicação com o status, as requisições dos últimos 30 dias, quem a criou, o acesso e quando foi usada pela última vez. Clique em uma chave para pré-visualizá-la à direita ou abra a página completa dela para ver o uso, o acesso, as requisições recentes, um snippet de início rápido e a atividade. As chaves pertencem a uma aplicação e funcionam somente para ela. Uma chave usa o ambiente da aplicação: as chaves de uma aplicação de 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 que você selecionou.
Quando a lista de Domínios permitidos tem entradas, Create session rejeita com um erro
400 um callback que não esteja em nenhuma delas.
Uma lista vazia significa que não há restrições.
As chamadas de servidor para servidor não são afetadas.
Criar uma chave
1
Detalhes
Dê à chave o nome do serviço que vai usá-la e escolha quando ela expira: nunca, em 30 dias, 90 dias, um ano ou em uma data que você escolher.
Uma chave expirada para de funcionar no fim desse dia, em UTC.
2
Acesso
Comece por uma predefinição e depois ajuste-a para cada recurso.
A chave nunca poderá fazer mais do que isso.
3
Revisão
O console detalha o que a chave pode e o que não pode fazer antes de você entregá-la.
4
Chave secreta
Copie o segredo e guarde-o no seu gerenciador de segredos.
Esta é a única vez em que o segredo completo é exibido.
Se você perdê-lo, faça a rotação da chave para obter um novo.
Predefinições
Recursos
Leitura abrange requisiçõesGET em um recurso; escrita também abrange POST, PUT, PATCH e DELETE.
Uma chave com acesso personalizado funciona na API pública: nos endpoints de sessões, usuários, empresas, transações, fluxos e webhooks, e nas verificações avulsas.
Os endpoints usados apenas pelo Business Console respondem
403 a ela; eles exigem uma chave com acesso total.
Uma chave sem leitura em Mídia recebe as decisões das sessões com todas as URLs de imagens, vídeos e PDFs definidas como null, e os endpoints de relatórios em PDF respondem 403.
Uma chave sem escrita em Sessões nunca recebe o link de verificação nem o token de sessão de uma sessão, já que quem os tiver pode concluir a verificação como o usuário final: esses campos retornam como null.
Pelo mesmo motivo, criar uma pessoa com send_verification_link: true exige escrita em Sessões além da escrita em Pessoas, porque isso cria uma sessão e envia o link dela 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.
Ela não pode ter acesso a pessoas, empresas, transações ou análises, e não pode executar verificações avulsas.
Respostas da API para uma chave com escopo
As listas de sessões retornam apenas as sessões permitidas pelos limites da chave.
Editar acesso
Abra o menu de uma chave, sua visualização ou sua página e escolha Editar acesso. Altere a predefinição, os recursos, os limites ou a expiração e depois revise apenas o que muda, antes e depois. O segredo continua o mesmo, então não é preciso fazer nova implantação nada, e o novo acesso entra em vigor em até um minuto. O segredo principal sempre tem acesso total e não pode ser editado.Fazer a rotação de uma chave
A rotação substitui o segredo de uma chave. O novo segredo é exibido uma vez, e o segredo atual continua funcionando por 24 horas para que você possa implantar o novo sem tempo de inatividade. Depois disso, toda requisição com o segredo antigo responde401.
A rotação do segredo principal é feita da mesma forma, com a mesma sobreposição de 24 horas.
Revogar uma chave
A revogação desativa uma chave imediatamente: toda requisição feita com ela recebe uma resposta401.
Isso não pode ser desfeito.
O segredo principal não pode ser revogado; faça a rotação dele.