Escopos

Os sistemas BTG Pactual Empresas fazem a segurança a nível de usuário, ou seja, utilizamos as permissões que o usuário concede para decidir ao que o seu sistema terá acesso na conta daquele usuário específico.

Ao mesmo tempo, precisamos saber ao que o seu sistema tem acesso, para que possamos garantir a integridade dos serviços e aumentar a segurança do usuário final.

Para servir estas duas funções implementamos o que chamamos no nosso ecossitema de Escopos.

openid

O escopo openid é obrigatório para, efetivamente, todos os serviços da API de banking. Logo, tenha em mente que ele precisará sempre estar incluso no seu fluxo.

Alguns casos específicos, como o fluxo de client credentials, não necessitam desse escopo.

readonly

Os escopos com .readonly são escopos que permitem apenas os métodos de leitura e listagem.

Claim

No fluxo de authorization code os escopos do formato empresas.btgpactual.com/[recurso] gerarão o que chamamos de claim. Uma claim é um "pedaço" de informação no token que diz algo ao nosso sistema. Neste caso, a claim gerada estará nos informando que o token permite o acesso a um dado recurso em uma dada empresa.

A claim resultante de um escopo do formato descrito acima é "empresas.btgpactual.com/[recurso]":"CNPJ" e indica que o token possui permissão para acessar o recurso especificado na conta do CNPJ especificado.

A ausência de uma claim deste tipo ou a ausência do CNPJ é o principal causador do erro 403. Visite Troubleshooting para conhecer a solução para este cenário.