Dados Cadastrais

Descrição

Retorna os dados cadastrais do CPF informados a cada instituição Open Finance vinculada. O campo identities é um array com um item por instituição, portanto pode haver variações entre os registros.

Request Body

Content-Type: application/json

Campo	Tipo	Obrigatorio	Descricao
document	string	Sim	CPF do consultado (11 dígitos, somente números).
product_code	array	Sim	Lista de códigos de produto a consultar. Pode combinar vários relatórios Open Finance numa única requisição.

Exemplo

{
    "document": "12345678901",
    "product_code": [
        "DADOS_CADASTRAIS"
    ]
}

Exemplo cURL

curl -X POST \
  https://positivaconnect.positivaconsultas.com.br/api/client/provider/open-finance \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "12345678901",
    "product_code": ["DADOS_CADASTRAIS"]
  }'

Formato do Envelope de Resposta

200 OK

{
  "success": true,
  "document": "12345678901",
  "provider": "open-finance",
  "query_date": "2026-03-18T10:00:00",
  "results": {
    "DADOS_CADASTRAIS": {
      "success": true,
      "data": { ... }
    }
  }
}

Quando results.DADOS_CADASTRAIS.success for false, indica falha de comunicação com o provider externo (timeout, erro 5xx). Erros de autorização são rejeitados antes da consulta com HTTP 403.

Campos do `data`

Campo	Descrição
reportStatus	Código HTTP do status do relatório na Klavi (200 = sucesso).
requestId	Identificador único da requisição na Klavi.
productName	Código do produto consultado na Klavi (ex.: pf_klavi_income_eco).
productVersion	Versão do produto (ex.: V1).
productReportTime	Data e hora de geração do relatório (ISO 8601).
enquiryCpf	CPF consultado.
identities	Array de registros cadastrais — um por instituição Open Finance vinculada.
identities[].civilName	Nome civil.
identities[].cpfNumber	CPF informado na instituição.
identities[].birthDate	Data de nascimento (YYYY-MM-DD).
identities[].sex	Sexo (ex.: MASCULINO, FEMININO).
identities[].nationality	Nacionalidade (código ISO, ex.: BRA).
identities[].maritalStatusCode	Estado civil (ex.: SOLTEIRO, VIUVO).
identities[].occupation	Ocupação declarada.
identities[].email	E-mail cadastrado.
identities[].phone	Telefone (type, countryCallingCode, areaCode, number, phoneExtension).
identities[].postalAddresses	Endereço (address, townName, countrySubDivision, postCode, country, geographicCoordinates).
identities[].filiations	Filiação (type: MAE/PAI, civilName).
identities[].otherDocuments	Outros documentos (type ex.: CNH, number, expirationDate, additionalInfo).
identities[].passport	Passaporte (number, country, issueDate, expirationDate).
identities[].informedIncome	Renda informada (amount{amount,currency}, frequency, year).
identities[].informedPatrimony	Patrimônio informado (amount{amount,currency}, year).
identities[].accounts	Contas na instituição (branchCode, number, checkDigit, type, subtype).
identities[].bacenName	Nome da instituição no Bacen.
identities[].brandName	Marca/razão social da instituição.
identities[].companyCnpj	CNPJ da instituição.
identities[].compeCode	Código Compe da instituição.
identities[].startDate	Data de início do relacionamento (ISO 8601).
identities[].paychecksBankLink	Vínculos de folha de pagamento (employerName, employerCnpjCpf, paycheckBankCnpj, paycheckBankIspb, accountOpeningDate).
identities[].portabilitiesReceived	Portabilidades de salário recebidas.

Exemplo de Resposta

Conteúdo de results.DADOS_CADASTRAIS.data

200 OK

{
    "reportStatus": 200,
    "requestId": "e044ab0c0f5f4e139587b3c87d87fc7b",
    "productName": "pf_user_identity_eco",
    "productVersion": "V1",
    "productReportTime": "2026-08-19T17:49:11.798Z",
    "enquiryCpf": "76109277673",
    "identities": [
        {
            "civilName": "Tatiana Galvão",
            "cpfNumber": "76109277673",
            "birthDate": "1989-03-23",
            "sex": "MASCULINO",
            "nationality": "BRA",
            "maritalStatusCode": "SOLTEIRO",
            "occupation": "01",
            "email": "tatiana.galvao@email.com",
            "phone": {
                "type": "FIXO",
                "countryCallingCode": "55",
                "areaCode": "51",
                "number": "325421328",
                "phoneExtension": "258"
            },
            "postalAddresses": {
                "address": "Rua Laguna 129",
                "townName": "Porto Alegre",
                "countrySubDivision": "RS",
                "postCode": "90820060",
                "country": "Brasil",
                "additionalInfo": "Casa Amarela",
                "geographicCoordinates": {
                    "latitude": "-30.0953952",
                    "longitude": "-51.2279909"
                }
            },
            "filiations": [
                {
                    "civilName": "Andreia Galvao",
                    "type": "MAE"
                }
            ],
            "otherDocuments": [
                {
                    "type": "CNH",
                    "number": "58438287",
                    "checkDigit": "P",
                    "expirationDate": "2025-05-21",
                    "additionalInfo": "SSP\/RS"
                }
            ],
            "passport": {
                "number": "34229643119827236458",
                "country": "CAN",
                "issueDate": "2018-05-24",
                "expirationDate": "2022-05-24"
            },
            "informedIncome": {
                "amount": {
                    "amount": "100000.04",
                    "currency": "BRL"
                },
                "frequency": "OUTROS",
                "year": 2021
            },
            "informedPatrimony": {
                "amount": {
                    "amount": "100000.04",
                    "currency": "BRL"
                },
                "year": 2010
            },
            "accounts": [
                {
                    "branchCode": "6272",
                    "number": "11188222",
                    "checkDigit": "4",
                    "type": "CONTA_POUPANCA",
                    "subtype": "INDIVIDUAL"
                },
                {
                    "branchCode": "6272",
                    "number": "94088392",
                    "checkDigit": "4",
                    "type": "CONTA_DEPOSITO_A_VISTA",
                    "subtype": "INDIVIDUAL"
                }
            ],
            "bacenName": "Mock Bank",
            "brandName": "Alana e Bianca Assessoria Jurídica Ltda",
            "companyCnpj": "50685362000131",
            "compeCode": "123",
            "startDate": "2020-05-21T12:00:00Z"
        }
    ]
}

Respostas de Erro

400

invalid_request

Documento inválido, product_code ausente ou vazio

401

unauthenticated

Token JWT ausente ou inválido

403

product_not_authorized

Um ou mais produtos informados não estão contratados. A requisição inteira é rejeitada.

404

product_not_found

Um dos códigos em product_code não existe ou está inativo