Ao utilizar scopes, você define a quais funcionalidades o token gerado terá acesso.
📘
Nota
No API Reference, você encontra o scope correspondente de cada endpoint em sua respectiva página.
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 de Autenticação e autorização (mTLS / DCR) da v1.
Veja a seguir os scopes suportados na geração do token:
| Scope | Descrição |
|---|
| card.create | Concede acesso para emitir um novo cartão de crédito. |
| card.update | Concede acesso para alterar o status de um cartão de crédito. |
| 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.password.update | Concede acesso para atualizar a senha de um cartão de crédito. |
| Scope | Descrição |
|---|
| account.create | Concede acesso para criar uma conta de pagamento. |
| account.read | Concede acesso para consultar informações (status, saldo etc.) sobre uma conta de pagamentos. |
| account.close | Concede acesso para encerrar uma conta de pagamento. |
| 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.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. |
| business.read | Concede acesso para consultar o registro de um cliente pessoa jurídica. |
| business.cancel | Concede acesso para encerrar o vínculo comercial com um cliente pessoa jurídica. |
| Scope | Descrição |
|---|
| certificate.create | Concede acesso para emitir e baixar o certificado para mTLS. |
| Scope | Descrição |
|---|
| kyc.document.write | Concede acesso para upload de imagens para análise KYC. |
| kyc.document.read | Concede acesso para consulta de análise de imagens enviadas para KYC. |
| Scope | Descrição |
|---|
| income.report.read | Concede acesso para consulta e impressão do informe de rendimentos da conta. |
| 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 |
|---|
| limits.write | Concede acesso para atualizar e ler o limite transacional de um cliente pessoa física ou jurídica, personalizado por conta. |
| limits.read | Leitura de valor máximo para parceiro transacionar dado pelo Bankly. Essa alteração só ocorre internamente. |
| 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 |
|---|
| 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 |
|---|
| pix.account.read | Concede acesso para consultar as chaves vinculadas a uma conta de pagamento. |
| pix.entries.create | Concede acesso para registrar uma chave de endereçamento. |
| pix.entries.delete | Concede acesso para excluir uma chave de endereçamento. |
| Scope | Descrição |
|---|
| pix.entries.read | Concede acesso para consultar chaves de endereçamento. |
| Scope | Descrição |
|---|
| pix.qrcode.create | Concede acesso para emissão de um QR Code Pix. |
| pix.qrcode.read | Concede acesso para decodificar um QR Code Pix. |
| Scope | Descrição |
|---|
| pix.cashout.create | Concede acesso para iniciar um pagamento via Pix. |
| pix.cashout.read | Concede acesso para consultar um pagamento de Pix realizado. |
| Scope | Descrição |
|---|
| webhook.write | Concede acesso para criar ou atualizar 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. |
| Scope | Descrição |
|---|
| events.read | Concede acesso à consulta de eventos. |
| 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. |
