Ao utilizar scopes, você define a quais funcionalidades o token gerado terá acesso.
📘
Nota
Todas as páginas que descrevem os endpoints especificam o scope necessário para o seu uso.
Você poderá utilizar até dez scopes para cada token gerado, separados por um espaço em branco, como no exemplo seguinte:
scope=“kyc.document.write business.write boleto.read"
✅
Dica
Para exemplo de requisição com o uso de scopes, consulte a documentação Token para gerar certificado mTLS.
Veja a seguir os scopes suportados na geração do token:
| Scope | Descrição |
|---|
boleto.create | Concede acesso para emitir um novo boleto de depósito ou cobrança. |
boleto.read | Concede acesso para consultar o status de um boleto de depósito ou cobrança. |
boleto.delete | Concede acesso para deletar um boleto de depósito. |
| Scope | Descrição |
|---|
customer.write | Concede acesso para criar ou atualizar o registro de um cliente pessoa física. |
customer.read | Concede acesso para consultar o registro de um cliente pessoa física. |
customer.update | Concede acesso para atualizar o cadastro do cliente pessoa física. |
customer.cancel | Concede acesso para encerrar o vínculo comercial com um cliente pessoa física. |
| Scope | Descrição |
|---|
business.write | Concede acesso para criar ou atualizar o registro de um cliente pessoa jurídica do tipo MEI, EI, EIRELI ou SLU. |
business.corporation.write | Concede acesso para criar ou atualizar os dados de um cliente pessoa jurídica do tipo SA, LTDA e TS. |
business.read | Concede acesso para consultar o registro de qualquer tipo de cliente pessoa jurídica. |
business.cancel | Concede acesso para encerrar o vínculo comercial com um cliente pessoa jurídica de qualquer tipo. |
| Scope | Descrição |
|---|
certificate.create | Concede acesso para emitir e baixar o certificado para mTLS. |
| Scope | Descrição |
|---|
events.read | Concede acesso à consulta de eventos. |
| Scope | Descrição |
|---|
account.create | Concede acesso para criar uma conta. |
account.read | Concede acesso para consultar informações (status, saldo etc.) sobre uma conta. |
account.close | Concede acesso para encerrar uma conta. |
| Scope | Descrição |
|---|
card.create | Concede acesso para emitir um novo cartão de crédito. |
card.update | Concede acesso para realizar atualizações no cartão de crédito, como alterar o status ou endereço de entrega. |
card.read | Concede acesso para consultar dados não PCI de um cartão de crédito. |
card.pci.read | Concede acesso para consultar dados PCI de um cartão de crédito. |
card.pci.token.create | Concede acesso para a geração de um token. |
card.pci.password.update | Concede acesso para atualizar a senha de um cartão de crédito. |
| Scope | Descrição |
|---|
credit.write | Concede acesso para solicitar análise ou reanálise de crédito para um cliente e para enviar o aceite da proposta de crédito. |
credit.read | Concede acesso para consultar os contratos de crédito de um cliente. |
| Scope | Descrição |
|---|
invoice.read | Concede acesso para realizar consultas referentes à gestão de faturas. |
invoice.write | Concede acesso para gerar uma forma de pagamento ou antecipar parcelas de uma fatura. |
| Scope | Descrição |
|---|
income.report.read | Concede acesso para consulta e impressão do informe de rendimentos da conta. |
| Scope | Descrição |
|---|
kyc.document.deepface.write | Concede acesso para envio de imagens para análise com ID One. |
kyc.document.read | Concede acesso para consulta de análise de imagens enviadas para KYC. |
kyc.document.write | Concede acesso para upload de imagens para análise KYC. |
| Scope | Descrição |
|---|
payment.validate | Concede acesso para validar um boleto emitido por outra instituição. |
payment.confirm | Concede acesso para confirmar o pagamento de um boleto emitido por outra instituição. |
payment.read | Concede acesso para consultar o pagamento de um boleto emitido por outra instituição. |
| Scope | Descrição |
|---|
pix.account.read | Concede acesso para consultar as chaves vinculadas a uma conta. |
pix.entries.create | Concede acesso para registrar uma chave de endereçamento. |
pix.entries.read | Concede acesso para consultar chaves de endereçamento. |
pix.entries.delete | Concede acesso para excluir uma chave de endereçamento. |
pix.claims.create | Concede acesso para criar um pedido de portabilidade de chaves ou reivindicar a posse para outra instituição. |
pix.claims.read | Concede acesso para consultar pedidos de portabilidade de chaves ou de reivindicação da posse para outra instituição. |
pix.claims.confirm | Concede acesso para confirmar um pedido de reivindicação. |
pix.claims.complete | Concede acesso para completar um pedido de reivindicação. |
pix.claims.cancel | Concede acesso para cancelar um pedido de reivindicação. |
| Scope | Descrição |
|---|
pix.cashout.create | Concede acesso para iniciar um pagamento ou devolução via Pix. |
pix.cashout.read | Concede acesso para consultar uma transferência ou pagamento via Pix realizado. |
| Scope | Descrição |
|---|
pix.qrcode.create | Concede acesso para emissão de QR Code estático para pagamentos via Pix. |
pix.qrcode-dynamic-payment.create | Concede acesso para emissão de QR Code dinâmico para pagamentos via Pix. |
pix.qrcode.read | Concede acesso para decodificar um QR Code Pix. |
| Scope | Descrição |
|---|
pocket.create | Concede acesso para a criação de contas pockets. |
pocket.read | Concede acesso para a consulta de dados das contas pockets. |
pocket.update | Concede acesso para a alteração do usuário das contas pockets. |
pocket.transaction.create | Concede acesso para realizar transações internas com uma conta pocket. |
pocket.transaction.read | Concede acesso para consultar uma transação feita entre a pocket e a conta de pagamento. |
pocket.close | Concede acesso para realizar o encerramento de uma conta pocket. |
| Scope | Descrição |
|---|
zipcode.read | Concede acesso à consulta de endereços através do código postal. |
banklist.read | Concede acesso à lista de instituições financeiras por produto. |
| Scope | Descrição |
|---|
ted.cashout.create | Concede acesso para iniciar uma transferência de valores via TED. |
ted.cashout.read | Concede acesso para consultar detalhes de uma transferência via TED. |
| Scope | Descrição |
|---|
totp.create | Concede acesso para gerar um hash e um código numérico para validação TOTP. |
totp.validate | Concede acesso para validar o hash e o código numérico. |
| Scope | Descrição |
|---|
card.network.transactions.3ds.write | Concede acesso para a simulação de criação do desafio. |
| Scope | Descrição |
|---|
webhook.write | Concede acesso para criar, atualizar, habilitar e desabilitar um webhook. |
webhook.delete | Concede acesso para excluir um webhook. |
webhook.read | Concede acesso para consultar configurações de webhooks, pesquisar mensagens enviadas e realizar o reprocessamento de mensagens. |
