Consultar queries
Serviço responsável para consultar o resultado de queries.
A partir deste serviço você poderá consultar via id ou customId queries enviadas tanto de pessoas física quanto jurídica. Recomendável para situações onde o recebimento por webhooks tenha falhado por algum motivo.
Para que evite-se requisições desnecessárias recomendamos o registro de endpoint como webhook. Dessa forma, logo que obtivermos todos os dados das queries enviadas, eles serão repassadas ao seu endpoint imediatamente.
Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.
Consulta individual
GET https://api-v2.smsfire.com.br/bigdata/status/:id
Informe o id da query que é dado no callback das requisições ou então customId que é informado na requisição de envio da consulta.
Atenção: Campos com * (asterisco) são obrigatórios
Path Parameters
id*
string
id ou customId da query (Máx. 40 caracteres)
Headers
Authorization*
string
Basic <Token>
{
"id": 123,
"customId": "fire0001",
"campaignId": 190,
"ip": "127.127.1.1",
"cost": 0.25,
"statusCode": 1,
"statusName": "NEW",
"statusDate": "2021-09-13T17:00:56-0300",
"person": {
"document": "02203304405",
"documentSituation": "REGULAR",
"fullname": "JOÃO BEZERRA DA SILVA",
"birthday": "1927-02-23",
"sex": "masc",
"mother": "EMILIA DA SILVA",
"dead": true,
"income": "1000",
"score": "ALTISSIMO",
"occupation": "MUSICO e INSTRUMENTISTA",
"mobiles": [
{
"area": "85",
"number": "944556677",
"checked": true,
"whatsapp": true,
"ranking": 1
}
],
"landlines": [
{
"area": "85",
"number": "22445566",
"checked": true,
"whatsapp": false,
"ranking": 1
}
],
"emails": [
{
"email":"[email protected]",
"checked":false,
"ranking":1
}
],
"addresses": [
{
"direction": "R FUNCHAL 418 29 A",
"number": "418",
"plus": "29 A",
"district": "VL OLIMPIA",
"city": "SAO PAULO",
"state": "SP",
"postalcode": "04551060",
"type": "residencial",
"ranking": 1
}
],
"vehicles": [
{
"plate": "AAA6677",
"model": "VW/SANTANA GLS",
"manufactureYear": 1988,
"modelYear": 1988,
"renavan": "444555666",
"chassis": "9BWZZZ32ZJP00112233",
"licensingDate": "1993-07-05T00:00:00-0300",
"ranking": 1
}
],
"parents": [
{
"fullname":"EMILIA DA SILVA",
"document":"02288877766",
"type":"MAE"
}
],
"businesses": [
{
"fullname": "PADARIA BEZERRA LTDA",
"document": "334445550000109",
"capital": 220000,
"share": 100,
"status": "ATIVA",
"fundationDate": "1966-07-20T00:00:00-0300"
}
]
}
}Exemplo de requisição
Consulta por
id
GET - https://api-v2.smsfire.com.br/bigdata/status/000001
Consulta por
customId
GET - https://api-v2.smsfire.com.br/bigdata/status/fire0001
Campos JSON do status
Detalhamento dos tipos de cada um dos campos dados no response das consultas individuais ou múltiplas.
Pessoa física ( CPF)
Campo
Tipo
Descrição
id
int
Id da consulta
customId
string | null
Id personalizado fornecido pelo cliente
campaignId
int
Id da campanha vinculada a mensagem
ip
string
Ip de onde a consulta foi gerada
cost
float
Valor debitado do saldo
statusCode
int
Código do status atual da mensagem
statusName
string
Nome do status da consulta
statusDate
string
Data da última atualização do status (ISO8601)
person
object
Objeto dado quando documento consultado é de pessoa física (CPF)
person.document
string
Documento pesquisado
person.documentSituation
string
Situação do documento
Regular
Cancelado
Titular falecido
Suspenso
Pendente de regularização
person.fullname
string
Nome completo
person.birthday
string
Data de nascimento (ISO8601)
person.sex
string
Gênero da pessoa
masc
fem
person.mother
string
Nome completo da mãe
person.dead
boolean
Indicativo se pessoa é falecida
person.income
string | null
Renda prevista
person.score
string | null
Risco de crédito
Baixíssimo risco
Baixo risco
Médio
Alto
Altíssimo
person.occupation
string | null
Profissão declarada
Pessoa jurídica (CNPJ)
Campo
Tipo
Descrição
id
int
Id da consulta
customId
string | null
Id personalizado fornecido pelo cliente
campaignId
int
Id da campanha vinculada a mensagem
ip
string
Ip de onde a consulta foi gerada
cost
float
Valor debitado do saldo
statusCode
int
Código do status atual da mensagem
statusName
string
Nome do status atual da mensagem
statusDate
string
Data da última atualização do status (ISO8601)
company
object
Objeto dado quando documento consultado é de pessoa jurídica (CNPJ)
company.document
string
Documento pesquisado
company.documentSituation
string
Situação do documento
Ativa
Baixada
Inapta
Regular
Suspensa
company.fiscalName
string
Razão social da empresa
company.fantasyName
string | null
Nome fantasia da empresa
company.birthday
string
Data de fundação da empresa
company.type
string
Porte da empresa
MEI
EIRELI
EPP
LTDA
ME
SA
company.occupation
string | null
Atividade principal da empresa
Estrutura do array business
Campo
Tipo
Descrição
code
string
Código CNAE
type
string
Tipo de CNAE
segment
string
Segmento CNAE
description
string
Descrição do código CNAE
Estrutura do array mobiles
Quando nenhum celular é encontrado, o array retornado é vazio.
Campo
Tipo
Descrição
area
string
Código de área do telefone
number
string
Número do telefone
checked
boolean
Se número é verificado ou não
whatsapp
boolean
Se número possui WhatsApp ou não
ranking
int
Qualidade de possibilidade de contato
Estrutura do array landlines
Quando nenhum telefone fixo é encontrado, o array retornado é vazio.
Campo
Tipo
Descrição
area
string
Código de área do telefone
number
string
Número do telefone
checked
boolean
Se número é verificado ou não
whatsapp
boolean
Se número possui WhatsApp ou não
ranking
int
Qualidade de possibilidade de contato
Estrutura do array e-mails
Quando nenhum e-mail é encontrado, o array retornado é vazio.
Campo
Tipo
Descrição
email
string
Endereço de e-mail
checked
boolean
Se e-mail é verificado ou não
ranking
int
Qualidade de possibilidade de contato
Estrutura do array addresses
Quando nenhum endereço é encontrado, o array retornado é vazio.
Campo
Tipo
Descrição
type
string | null
Informação do tipo de endereço
residencial
comercial
direction
string
Endereço completo
number
string | null
Número do endereço
plus
string | null
Complemento
district
string
Bairro ou distrito
city
string
Cidade
state
string
Estado
postalcode
string
Código postal (CEP)
Estrutura do array vehicles
Quando nenhum veículo é encontrado, o array retornado é vazio.
Campo
Tipo
Descrição
plate
string | null
Placa do veículo
model
string
Marca e modelo do veículo
manufactureYear
int
Ano de fabricação
modelYear
int
Ano do modelo
renavam
string | null
Registro renavam
chassis
string | null
Sequencia completa do chassi
licensingDate
string | null
Data identificada do último licenciamento (ISO8601).
ranking
int
Ordem de do mais novo ao mais antigo
Estrutura do array associates
Quando nenhum sócio é identificado, o array retornado é vazio.
Campo
Tipo
Descrição
fullname
string
Nome completo do sócio(a)
document
string
CPF ou CNPJ do sócio(a)
capital
float
Valor em R$ do capital do sócio(a)
share
float
Porcentagem de participação do sócio(a)
Estrutura do array parents
Quando nenhum vínculo é identificado, o array retornado é vazio.
Campo
Tipo
Descrição
fullname
string
Nome completo
document
string
Documento da pessoa (CPF)
type
string | null
Tipo de vínculo
MAE
PAI
IRMAO(A)
PRIMO(A)
TIO(A)
SOBRINHO(A)
VIZINHO
Estrutura do array businesses
Quando nenhum vínculo com empresas é identificado, o array retornado é vazio.
Campo
Tipo
Descrição
fullname
string
Razão social da empresa
document
string
CNPJ da empresa
capital
float
Valor em R$ do capital da pessoa consultada
share
float
Porcentagem de participação da pessoa a empresa
status
string
Situação da empresa
Ativa
Baixada
Inapta
fundationDate
string
Data de fundação da empresa (ISO8601).
Documento inválido ou inexistente
Campo
Tipo
Descrição
id
int
Id da consulta
customId
string | null
Id personalizado fornecido pelo cliente
campaignId
int
Id da campanha vinculada a mensagem
document
string
Documento pesquisado
statusCode
int
Código do status atual da mensagem
statusName
string
Nome do status da consulta
statusDate
string
Data da última atualização do status (ISO8601)
Last updated