business_identification.csv

Xpath;Nome;Definição;Tipo de dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo Dado Json
GET /business/identifications;;Método para obter os registros de identificação da pessoa jurídica mantidos na instituição transmissora;;;;;;;;;;
data/;;Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa jurídica através de seus dados cadastrais;Lista;;Obrigatório;;;1;1;Não há restrição;;Lista
data/updateDateTime;updateDateTime;"Data e hora da atualização do bloco de Identificação, conforme especificação RFC-3339, formato UTC. p.ex. ""2020-07-21T08:30:00Z""";Data Hora;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;Não há restrição;;String
data/businessId;businessId;Um identificador único e imutável usado para identificar o recurso cliente pessoa jurídica. Este identificador não tem significado para o cliente que deu o consentimento;Texto;100;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/brandName;brandName;Nome da Marca reportada pelo participante do Open Banking. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes;Texto;80;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/companyCnpjNumber;companyCnpjNumber;"Lista com número completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. 
Deve-se ter apenas os números do CNPJ, sem máscara.";Lista;;Obrigatório;\d{14}|^NA$;;1;1;Não há restrição;;Lista
data/cnpjNumber;cnpjNumber;"Número completo do CNPJ da Empresa consultada - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. 
Deve-se ter apenas os números do CNPJ, sem máscara";Texto;14;Obrigatório;\d{14}|^NA$;;1;1;Não há restrição;;String
data/otherDocuments/;;Relação dos demais documentos;Lista;;Condicional;;;0;N;"Aplicável somente
as Pessoas Jurídicas residentes no exterior desobrigadas de inscrição no CNPJ";;Lista
data/otherDocuments/type;type;Número do Tipo de documento informado. De preenchimento obrigatório, para a Pessoa jurídica com domicílio ou sede no exterior, desobrigada de inscrição no CNPJ;Texto;20;Condicional;\w*\W*;;0;1;"Aplicável somente
as Pessoas Jurídicas residentes no exterior desobrigadas de inscrição no CNPJ";;String
data/otherDocuments/number;number;Número do outro documento. De preenchimento obrigatório, para a Pessoa jurídica com domicílio ou sede no exterior, desobrigada de inscrição no CNPJ;Texto;20;Obrigatório;\w*\W*;;0;1;"Aplicável somente
as Pessoas Jurídicas residentes no exterior desobrigadas de inscrição no CNPJ";;String
data/otherDocuments/country;country;Pais de emissão do tipo de documento informado. Código do pais de acordo com o código alpha3 do ISO-3166.p.ex.'CAN';Texto;3;Obrigatório;;;0;1;"Preencher com o código “alpha3” do ISO-3166
Aplicável somente
as Pessoas Jurídicas residentes no exterior desobrigadas de inscrição no CNPJ";;String
data/otherDocuments/expirationDate;expirationDate;"Data vigência do tipo de documento informado, conforme especificação RFC-3339. p.ex. ""2014-03-19""";Data;10;Condicional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$|^NA$;;0;1;"De preenchimento
obrigatório se o documento informado tiver data de vigência";;String
data/companyName;companyName;Razão social da empresa consultada é o termo registrado sob o qual uma pessoa jurídica (PJ) se individualiza e exerce suas atividades. Também pode ser chamada por denominação social ou firma empresarial;Texto;70;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/tradeName;tradeName;Nome fantasia da pessoa jurídica, se houver. (é o nome popular da empresa, utilizado para divulgação da empresa e melhor fixação com o público). De preenchimento obrigatório se houver;Texto;70;Obrigatório;\w*\W*;;0;1;"De preenchimento 
obrigatório, se houver";;String
data/incorporationDate;incorporationDate;Data de constituição da empresa, conforme especificação RFC-3339. p.ex. 2014-03-19;Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;Não há restrição;;String
data/parties/;;Lista relativa às informações das partes envolvidas, como: sócio e /ou administrador;Lista;;Obrigatório;;;1;N;Não há restrição;;Lista
data/parties/personType;personType;Indica se a pessoa da parte envolvida é uma pessoa natural ou juridica;Texto;;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA";1;1;Não há restrição;;Enum
data/parties/type;type;"Indica o perfil de atuação na empresa. Vide Enum
O administrador é o responsável por desempenhar todas as funções administrativas da empresa. é ele quem conduz o dia a dia do negócio, assinando documentos, respondendo legalmente pela sociedade, realizando empréstimos e outras ações gerenciais. Apesar de estar na linha de frente da empresa, ele é denominado sócio por também possuir sua parcela de participação no Capital Social.
Sócio não tem qualquer envolvimento nas atividades administrativas da sociedade.";Texto;13;Obrigatório;;"SOCIO
ADMINISTRADOR";1;1;Não há restrição;;Enum
data/parties/civilName;civilName;Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte);Texto;70;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/parties/socialName;socialName;Nome social da pessoa natural, se houver. (aquele pelo qual travestis e transexuais se reconhecem, bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local);Texto;70;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/parties/companyName;companyName;Razão social da empresa consultada é o termo registrado sob o qual uma pessoa jurídica (PJ) se individualiza e exerce suas atividades. Também pode ser chamada por denominação social ou firma empresarial;Texto;70;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/parties/tradeName;tradeName;Nome fantasia da pessoa jurídica, se houver. (é o nome popular da empresa, utilizado para divulgação da empresa e melhor fixação com o público). De preenchimento obrigatório se houver;Texto;70;Condicional;\w*\W*;;0;1;De preenchimento obrigatório, se houver;;String
data/parties/startDate;startDate;Data de início da participação, conforme especificação RFC-3339. p.ex. 2014-03-19;Texto;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;Não há restrição;;String
data/parties/shareholding;shareholding;Percentual de participação societária (informar com 2 casas decimais). Sócio só deve ser informado se sua participação societária for igual ou superior a 25%. p.ex: 0.25 (Este valor representa 25%. O valor '1 'representa 100%);Texto;4;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;Informar a Participação societária do sócio se igual ou superior a 25%. Informar com 2 casas decimais ;;String
data/parties/documentType;documentType;Tipo do documento informado. Vide Enum;Texto;22;Obrigatório;;"CPF
PASSAPORTE
OUTRO_DOCUMENTO_VIAGEM
CNPJ";1;1;Não há restrição;;Enum
data/parties/documentNumber;documentNumber;"Número do documento informado. Campo Texto Livre para preencher número 
e dígito do documento se houver";Texto;20;Obrigatório;\w*\W*;;1;1;Não há restrição;;String
data/parties/documentAdditionalInfo;documentAdditionalInfo;Campo livre, de preenchimento obrigatório quando o documento informado tiver informações complementares relevantes para a sua identificação.p.ex. órgão emissor;Texto;100;Condicional;\w*\W*;;0;1;Preenchimento obrigatório quando houver informações complementares para documento informado;;String
data/parties/documentCountry;documentCountry;Pais de emissão do documento. Código do pais de acordo com o código alpha3 do ISO-3166.p.ex.'CAN';Texto;3;Obrigatório;\w*\W*|^NA$;;0;1;Peenchimento obrigatório quando houver documento informado. Preencher com o código “alpha3” do ISO-3166;;String
data/parties/documentExpirationDate;documentExpirationDate;Data de validade do documento informado, conforme especificação RFC-3339. p.ex. 2014-03-19;Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])|^NA$;;0;1;Peenchimento obrigatório quando o documento informado tiver data de validade;;String
data/parties/documentIssueDate;documentIssueDate;Data de emissão do documento;Texto;10;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])|^NA$;;1;1;Não há restrição;;String
data/contacts/;;Conjunto de informações relativas às formas de contatar o cliente;Objeto;;Obrigatório;;;1;1;Não há restrição;;Objeto
data/contacts/postalAddresses/;;Lista de endereços da pessoa jurídica ;Lista;;Obrigatório;;;1;N;Não há restrição;;Lista
data/contacts/postalAddresses/isMain;isMain;Indica se o endereço informado é o principal;Booleano;;Obrigatório;;;1;1;Só deve ser preenchido true para uma ocorrência de Principal;;Booleano
data/contacts/postalAddresses/address;address;Corresponde ao endereço comercial do cliente.;Texto;150;Obrigatório;\w*\W*|^NA$;;1;1;Não há restrição;;String
data/contacts/postalAddresses/additionalInfo;additionalInfo;Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir: 'Loja B', 'Fundos', 'Casa 2', 'Lote C';Texto;30;Opcional;\w*\W*;;0;1;Não há restrição;;String
data/contacts/postalAddresses/districtName;districtName;Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas. p.ex: 'Paraíso';Texto;50;Obrigatório;\w*\W*|^NA$;;0;1;Não há restrição;;String
data/contacts/postalAddresses/townName;townName;Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado. p.ex. 'São Paulo';Texto;50;Obrigatório;\w*\W*|^NA$;;1;1;Não há restrição;;String
data/contacts/postalAddresses/ibgeTownCode;ibgeTownCode;Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação. p.ex.'3550308';Texto;7;Opcional;\d{7}$;;0;1;Não há restrição;;String
data/contacts/postalAddresses/countrySubDivision;countrySubDivision;Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros;Texto;2;Obrigatório;;"AC; AL; AM; AP; BA; CE; DF; ES; GO; MA; MG; MS; MT; PA; PB; PE; PI; PR; RJ; RN; RO; RR; RS; SC; SE; SP; TO, NA";1;1;Não há restrição;;Enum
data/contacts/postalAddresses/postCode;postCode;Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000';Texto;8;Obrigatório;\d{8}|^NA$;;1;1;Não há restrição;;String
data/contacts/postalAddresses/country;country;Nome do país. p.ex. Brasil;Texto;80;Obrigatório;\w*\W*|^NA$;;1;1;Não há restrição;;String
data/contacts/postalAddresses/countryCode;countryCode;Código do pais de acordo com o código alpha3 do ISO-3166.p.ex.'BRA';Texto;3;Opcional;;BRA;1;1;Preencher com o código “alpha3” do ISO-3166;;String
data/contacts/postalAddresses/geographicCoordinates/;;Conjunto de informações, que correspondem aos valores das coordenadas geográficas em graus decimais, no Sistema de referência WGS84;Objeto;;Opcional;;;0;1;Não há restrição;;Objeto
data/contacts/postalAddresses/geographicCoordinates/latitude;latitude;Informação da Latitude referente a geolocalização informada. Entre -90 e 90.p.ex. '-90.8365180'. (2 casas antes da vírgula, 11 posições) ;Texto;13;Opcional;^-?\d{1,2}\.\d{1,9}$;;0;1;Entre -90 e 90.p.ex. '-90.8365180'. (2 casas antes da vírgula, 11 posições) ;;String
data/contacts/postalAddresses/geographicCoordinates/longitude;longitude;Informação da Longitude referente a geolocalização informada. Entre -180 e 180. p.ex '-180.836519.' (3 casas antes da vírgula, 11 posições) ;Texto;13;Opcional;^-?\d{1,3}\.\d{1,8}$;;0;1;Entre -180 e 180. p.ex '-180.836519.' (3 casas antes da vírgula, 11 posições) ;;String
data/contacts/phones/;;Lista com telefones de contato da pessoa jurídica;Lista;;Obrigatório;;;1;N;Não há restrição;;Lista
data/contacts/phones/isMain;isMain;Indica se o telefone informado é o principal;Booleano;;Obrigatório;;;1;1;Só deve ser preenchido true para uma ocorrência de Principal;;Booleano
data/contacts/phones/type;type;Identificação do Tipo de telefone do cliente. (Vide Enum);Texto;5;Obrigatório;;"FIXO
MOVEL
OUTRO";1;1;Não há restrição;;Enum
data/contacts/phones/additionalInfo;additionalInfo;Informação complementar relativa ao tipo de telefone selecionado. De preenchimento obrigatório quando selecionado o tipo 'OUTRO';Texto;70;Opcional;\w*\W*;;0;1;De preenchimento obrigatório quando selecionado o tipo 'OUTRO';;String
data/contacts/phones/countryCallingCode;countryCallingCode;Número de ddi (Discagem Direta Internacional) para telefone de acesso ao Cliente- se houver. p.ex. '55';Texto;4;Opcional;^\d{2,4}$;;0;1;Não há restrição;;String
data/contacts/phones/areaCode;areaCode;Número de ddd (Discagem Direta à Distância) do telefone do cliente - se houver. p.ex. '19';Texto;2;Obrigatório;;11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 73, 74, 75, 77, 79, 81, 82, 83, 84, 85, 86, 87, 88, 89, 91, 92, 93, 94, 95, 96, 97, 98, 99, NA;1;1;Não há restrição;;Enum
data/contacts/phones/number;number;Número de telefone do cliente ;Texto;11;Obrigatório;^([0-9]{8,11});;1;1;Não há restrição;;String
data/contacts/phones/phoneExtension;phoneExtension;Número do ramal. De preenchimento obrigatório se fizer parte da identificação do número do telefone informado;Texto;5;Opcional;^\d{1,5}$|^NA$;;0;1;De preenchimento obrigatório se fizer parte da identificação do número do telefone informado;;String
data/contacts/emails/;;Lista emails de contato;Lista;;Obrigatório;;;1;N;Não há restrição;;Lista
data/contacts/emails/isMain;isMain;Indica se o email informado é o principal;Booleano;;Obrigatório;;;1;1;Só deve ser preenchido true para uma ocorrência de Principal;;Booleano
data/contacts/emails/email;email;Endereço de email;Texto;320;Obrigatório;\w*\W*;;1;1;Não há restrição;;String