32 - Dados Históricos Síncrona

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/HistoricoCadastralPJ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "consulta": {
    "identificador": "<string>",
    "documento": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

Este endpoint realiza consultas síncronas e retorna, em formato de ‘String JSON’ serializada, os dados históricos de um documento jurídico.

A resposta contém as seguintes informações principais:

• Idade da empresa;
• Lista de CNAEs;
• Lista de nomes;
• Lista de regimes fiscais.

Mostrar Exemplo de retorno completo

O exemplo de retorno, mostrado no lado direito desta tela, está resumido. Na linha "json": "<string>" o retorno do Bureau vem de forma serializada, sendo necessário deserializar para melhor visualização. Aqui está um exemplo do retorno deserializado que vem no campo "json":.

{
    "Age": Numero,
    "CnaeHistoryList": [
        {
            "Activity": "String",
            "ChangeDate": "Data",
            "Code": "String",
            "DocNumber": "String",
            "EconomicActivityDivision": "String",
            "EconomicActivityGroup": "String",
            "IsMainEconomicActivity": Boolean
        }
    ],
    "CnaeTotalChanges": Numero,
    "CurrentName": "String",
    "HeadquarterTotalChanges": int,
    "LastDateChanged": "Data",
    "LastLegalNatureChanged": "Data",
    "LastNameChanged": "Data",
    "NameHistoryList": [
        {
            "ChangeDate": "Data",
            "Name": "String",
            "OfficialName": "String",
            "TradeName": "String"
        }
    ],
    "NameTotalChanges": Numero,
    "TaxRegimeHistoryList": [
        {
            "ChangeDate": "Data",
            "TaxRegime": "String"
        }
    ],
    "TaxRegimeTotalChanges": Numero,
    "TotalChanges": Numero,
    "Identificador": "String",
    "StatusConsulta": {
        "Code": Numero,
        "Message": "String"
    }
}

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

consulta · object

Show child attributes

Resposta

200

text/plain

Success

msg · string | null

messages · object[] | null

Show child attributes

hasError · boolean

falha · boolean

json · string | null