31 - Dados Cadastrais Assíncrona

cURL

cURL

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

200

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

Este endpoint permite consultas de forma básica, os dados cadastrais de um documento Jurídica, no formato de resposta assíncrona. A resposta é retornada em ‘String JSON’ serializado e inclui as seguintes informações:

• Nome;
• Data fundação;
• CNAE;
• Email;
• Telefones;
• Endereço.

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":.

{
    "BasicData": {
        "TaxIdNumber": "String",
        "OfficialName": "String",
        "TradeName": "String",
        "FoundedDate": "Data",
        "IsHeadquarter": Boolean,
        "TaxIdStatus": "String",
        "TaxIdStatusDate": "Data",
        "Activities": [
            {
                "IsMain": Boolean,
                "Code": "String",
                "Activity": "String"
            }
        ],
        "LegalNature": {
            "Code": "String",
            "Activity": "String"
        },
        "AdditionalOutputData": {
            "Capital": "String",
            "CapitalRS": Float
        }
    },
    "Emails": {
        "Primary": {
            "EmailAddress": "String",
            "Domain": "String",
            "UserName": "String",
            "Type": "String",
            "LastUpdateDate": "Data"
        },
        "Secondary": {
            "EmailAddress": "String",
            "Domain": "String",
            "UserName": "String",
            "Type": "String",
            "LastUpdateDate": "Data"
        }
    },
    "Addresses": {
        "Primary": {
            "Typology": "String",
            "Title": "String",
            "AddressMain": "String",
            "Number": "String",
            "Complement": "String",
            "Neighborhood": "String",
            "ZipCode": "String",
            "City": "String",
            "State": "String",
            "Country": "String",
            "Type": "String",
            "ComplementType": "String",
            "LastUpdateDate": "Data"
        },
        "Secondary": {
            "Typology": "String",
            "Title": "String",
            "AddressMain": "String",
            "Number": "String",
            "Complement": "String",
            "Neighborhood": "String",
            "ZipCode": "String",
            "City": "String",
            "State": "String",
            "Country": "String",
            "Type": "String",
            "ComplementType": "String",
            "LastUpdateDate": "Data"
        }
    },
    "Phones": {
        "Primary": {
            "Number": "String",
            "AreaCode": "String",
            "CountryCode": "String",
            "Complement": "String",
            "Type": "String",
            "PhoneNumberOfEntities": Numero,
            "LastUpdateDate": "Data"
        },
        "Secondary": {
            "Number": "String",
            "AreaCode": "String",
            "CountryCode": "String",
            "Complement": "String",
            "Type": "String",
            "PhoneNumberOfEntities": Numero,
            "LastUpdateDate": "Data"
        }
    },
    "Identificador": "String",
    "StatusConsulta": {
        "Code": Numero,
        "Message": "String"
    }
}

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

consulta · object

Mostrar atributos filhos

consulta. identificador · string | null

consulta. documento · string | null

consulta. enderecoCallback · string | null

consulta. tipoCallback · enum<integer>

Opções disponíveis: 2

Response

200

text/plain

Success

msg · string | null

messages · object[] | null

Mostrar atributos filhos

messages. messageType · enum<integer>

Opções disponíveis: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

hasError · boolean

falha · boolean

json · string | null