API de Dados Cadastrais

Comportamento da API de Dados Cadastrais com relação a Recursos

GET /baas/v1/open/dat/customers/personal/identifications

Obtém os registros de identificação da pessoa natural mantidos na instituição transmissora.

Permission necessária: CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "updateDateTime": "2021-05-21T08:30:00Z",
      "personalId": "578-psd-71md6971kjh-2d414",
      "brandName": "Organização A",
      "civilName": "Juan Kaique Cláudio Fernandes",
      "socialName": "Jaqueline de Freitas",
      "birthDate": "1989-03-23",
      "maritalStatusCode": "OUTRO",
      "maritalStatusAdditionalInfo": "Amasiado",
      "sex": "FEMININO",
      "companiesCnpj": [
        "01773247000103",
        "01773247000563"
      ],
      "documents": {
        "cpfNumber": "25872252137",
        "passport": {
          "number": "75253468744594820620",
          "country": "CAN",
          "expirationDate": "2021-05-21",
          "issueDate": "2021-05-21"
        }
      },
      "otherDocuments": [
        {
          "type": "CNH",
          "typeAdditionalInfo": "CREA-RJ",
          "number": "15291908",
          "checkDigit": "P",
          "additionalInfo": "SSP/SP",
          "expirationDate": "2021-05-21"
        }
      ],
      "hasBrazilianNationality": false,
      "nationality": [
        {
          "otherNationalitiesInfo": "CAN",
          "documents": [
            {
              "type": "SOCIAL SEC",
              "number": "423929299",
              "expirationDate": "2021-05-21",
              "issueDate": "2021-05-21",
              "country": "Brasil",
              "additionalInfo": "Informações adicionais."
            }
          ]
        }
      ],
      "filiation": [
        {
          "type": "PAI",
          "civilName": "Marcelo Cláudio Fernandes",
          "socialName": "string"
        }
      ],
      "contacts": {
        "postalAddresses": [
          {
            "isMain": true,
            "address": "Av Naburo Ykesaki, 1270",
            "additionalInfo": "Fundos",
            "districtName": "Centro",
            "townName": "Marília",
            "ibgeTownCode": "3550308",
            "countrySubDivision": "SP",
            "postCode": "17500001",
            "country": "Brasil",
            "countryCode": "BRA",
            "geographicCoordinates": {
              "latitude": "-23.5475000",
              "longitude": "-46.6361100"
            }
          }
        ],
        "phones": [
          {
            "isMain": true,
            "type": "FIXO",
            "additionalInfo": "Informações adicionais.",
            "countryCallingCode": "55",
            "areaCode": "19",
            "number": "29875132",
            "phoneExtension": "932"
          }
        ],
        "emails": [
          {
            "isMain": true,
            "email": "[email protected]"
          }
        ]
      }
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].updateDateTime: Data e hora da última atualização do registro, no formato RFC-3339 UTC.
data[].personalId: Identificador único e imutável do recurso cliente pessoa natural. Sem significado para o cliente que concedeu o consentimento.
data[].brandName: Nome da marca reportada pelo participante no Open Finance. Preferencialmente o mesmo nome atribuído no diretório Customer Friendly Server Name.
data[].civilName: Nome civil completo da pessoa natural.
data[].socialName: Nome social da pessoa natural, se houver. Aquele pelo qual travestis e transexuais se reconhecem perante sua comunidade.
data[].birthDate: Data de nascimento no formato YYYY-MM-DD, conforme RFC-3339.
data[].maritalStatusCode: Código do estado civil. Enum: SOLTEIRO, CASADO, VIUVO, SEPARADO_JUDICIALMENTE, DIVORCIADO, UNIAO_ESTAVEL, OUTRO.
data[].maritalStatusAdditionalInfo: Campo livre para complementar o estado civil quando maritalStatusCode for OUTRO.
data[].sex: Sexo da pessoa natural. Enum: FEMININO, MASCULINO, OUTRO.
data[].companiesCnpj: Lista de CNPJs (sem máscara) das instituições responsáveis pelo cadastro.
data[].documents.cpfNumber: Número completo do CPF (11 dígitos, sem máscara). Obrigatório quando não informado o passaporte.
data[].documents.passport.number: Número do passaporte. Aplicável somente à pessoa natural residente no exterior desobrigada de inscrição no CPF.
data[].documents.passport.country: País de emissão do passaporte, código alpha3 ISO-3166.
data[].documents.passport.expirationDate: Data de validade do passaporte.
data[].documents.passport.issueDate: Data de emissão do passaporte.
data[].otherDocuments[].type: Tipo do documento adicional. Enum: CNH, RG, NIF, RNE, OUTROS.
data[].otherDocuments[].typeAdditionalInfo: Complemento do tipo quando selecionado OUTROS.
data[].otherDocuments[].number: Número/identificação do documento adicional.
data[].otherDocuments[].checkDigit: Dígito verificador do documento, se houver.
data[].otherDocuments[].additionalInfo: Órgão e UF de emissão (ex: SSP/SP), obrigatório quando o local de emissão for relevante.
data[].otherDocuments[].expirationDate: Data de validade do documento adicional.
data[].hasBrazilianNationality: Indica se a pessoa possui nacionalidade brasileira (true/false).
data[].nationality[].otherNationalitiesInfo: Código alpha3 ISO-3166 de outras nacionalidades. Obrigatório quando não possui nacionalidade brasileira.
data[].nationality[].documents[].type: Tipo do documento de nacionalidade estrangeira (campo livre).
data[].nationality[].documents[].number: Número do documento de nacionalidade estrangeira.
data[].nationality[].documents[].expirationDate: Data de validade do documento estrangeiro.
data[].nationality[].documents[].issueDate: Data de emissão do documento estrangeiro.
data[].nationality[].documents[].country: Nome do país emissor do documento estrangeiro.
data[].nationality[].documents[].additionalInfo: Campo livre para informações complementares do documento estrangeiro.
data[].filiation[].type: Tipo de filiação. Enum: PAI, MAE.
data[].filiation[].civilName: Nome civil completo do pai ou mãe.
data[].filiation[].socialName: Nome social do pai ou mãe, se houver.
data[].contacts.postalAddresses[].isMain: Indica se é o endereço principal.
data[].contacts.postalAddresses[].address: Logradouro completo.
data[].contacts.postalAddresses[].additionalInfo: Complemento do endereço.
data[].contacts.postalAddresses[].districtName: Bairro.
data[].contacts.postalAddresses[].townName: Cidade/município.
data[].contacts.postalAddresses[].ibgeTownCode: Código IBGE do município (7 dígitos).
data[].contacts.postalAddresses[].countrySubDivision: Sigla da UF (ex: SP).
data[].contacts.postalAddresses[].postCode: CEP (8 dígitos, sem máscara).
data[].contacts.postalAddresses[].country: Nome do país.
data[].contacts.postalAddresses[].countryCode: Código alpha3 ISO-3166 do país.
data[].contacts.postalAddresses[].geographicCoordinates.latitude: Latitude em graus decimais (WGS84).
data[].contacts.postalAddresses[].geographicCoordinates.longitude: Longitude em graus decimais (WGS84).
data[].contacts.phones[].isMain: Indica se é o telefone principal.
data[].contacts.phones[].type: Tipo de telefone. Enum: FIXO, MOVEL, OUTRO.
data[].contacts.phones[].additionalInfo: Complemento do tipo quando OUTRO.
data[].contacts.phones[].countryCallingCode: Código DDI. Obrigatório quando diferente de 55.
data[].contacts.phones[].areaCode: Código DDD (2–3 dígitos).
data[].contacts.phones[].number: Número do telefone.
data[].contacts.phones[].phoneExtension: Ramal, se houver.
data[].contacts.emails[].isMain: Indica se é o e-mail principal.
data[].contacts.emails[].email: Endereço de e-mail.
links.self: URI completa que gerou a resposta atual.
links.first: URI da primeira página. Obrigatório quando não for a primeira página.
links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
links.next: URI da próxima página. Obrigatório quando não for a última página.
links.last: URI da última página. Obrigatório quando não for a última página.
meta.requestDateTime: Data e hora da consulta, no formato RFC-3339 UTC.

