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.

Uso dos scopes

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.

Scopes para geração do token

Veja a seguir os scopes suportados na geração do token:

Emissão de cartão

ScopeDescrição
card.createConcede acesso para emitir um novo cartão de crédito.
card.updateConcede acesso para alterar o status de um cartão de crédito.
card.readConcede acesso para consultar dados não PCI de um cartão de crédito.
card.pci.readConcede acesso para consultar dados PCI de um cartão de crédito.
card.pci.password.updateConcede acesso para atualizar a senha de um cartão de crédito.

Contas

ScopeDescrição
account.createConcede acesso para criar uma conta de pagamento.
account.readConcede acesso para consultar informações (status, saldo etc.) sobre uma conta de pagamentos.
account.closeConcede acesso para encerrar uma conta de pagamento.

Cadastro de pessoa física

ScopeDescrição
customer.writeConcede acesso para criar ou atualizar o registro de um cliente pessoa física.
customer.readConcede acesso para consultar o registro de um cliente pessoa física.
customer.cancelConcede acesso para encerrar o vínculo comercial com um cliente pessoa física.

Cadastro pessoa jurídica

ScopeDescrição
business.writeConcede acesso para criar ou atualizar o registro de um cliente pessoa jurídica.
business.readConcede acesso para consultar o registro de um cliente pessoa jurídica.
business.cancelConcede acesso para encerrar o vínculo comercial com um cliente pessoa jurídica.

Certificado mTLS

ScopeDescrição
certificate.createConcede acesso para emitir e baixar o certificado para mTLS.

Know your customer (KYC)

ScopeDescrição
kyc.document.writeConcede acesso para upload de imagens para análise KYC.
kyc.document.readConcede acesso para consulta de análise de imagens enviadas para KYC.

Informe de rendimentos

ScopeDescrição
income.report.readConcede acesso para consulta e impressão do informe de rendimentos da conta.

Boletos

ScopeDescrição
boleto.createConcede acesso para emitir um novo boleto de depósito ou cobrança.
boleto.readConcede acesso para consultar o status de um boleto de depósito ou cobrança.
boleto.deleteConcede acesso para deletar um boleto de depósito.

Limites

ScopeDescrição
limits.writeConcede acesso para atualizar e ler o limite transacional de um cliente pessoa física ou jurídica, personalizado por conta.
limits.readLeitura de valor máximo para parceiro transacionar dado pelo Bankly. Essa alteração só ocorre internamente.

Pagamento de contas

ScopeDescrição
payment.validateConcede acesso para validar um boleto emitido por outra instituição.
payment.confirmConcede acesso para confirmar o pagamento de um boleto emitido por outra instituição.
payment.readConcede acesso para consultar o pagamento de um boleto emitido por outra instituição.

TED/Transferência interna

ScopeDescrição
ted.cashout.createConcede acesso para iniciar uma transferência de valores via TED.
ted.cashout.readConcede acesso para consultar detalhes de uma transferência via TED.

Pix - Gestão de chaves

ScopeDescrição
pix.account.readConcede acesso para consultar as chaves vinculadas a uma conta de pagamento.
pix.entries.createConcede acesso para registrar uma chave de endereçamento.
pix.entries.deleteConcede acesso para excluir uma chave de endereçamento.

Pix - Consulta de chaves (DICT)

ScopeDescrição
pix.entries.readConcede acesso para consultar chaves de endereçamento.

Pix - QR Code

ScopeDescrição
pix.qrcode.createConcede acesso para emissão de um QR Code Pix.
pix.qrcode.readConcede acesso para decodificar um QR Code Pix.

Pix - Cash-out

ScopeDescrição
pix.cashout.createConcede acesso para iniciar um pagamento via Pix.
pix.cashout.readConcede acesso para consultar um pagamento de Pix realizado.

Webhooks

ScopeDescrição
webhook.writeConcede acesso para criar ou atualizar um webhook
webhook.deleteConcede acesso para excluir um webhook.
webhook.readConcede acesso para consultar configurações de webhooks, pesquisar mensagens enviadas e realizar o reprocessamento de mensagens.

Events

ScopeDescrição
events.readConcede acesso à consulta de eventos.

Serviços auxiliares

ScopeDescrição
zipcode.readConcede acesso à consulta de endereços através do código postal.
banklist.readConcede acesso à lista de instituições financeiras por produto.