swagger: '2.0’
info:
description: Dados cadastrais de entidades autorizadas
version: '1.0’
title: Dados cadastrais de entidades autorizadas
host: gateway.gr1d.io
basePath: /sandbox/bancocentral/entidadesautorizadas/v1
schemes:
- https
produces:
- application/json;odata.metadata=minimal
- application/xml
- text/csv
- text/plain
- text/html
paths:
/TipoSituacaoPessoaJuridica:
get:
summary: Tipo de situação de pessoa jurídica
description: 'Domínio do atributo ‘‘Tipo de situação da pessoa jurídica’’, que envolve as situações que podem ser atribuídas às entidades no tocante à autorização para funcionamento, concedida pelo Banco Central.'
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoTipo
collectionFormat: csv
- name: $orderby
in: query
description: 'Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq 'João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaTipoSituacaoPessoaJuridica’
/TipoEntidadeSupervisionada:
get:
summary: Tipo de entidade supervisionada
description: Domínio relativo ao atributo ‘Tipo de entidade supervisionada’ e que diz respeito ao segmento de atuação da entidade.
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoTipo
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaTipoEntidadeSupervisionada’
/NaturezaJuridica:
get:
summary: Natureza jurídica
description: Relação de valores a serem atribuídos às entidades quanto à natureza jurídica.
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoNatureza
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaNaturezaJuridica’
/EsferaPublica:
get:
summary: Esfera pública
description: ‘Domínio relativo ao atributo ‘‘Esfera pública’’ da entidade, aplicável às instituições públicas e que indica se a entidade é controlada por ente da esfera federal, estadual ou municipal.‘
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoEsfera
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaEsferaPublica’
/ClasseCooperativa:
get:
summary: Classe de cooperativa
description: ‘Domínio relativo ao atributo ‘‘Classe de cooperativa’’, que diz respeito à classificação das cooperativas quanto à sua constituição, podendo ser ‘‘Central’’; ‘‘Confederação’’ ou ‘‘Singular’’.‘
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoClasse
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaClasseCooperativa’
/TipoCooperativa:
get:
summary: Tipo de cooperativa
description: ‘Domínio relativo ao atributo ‘‘Tipo de cooperativa’’, atribuído às cooperativas de crédito conforme as condições de admissão e dos tipos de associados.‘
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoTipo
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaTipoCooperativa’
/CategoriaCooperativa:
get:
summary: Categoria de Cooperativa
description: ‘Domínio relativo ao atributo ‘‘Categoria de Cooperativa’’, atribuído às cooperativas de acordo com os operações efetuadas e exposição de risco das mesmas.‘
tags:
- Todos
parameters:
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigo
- descricaoCategoria
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaCategoriaCooperativa’
/Cooperativas(dataBase=@dataBase):
get:
summary: Dados Cadastrais das Cooperativas Autorizadas
description: Dados cadastrais das cooperativas de créditos autorizadas a funcionar e abrangendo atributos específicos de tais entidades.
tags:
- Todos
parameters:
- name: ‘@dataBase’
in: query
description: Data base
required: false
type: string
pattern: ‘’’([^’’]|’’’’)’’’
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigoEntidadeInteresse
- codigoIdentificadorBacen
- siglaISO3digitos
- nomeDoPais
- nomeDaUnidadeFederativa
- codigoDoMunicipioNoIBGE
- nomeDoMunicipio
- nomeEntidadeInteresse
- nomeEntidadeInteresseNaoFormatado
- codigoCNPJ14
- codigoCNPJ8
- codigoTipoSituacaoPessoaJuridica
- descricaoTipoSituacaoPessoaJuridica
- codigoNaturezaJuridica
- descricaoNaturezaJuridica
- nomeReduzido
- siglaDaPessoaJuridica
- nomeFantasia
- codigoClasseCooperativa
- descricaoClasseCooperativa
- codigoTipoCooperativa
- descricaoTipoCooperativa
- codigoCategoriaCooperativa
- descricaoCategoriaCooperativa
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaCooperativa’
/EntidadesSupervisionadas(dataBase=@dataBase):
get:
summary: Dados Cadastrais das Entidades Autorizadas
description: ‘Dados cadastrais das entidades autorizadas a funcionar pelo Banco Central, inclusive das cooperativas de crédito.‘
tags:
- Todos
parameters:
- name: ‘@dataBase’
in: query
description: Data base
required: false
type: string
pattern: ‘’’([^’’]|’’’’)’’’
- name: $format
in: query
description: Tipo de conteúdo que será retornado
required: false
type: string
enum:
- json
- xml
- text/csv
- text/plain
- text/html
- name: $select
in: query
description: Propriedades que serão retornadas
required: false
type: array
items:
type: string
enum:
- codigoEntidadeInteresse
- codigoIdentificadorBacen
- siglaISO3digitos
- nomeDoPais
- nomeDaUnidadeFederativa
- codigoDoMunicipioNoIBGE
- nomeDoMunicipio
- nomeEntidadeInteresse
- nomeEntidadeInteresseNaoFormatado
- codigoCNPJ14
- codigoCNPJ8
- codigoTipoSituacaoPessoaJuridica
- descricaoTipoSituacaoPessoaJuridica
- codigoTipoEntidadeSupervisionada
- descricaoTipoEntidadeSupervisionada
- codigoNaturezaJuridica
- descricaoNaturezaJuridica
- codigoEsferaPublica
- nomeReduzido
- siglaDaPessoaJuridica
- nomeFantasia
- indicadorEsferaPublica
collectionFormat: csv
- name: $orderby
in: query
description: ‘Propriedades para ordenação das entidades. i.e. Nome asc, Idade desc’
required: false
type: string
- name: $filter
in: query
description: Filtro de seleção de entidades. i.e. Nome eq ‘João’
required: false
type: string
- name: $skip
in: query
description: Índice (maior ou igual a zero) da primeira entidade que será retornada
required: false
type: number
minimum: 0
format: int32
- name: $top
in: query
description: Número máximo (maior que zero) de entidades que serão retornadas
required: false
type: number
minimum: 1
format: int32
responses:
‘200’:
description: OK
schema:
$ref: ‘#/definitions/RespostaEntidadeSupervisionada’
definitions:
TipoSituacaoPessoaJuridica:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoTipo:
type: string
description: Descrição
title: Descrição
description: Tipo de situação de pessoa jurídica
RespostaTipoSituacaoPessoaJuridica:
properties:
value:
type: array
items:
$ref: ‘#/definitions/TipoSituacaoPessoaJuridica’
’@odata.context’:
type: string
TipoEntidadeSupervisionada:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoTipo:
type: string
description: Descrição
title: Descrição
description: Tipo de entidade supervisionada
RespostaTipoEntidadeSupervisionada:
properties:
value:
type: array
items:
$ref: ‘#/definitions/TipoEntidadeSupervisionada’
’@odata.context’:
type: string
NaturezaJuridica:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoNatureza:
type: string
description: Descrição
title: Descrição
description: Natureza jurídica
RespostaNaturezaJuridica:
properties:
value:
type: array
items:
$ref: ‘#/definitions/NaturezaJuridica’
’@odata.context’:
type: string
EsferaPublica:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoEsfera:
type: string
description: Descrição
title: Descrição
description: Esfera pública
RespostaEsferaPublica:
properties:
value:
type: array
items:
$ref: ‘#/definitions/EsferaPublica’
’@odata.context’:
type: string
ClasseCooperativa:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoClasse:
type: string
description: Descrição
title: Descrição
description: Classe de cooperativa
RespostaClasseCooperativa:
properties:
value:
type: array
items:
$ref: ‘#/definitions/ClasseCooperativa’
’@odata.context’:
type: string
TipoCooperativa:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoTipo:
type: string
description: Descrição
title: Descrição
description: Tipo de cooperativa
RespostaTipoCooperativa:
properties:
value:
type: array
items:
$ref: ‘#/definitions/TipoCooperativa’
’@odata.context’:
type: string
CategoriaCooperativa:
properties:
codigo:
type: integer
format: int32
description: Código
title: Código
descricaoCategoria:
type: string
description: Descrição
title: Descrição
description: Descrição
RespostaCategoriaCooperativa:
properties:
value:
type: array
items:
$ref: ‘#/definitions/CategoriaCooperativa’
’@odata.context’:
type: string
Cooperativa:
properties:
codigoEntidadeInteresse:
type: integer
format: int32
description: Identificador da entidade na base de dados mestres do Banco Central
title: Código da entidade no BCBase
codigoIdentificadorBacen:
type: string
description: Identificador da pessoa fisica ou juridica no cadastro unico do banco central. Gerado automaticamente pelo sistema
title: Código da entidade no cadastro do Banco Central
siglaISO3digitos:
type: string
description: Código ISO do pais sede na base de dados de geografia
title: Código do País Sede da Instituição
nomeDoPais:
type: string
description: Nome do país sede na base de dados de geografia
title: Nome do país sede da instituição
nomeDaUnidadeFederativa:
type: string
description: Nome da unidade federativa da sede da instituição
title: Nome da unidade federativa da sede da instituição
codigoDoMunicipioNoIBGE:
type: integer
format: int32
description: Código IBGE do município sede da instituição na base de dados de geografia
title: Código do município sede da instituição
nomeDoMunicipio:
type: string
description: Nome IBGE do município sede da instituição na base de dados de geografia
title: Nome do município sede da instituição
nomeEntidadeInteresse:
type: string
description: Denominação da pessoa jurídica
title: Nome da entidade
nomeEntidadeInteresseNaoFormatado:
type: string
description: Denominação da pessoa jurídica sem caracteres especiais e acentuação
title: Nome da entidade não formatado
codigoCNPJ14:
type: string
description: Numero de identificação da pessoa jurídica no Cadastro Nacional de Pessoa Juridica - CNPJ
title: CNPJ da entidade com 14 dígitos
codigoCNPJ8:
type: string
description: Descreve a raiz do número de identificação da pessoa jurídica no CNPJ
title: CNPJ da entidade com 8 dígitos
codigoTipoSituacaoPessoaJuridica:
type: integer
format: int32
description: Código da situação em que se encontra a ES no tocante ao seu funcionamento
title: Código da situação da entidade junto ao Banco Central
descricaoTipoSituacaoPessoaJuridica:
type: string
description: Descrição da situação em que se encontra a ES no tocante ao seu funcionamento
title: Descrição da situação da entidade junto ao Banco Central
codigoNaturezaJuridica:
type: integer
format: int32
description: Código do tipo de natureza juridica compativel com o instituto brasileiro de geografia e estatistica (IBGE) e a receita federal
title: Código da natureza jurídica da entidade
descricaoNaturezaJuridica:
type: string
description: Descrição do tipo de natureza juridica compativel com o instituto brasileiro de geografia e estatistica (IBGE) e a receita federal
title: Descrição da natureza jurídica da entidade
nomeReduzido:
type: string
description: 'Nome da instituição com abreviações, definido conforme critérios padronizados e na autorização para funcionamento da entidade’
title: Nome reduzido da entidade
siglaDaPessoaJuridica:
type: string
description: Informação opcional e apresentada pela instituição quando da autorização para funcionamento
title: Sigla da entidade
nomeFantasia:
type: string
description: Informação opcional e apresentada pela instituição quando da autorização para funcionamento
title: Nome fantasia da entidade
codigoClasseCooperativa:
type: integer
format: int32
description: 'Código da classificação das cooperativas de acordo com sua constituição, podendo ser ‘‘singular’’, ‘‘central’’ ou ‘‘confederação’’'
title: Código da classe da cooperativa
descricaoClasseCooperativa:
type: string
description: ‘Descreve a classificação das cooperativas de acordo com sua constituição, podendo ser ‘‘singular’’, ‘‘central’’ ou ‘‘confederação’’‘
title: Descrição da classe da cooperativa
codigoTipoCooperativa:
type: integer
format: int32
description: Classificação das cooperativas em função das condições de admissão e dos tipos de associados
title: Código do tipo da cooperativa
descricaoTipoCooperativa:
type: string
description: Descreve o tipo das cooperativas conforme os critérios de associação e tipos de associados
title: Descrição do tipo da cooperativa
codigoCategoriaCooperativa:
type: integer
format: int32
description: Código da classificação da cooperativa no tocante à sua exposição de risco e aos tipos de operações realizadas
title: Código da categoria da cooperativa
descricaoCategoriaCooperativa:
type: string
description: Descreve o categoria das cooperativas
title: Descrição da categoria da cooperativa
description: Cooperativa
RespostaCooperativa:
properties:
value:
type: array
items:
$ref: ‘#/definitions/Cooperativa’
’@odata.context’:
type: string
EntidadeSupervisionada:
properties:
codigoEntidadeInteresse:
type: string
description: Identificador da entidade na base de dados mestres do Banco Central
title: Código da entidade no BCBase
codigoIdentificadorBacen:
type: string
description: Identificador da pessoa fisica ou juridica no cadastro unico do banco central. Gerado automaticamente pelo sistema
title: Código da entidade no cadastro do Banco Central
siglaISO3digitos:
type: string
description: Código ISO do pais sede na base de dados de geografia
title: Código do País Sede da Instituição
nomeDoPais:
type: string
description: Nome do país sede na base de dados de geografia
title: Nome do país sede da instituição
nomeDaUnidadeFederativa:
type: string
description: Nome da unidade federativa da sede da instituição
title: Nome da unidade federativa da sede da instituição
codigoDoMunicipioNoIBGE:
type: string
description: Código IBGE do município sede da instituição na base de dados de geografia
title: Código do município sede da instituição
nomeDoMunicipio:
type: string
description: Nome IBGE do município sede da instituição na base de dados de geografia
title: Nome do município sede da instituição
nomeEntidadeInteresse:
type: string
description: Denominação da pessoa jurídica
title: Nome da entidade
nomeEntidadeInteresseNaoFormatado:
type: string
description: Denominação da pessoa jurídica sem caracteres especiais e acentuação
title: Nome da entidade não formatado
codigoCNPJ14:
type: string
description: Numero de identificação da pessoa jurídica no Cadastro Nacional de Pessoa Juridica - CNPJ
title: CNPJ da entidade com 14 dígitos
codigoCNPJ8:
type: string
description: Descreve a raiz do número de identificação da pessoa jurídica no CNPJ
title: CNPJ da entidade com 8 dígitos
codigoTipoSituacaoPessoaJuridica:
type: string
description: Código da situação em que se encontra a ES no tocante ao seu funcionamento
title: Código da situação da entidade junto ao Banco Central
descricaoTipoSituacaoPessoaJuridica:
type: string
description: Descrição da situação em que se encontra a ES no tocante ao seu funcionamento
title: Descrição da situação da entidade junto ao Banco Central
codigoTipoEntidadeSupervisionada:
type: string
description: Denominação equivalente ao segmento no cadastro único do Banco Central (Unicad) porém com foco específico aos segmentos que o Banco Central autoriza o funcionamento
title: Código do tipo de entidade (segmento)
descricaoTipoEntidadeSupervisionada:
type: string
description: Descreve o tipo de entidade supervisionada
title: Nome do tipo da entidade supervisionada
codigoNaturezaJuridica:
type: string
description: Código do tipo de natureza juridica compativel com o instituto brasileiro de geografia e estatistica (IBGE) e a receita federal
title: Código da natureza jurídica da entidade
descricaoNaturezaJuridica:
type: string
description: Descrição do tipo de natureza juridica compativel com o instituto brasileiro de geografia e estatistica (IBGE) e a receita federal
title: Descrição da natureza jurídica da entidade
codigoEsferaPublica:
type: string
description: 'Código da categoria de esfera pública da pessoa jurídica, aplicável para instituições públicas. Valores: 01 Federal, 02 Estadual e 03 Municipal’
title: Código de esfera pública da entidade
nomeReduzido:
type: string
description: 'Nome da instituição com abreviações, definido conforme critérios padronizados e na autorização para funcionamento da entidade’
title: Nome reduzido da entidade
siglaDaPessoaJuridica:
type: string
description: Informação opcional e apresentada pela instituição quando da autorização para funcionamento
title: Sigla da entidade
nomeFantasia:
type: string
description: Informação opcional e apresentada pela instituição quando da autorização para funcionamento
title: Nome fantasia da entidade
indicadorEsferaPublica:
type: string
description: ‘Indica se a entidade é uma empresa publica ou não. Valores: 1 (Sim) e 2 (Não)‘
title: Indicador do tipo de controle da entidade
description: Entidade supervisionada
RespostaEntidadeSupervisionada:
properties:
value:
type: array
items:
$ref: ‘#/definitions/EntidadeSupervisionada’
’@odata.context’:
type: string
tags:
- name: Todos
description: "Métodos da API"
securityDefinitions:
GatewayAPIKey:
type: apiKey
in: header
name: X-Api-Key
description: "API Key utilizada no Gateway Gr1d"
security:
- GatewayAPIKey: []