GET /baas/v1/open/dat/customers/personal/qualifications

Obtém os registros de qualificação da pessoa natural mantidos na instituição transmissora.

Permission necessária: CUSTOMERS_PERSONAL_ADITTIONALINFO_READ

Exemplo de resposta (200 OK)

{
  "data": {
    "updateDateTime": "2021-05-21T08:30:00Z",
    "companyCnpj": "50685362000135",
    "occupationCode": "RECEITA_FEDERAL",
    "occupationDescription": "01",
    "informedIncome": {
      "frequency": "MENSAL",
      "amount": {
        "amount": "100000.0400",
        "currency": "BRL"
      },
      "date": "2021-05-21"
    },
    "informedPatrimony": {
      "amount": {
        "amount": "100000.0400",
        "currency": "BRL"
      },
      "year": 2010
    },
    "employers": [
      {
        "cnpjCpf": "30386566000164",
        "name": "Organização A"
      }
    ]
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.updateDateTime: Data e hora da última atualização dos dados de qualificação, no formato RFC-3339 UTC.
data.companyCnpj: CNPJ da instituição responsável pelo cadastro (sem máscara).
data.occupationCode: Código da ocupação principal. Enum: RECEITA_FEDERAL, CBO, OUTRO.
data.occupationDescription: Código ou descrição da ocupação conforme o occupationCode selecionado. Obrigatório quando occupationCode for informado.
data.informedIncome.frequency: Frequência da renda informada. Enum: DIARIA, SEMANAL, QUINZENAL, MENSAL, BIMESTRAL, TRIMESTRAL, SEMESTRAL, ANUAL, OUTROS.
data.informedIncome.amount.amount: Valor total da renda informada, com 2 a 4 casas decimais.
data.informedIncome.amount.currency: Moeda da renda no padrão ISO-4217 (ex: BRL).
data.informedIncome.date: Data de referência da renda no formato YYYY-MM-DD.
data.informedPatrimony.amount.amount: Valor do patrimônio informado, com 2 a 4 casas decimais.
data.informedPatrimony.amount.currency: Moeda do patrimônio no padrão ISO-4217 (ex: BRL).
data.informedPatrimony.year: Ano de referência do patrimônio.
data.employers[].cnpjCpf: CPF ou CNPJ do empregador (sem máscara).
data.employers[].name: Nome ou razão social do empregador.
links: Links de navegação entre páginas (ver descrição em /personal/identifications).
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/customers/personal/financial-relations

Obtém os registros de relacionamentos com a instituição financeira e de representantes da pessoa natural.

Permission necessária: CUSTOMERS_PERSONAL_ADITTIONALINFO_READ

Exemplo de resposta (200 OK)

{
  "data": {
    "updateDateTime": "2021-05-21T08:30:00Z",
    "startDate": "2021-05-21T08:30:00Z",
    "productsServicesType": [
      "CONTA_DEPOSITO_A_VISTA",
      "SEGURO"
    ],
    "productsServicesTypeAdditionalInfo": "Informações adicionais do tipo de serviço.",
    "procurators": [
      {
        "type": "PROCURADOR",
        "cpfNumber": "73677831148",
        "civilName": "Elza Milena Stefany Teixeira",
        "socialName": "Carlos"
      }
    ],
    "accounts": [
      {
        "compeCode": "001",
        "branchCode": "6272",
        "number": "24550245",
        "checkDigit": "4",
        "type": "CONTA_DEPOSITO_A_VISTA",
        "subtype": "INDIVIDUAL"
      }
    ],
    "portabilitiesReceived": [
      {
        "employerName": "Empresa Exemplo S.A.",
        "employerCnpjCpf": "30386566000164",
        "paycheckBankDetainerCnpj": "60746948000112",
        "paycheckBankDetainerIspb": "60746948",
        "portabilityApprovalDate": "2021-05-21"
      }
    ],
    "paychecksBankLink": [
      {
        "employerName": "Empresa Exemplo S.A.",
        "employerCnpjCpf": "30386566000164",
        "paycheckBankCnpj": "60746948000112",
        "paycheckBankIspb": "60746948",
        "accountOpeningDate": "2021-05-21"
      }
    ]
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.updateDateTime: Data e hora da última atualização dos dados de relacionamento, no formato RFC-3339 UTC.
data.startDate: Data de início do relacionamento com a instituição financeira. Menor valor entre o reportado ao BACEN pelo DOC 3040 e CCS.
data.productsServicesType: Lista de produtos e serviços com contrato vigente. Enum possíveis: CONTA_DEPOSITO_A_VISTA, CONTA_POUPANCA, CONTA_PAGAMENTO_PRE_PAGA, CARTAO_CREDITO, OPERACAO_CREDITO, SEGURO, PREVIDENCIA, INVESTIMENTO, OPERACOES_CAMBIO, CONTA_SALARIO, CREDENCIAMENTO, OUTROS.
data.productsServicesTypeAdditionalInfo: Informações adicionais sobre os produtos/serviços. Obrigatório quando productsServicesType contiver OUTROS.
data.procurators[].type: Tipo do representante. Enum: REPRESENTANTE_LEGAL, PROCURADOR.
data.procurators[].cpfNumber: CPF do representante (11 dígitos, sem máscara).
data.procurators[].civilName: Nome civil completo do representante.
data.procurators[].socialName: Nome social do representante, se houver.
data.accounts[].compeCode: Código COMPE da instituição (3 dígitos).
data.accounts[].branchCode: Código da agência (4 dígitos). Obrigatório quando o tipo for diferente de conta pré-paga.
data.accounts[].number: Número da conta (8 a 20 dígitos).
data.accounts[].checkDigit: Dígito verificador da conta.
data.accounts[].type: Tipo de conta. Enum: CONTA_DEPOSITO_A_VISTA, CONTA_POUPANCA, CONTA_PAGAMENTO_PRE_PAGA.
data.accounts[].subtype: Subtipo da conta. Enum: INDIVIDUAL, CONJUNTA_SIMPLES, CONJUNTA_SOLIDARIA.
data.portabilitiesReceived[].employerName: Nome ou razão social do empregador conforme recebido pela comunicação de portabilidade.
data.portabilitiesReceived[].employerCnpjCpf: CPF ou CNPJ do empregador conforme recebido pela portabilidade.
data.portabilitiesReceived[].paycheckBankDetainerCnpj: CNPJ do banco folha (instituição detentora da conta salário) recebido na portabilidade.
data.portabilitiesReceived[].paycheckBankDetainerIspb: ISPB do banco folha recebido na portabilidade.
data.portabilitiesReceived[].portabilityApprovalDate: Data de aprovação da portabilidade. Somente portabilidades aprovadas são compartilhadas.
data.paychecksBankLink[].employerName: Nome ou razão social do empregador conforme registrado na abertura da conta salário.
data.paychecksBankLink[].employerCnpjCpf: CPF ou CNPJ do empregador conforme registrado na conta salário.
data.paychecksBankLink[].paycheckBankCnpj: CNPJ da instituição financeira prestadora do serviço de pagamento de salário (banco-folha).
data.paychecksBankLink[].paycheckBankIspb: ISPB da instituição prestadora do serviço de pagamento de salário.
data.paychecksBankLink[].accountOpeningDate: Data de abertura da conta salário.
links: Links de navegação entre páginas (ver descrição em /personal/identifications).
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/customers/business/identifications

Obtém os registros de identificação da pessoa jurídica mantidos na instituição transmissora.

Permission necessária: CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "updateDateTime": "2021-05-21T08:30:00Z",
      "businessId": "578-psd-71md6971kjh-2d414",
      "brandName": "Organização A",
      "companyName": "Luiza e Benjamin Assessoria Jurídica Ltda",
      "tradeName": "Mundo da Eletronica",
      "incorporationDate": "2021-05-21T08:30:00Z",
      "cnpjNumber": "50685362006773",
      "companiesCnpj": [
        "50685362000135",
        "50685362006555"
      ],
      "otherDocuments": [
        {
          "type": "EIN",
          "number": "128328453",
          "country": "CAN",
          "expirationDate": "2021-05-21"
        }
      ],
      "parties": [
        {
          "personType": "PESSOA_NATURAL",
          "type": "SOCIO",
          "civilName": "Juan Kaique Cláudio Fernandes",
          "socialName": "Karina",
          "startDate": "2021-05-21T08:30:00Z",
          "shareholding": "0.510000",
          "documentType": "CPF",
          "documentNumber": "73677831148",
          "documentAdditionalInfo": "CNH",
          "documentCountry": "CAN",
          "documentExpirationDate": "2021-05-21",
          "documentIssueDate": "2021-05-21"
        }
      ],
      "contacts": {
        "postalAddresses": [
          {
            "isMain": true,
            "address": "Av Naburo Ykesaki, 1270",
            "additionalInfo": "Fundos",
            "districtName": "Centro",
            "townName": "Marília",
            "ibgeTownCode": "3550308",
            "countrySubDivision": "SP",
            "postCode": "17500001",
            "country": "Brasil",
            "countryCode": "BRA",
            "geographicCoordinates": {
              "latitude": "-23.5475000",
              "longitude": "-46.6361100"
            }
          }
        ],
        "phones": [
          {
            "isMain": true,
            "type": "FIXO",
            "additionalInfo": "Informações adicionais.",
            "countryCallingCode": "55",
            "areaCode": "19",
            "number": "29875132",
            "phoneExtension": "932"
          }
        ],
        "emails": [
          {
            "isMain": true,
            "email": "[email protected]"
          }
        ]
      }
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].updateDateTime: Data e hora da última atualização do registro, no formato RFC-3339 UTC.
data[].businessId: Identificador único e imutável do recurso cliente pessoa jurídica. Sem significado para o cliente que concedeu o consentimento.
data[].brandName: Nome da marca reportada pelo participante no Open Finance. Preferencialmente o mesmo nome atribuído no diretório Customer Friendly Server Name.
data[].companyName: Razão social da empresa (denominação social ou firma empresarial).
data[].tradeName: Nome fantasia da pessoa jurídica, se houver.
data[].incorporationDate: Data de constituição da empresa no formato RFC-3339.
data[].cnpjNumber: CNPJ completo da empresa consultada (sem máscara).
data[].companiesCnpj: Lista de CNPJs (sem máscara) das instituições responsáveis pelo cadastro.
data[].otherDocuments[].type: Tipo do documento adicional (campo livre). Obrigatório para PJ com domicílio no exterior desobrigada de inscrição no CNPJ.
data[].otherDocuments[].number: Número do documento adicional.
data[].otherDocuments[].country: País de emissão do documento, código alpha3 ISO-3166.
data[].otherDocuments[].expirationDate: Data de validade do documento adicional.
data[].parties[].personType: Tipo da pessoa da parte envolvida. Enum: PESSOA_NATURAL, PESSOA_JURIDICA.
data[].parties[].type: Perfil de atuação na empresa. Enum: SOCIO, ADMINISTRADOR.
data[].parties[].civilName: Nome civil do sócio/administrador pessoa natural.
data[].parties[].socialName: Nome social do sócio/administrador, se houver.
data[].parties[].companyName: Razão social do sócio/administrador pessoa jurídica.
data[].parties[].tradeName: Nome fantasia do sócio/administrador pessoa jurídica.
data[].parties[].startDate: Data de início da participação no formato RFC-3339.
data[].parties[].shareholding: Percentual de participação societária com 6 casas decimais (ex: 0.510000 = 51%). Obrigatório quando type for SOCIO com participação igual ou superior a 25%.
data[].parties[].documentType: Tipo do documento da parte. Enum: CPF, PASSAPORTE, OUTRO_DOCUMENTO_VIAGEM, CNPJ.
data[].parties[].documentNumber: Número do documento.
data[].parties[].documentAdditionalInfo: Informações complementares do documento, quando necessário.
data[].parties[].documentCountry: País de emissão do documento, código alpha3 ISO-3166.
data[].parties[].documentExpirationDate: Data de validade do documento.
data[].parties[].documentIssueDate: Data de emissão do documento.
data[].contacts.postalAddresses: Lista de endereços postais da empresa (ver descrição dos campos em /personal/identifications).
data[].contacts.phones: Lista de telefones de contato (ver descrição dos campos em /personal/identifications).
data[].contacts.emails: Lista de e-mails de contato (ver descrição dos campos em /personal/identifications).
links: Links de navegação entre páginas (ver descrição em /personal/identifications).
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/customers/business/qualifications

Obtém os registros de qualificação da pessoa jurídica mantidos na instituição transmissora.

Permission necessária: CUSTOMERS_BUSINESS_ADITTIONALINFO_READ

Exemplo de resposta (200 OK)

{
  "data": {
    "updateDateTime": "2021-05-21T08:30:00Z",
    "economicActivities": [
      {
        "code": "0600001",
        "isMain": true
      }
    ],
    "informedRevenue": {
      "frequency": "MENSAL",
      "frequencyAdditionalInfo": "Informações adicionais",
      "amount": {
        "amount": "100000.0400",
        "currency": "BRL"
      },
      "year": 2010
    },
    "informedPatrimony": {
      "amount": {
        "amount": "100000.0400",
        "currency": "BRL"
      },
      "date": "2021-05-21"
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.updateDateTime: Data e hora da última atualização dos dados de qualificação, no formato RFC-3339 UTC.
data.economicActivities[].code: Código CNAE (Classificação Nacional de Atividades Econômicas) com 7 caracteres, incluindo zeros à esquerda quando necessário.
data.economicActivities[].isMain: Indica se é a atividade econômica principal (true) ou secundária (false). Somente uma ocorrência pode ter valor true.
data.informedRevenue.frequency: Frequência do faturamento informado. Enum: DIARIA, SEMANAL, QUINZENAL, MENSAL, BIMESTRAL, TRIMESTRAL, SEMESTRAL, ANUAL, OUTROS.
data.informedRevenue.frequencyAdditionalInfo: Texto livre para complementar a frequência. Obrigatório quando frequency for OUTROS.
data.informedRevenue.amount.amount: Valor do faturamento informado, com 2 a 4 casas decimais.
data.informedRevenue.amount.currency: Moeda no padrão ISO-4217 (ex: BRL).
data.informedRevenue.year: Ano de referência do faturamento.
data.informedPatrimony.amount.amount: Valor do patrimônio informado, com 2 a 4 casas decimais.
data.informedPatrimony.amount.currency: Moeda no padrão ISO-4217 (ex: BRL).
data.informedPatrimony.date: Data de referência do patrimônio no formato YYYY-MM-DD.
links: Links de navegação entre páginas (ver descrição em /personal/identifications).
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/customers/business/financial-relations

Obtém os registros de relacionamentos com a instituição financeira e de representantes da pessoa jurídica.

Permission necessária: CUSTOMERS_BUSINESS_ADITTIONALINFO_READ

Exemplo de resposta (200 OK)

{
  "data": {
    "updateDateTime": "2020-07-21T08:30:00Z",
    "startDate": "2020-07-21T08:30:00Z",
    "productsServicesType": [
      "CONTA_DEPOSITO_A_VISTA",
      "OPERACAO_CREDITO"
    ],
    "procurators": [
      {
        "type": "PROCURADOR",
        "cnpjCpfNumber": "73677831148",
        "civilName": "Elza Milena Stefany Teixeira",
        "socialName": "Stefany Teixeirass"
      }
    ],
    "accounts": [
      {
        "compeCode": "001",
        "branchCode": "6272",
        "number": "24550245",
        "checkDigit": "4",
        "type": "CONTA_DEPOSITO_A_VISTA",
        "subtype": "CONJUNTA_SOLIDARIA"
      }
    ]
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.updateDateTime: Data e hora da última atualização dos dados de relacionamento, no formato RFC-3339 UTC.
data.startDate: Data de início de relacionamento com a instituição financeira. Menor valor entre o reportado ao BACEN pelo DOC 3040 e CCS.
data.productsServicesType: Lista de produtos e serviços com contrato vigente. Enum possíveis: CONTA_DEPOSITO_A_VISTA, CONTA_POUPANCA, CONTA_PAGAMENTO_PRE_PAGA, CARTAO_CREDITO, OPERACAO_CREDITO, SEGURO, PREVIDENCIA, INVESTIMENTO, OPERACOES_CAMBIO, CONTA_SALARIO, CREDENCIAMENTO, OUTROS.
data.procurators[].type: Tipo do representante. Enum: REPRESENTANTE_LEGAL, PROCURADOR. Representante legal é nomeado no ato constitutivo da empresa; procurador representa a empresa mediante autorização escrita.
data.procurators[].cnpjCpfNumber: CPF ou CNPJ do representante (sem formatação).
data.procurators[].civilName: Nome civil completo do representante.
data.procurators[].socialName: Nome social do representante, se houver.
data.accounts[].compeCode: Código COMPE da instituição (3 dígitos).
data.accounts[].branchCode: Código da agência (4 dígitos). Obrigatório quando o tipo for diferente de conta pré-paga.
data.accounts[].number: Número da conta (8 a 20 dígitos).
data.accounts[].checkDigit: Dígito verificador da conta.
data.accounts[].type: Tipo de conta. Enum: CONTA_DEPOSITO_A_VISTA, CONTA_POUPANCA, CONTA_PAGAMENTO_PRE_PAGA.
data.accounts[].subtype: Subtipo da conta. Enum: INDIVIDUAL, CONJUNTA_SIMPLES, CONJUNTA_SOLIDARIA.
links: Links de navegação entre páginas (ver descrição em /personal/identifications).
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.