18. Listando as organizações cadastradas no Diretório via API

Para acessar a API Organisations no Diretório, você precisará de um token de acesso. Esta seção descreve as etapas necessárias para listar e visualizar os detalhes das organizações cadastradas no Diretório.

Etapa 1: Obtendo Detalhes das Organizações

Requisitos

1. Necessário ter um token de acesso. Veja mais detalhes em Obtendo um token de acesso para acessar as APIs do Diretório.

2. Para fins ilustrativos será utilizado o Postman para acessar as APIs do Diretório do Open Finance. Assim, para adicionar uma nova requisição a uma coleção, abra uma nova aba e salve a partir daí, ou em Collection à esquerda do Postman, clique em '...' na coleção e escolha Add Request. Você também pode criar uma solicitação clicando no menu File > New, e em seguida Request.

3. No campo Enter request URL, insira um dos valores descritos a seguir de acordo com o ambiente utilizado:

Sandbox: https://matls-auth.sandbox.directory.openbankingbrasil.org.br/organisations

Produção: https://matls-auth.directory.openbankingbrasil.org.br/organisations

4. Defina o tipo da operação para GET.

5. Vá para a guia Authorisation e na caixa de seleção Type selecione a opção Bearer Token.

6. Na coluna ao lado, no campo Token cole o access_token obtido na seção Obtendo um token de acesso para acessar as APIs do Diretório.

7. Uma vez que todos os valores estejam preenchidos, clique no botão Send. Você verá a resposta de dados JSON do servidor no painel inferior.

NOTA: Para localizar uma organização mãe que pertença a um conglomerado, você poderá percorrer na lista de resposta de dados JSON do servidor, capturando o identificador no atributo ParentOrganisationReference das organizações filhas e localizar o mesmo ID na organização cujo o atributo RegistrationId contenha este mesmo valor.