Participants

Information about participants available in the Open Finance API.

Get the participants institutions of Open Finance

This endpoint is used to retrieve information about one or more participants that are active in Open Finance.

Tip

To list all active participants, it is not necessary to send the 'name' attribute in the request.

GET /v1/participantes

Requires authorization for the scope: gn.opb.participants.read

Request

The snippet below shows how the organizacao, nome and modalidade parameters should be passed in the request.
/open-finance/participantes?organizacao=false&nome=exemplo&modalidade=pagamentos

Responses

The responses below represent Success(200) and consumption failures/errors.

🟢 200

List with one or more Open Finance participants
{
  "participantes": [
    {
      "identificador": "ebbed125-5cd7-42e3-965d-2e7af8e3b7ae",
      "nome": "Efí S.A.",
      "descricao": "Descrição da marca",
      "portal": "https://openbankingbrasil.org.br/quem-participa/",
      "logo": "https://www.gerencianet.com.br/logo.png",
      "organizacoes": [
        {
          "nome": "Efí S.A.",
          "cnpj": "09089356000118,",
          "status": "Ativo"
        }
      ]
    }
  ]
}

🔴 404

Invalid name
{
  "nome": "participante_nao_encontrado",
  "mensagem": "Nenhum participante encontrado"
}

🔴 500

Application error
{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}