Status

Rota para busca do estado atual da requisição realizada na rota async e retorno dos dados já obtidos.

Lista de status retornados pelo campo status e seus significados, onde o contexto pode se referir à query ou dataset.

Status	query	dataset
TODO	Consulta não iniciada	Consulta não iniciada.
DOING	Consulta em execução	Consulta em execução.
DONE	Consulta finalizada: neste estágio, a consulta de todos os datasets foi finalizada, seja com sucesso ou não.	Consulta finalizada.
ERROR	Status finalístico que indica que todos os datasets que compõem a consulta retornaram erro.	Especifica o erro no dataset em questão e/ou indisponibilidade da fonte dos dados.

Requisição

Parâmetros Header

Authorization

string

requerido

Token de autorização obtido no método user/authenticate.

Exemplo:

Bearer {{bearer_token}}

Parâmetros Bodyapplication/json

processId

string

requerido

Código identificadordo processo utilizado para consulta do status do processamento à query enviada na rota async.

Examples

Exemplo 1Example 2

{
    "processId": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200200 OK Response

application/json

Body

result

object

requerido

Lista contendo o resultado do método (consulte na documentação específica de cada um).

tier

string

deprecated

query

string

requerido

Nome identificador da consulta realizada.

status

string

requerido

Status da query, que pode variar entre os estados finais DONE ou ERROR.

Exemplo:

DONEERROR

parameters

object

requerido

Objeto parameters enviado na requisição do método /big-data/enrichment.

datasets

array [object {6}] | null

opcional

Datasets com informações relacionadas ao parâmetro de entrada.

requestId

string

requerido

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

requerido

Tempo de duração do processamento em milissegundos.

status

object

requerido

Objeto contendo o código de status e a mensagem de resposta.

code

string

requerido

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

message

string | null

requerido

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

requerido

Lista de objetos do tipo Error, o formato é variável.

Examples

Sucesso - Exemplo Query PFSucesso - Exemplo Query FISCAL_TRACKINGSOURCE IS TOO SLOWWebhook - Body response sucesso (status DONE)Webhook - Body response erro (status ERROR)

{
    "result": {
        "tier": "pf",
        "query": "pf",
        "status": "DONE",
        "parameters": {
            "cpf": "XXXXXXXXXXX"
        },
        "datasets": [
            {
                "name": "basic_data",
                "code": "basic_data_people_862909",
                "status": "DONE",
                "fromCache": false,
                "errors": [],
                "data": [
                    {
                        "matchKeys": "doc{XXXXXXXXXXX}",
                        "basicData": {
                            "taxIdNumber": "XXXXXXXXXXX",
                            "taxIdCountry": "BRAZIL",
                            "alternativeIdNumbers": {
                                "socialSecurityNumber": "XXXXXXXXXXX",
                                "rg - MG": "XXXXXXXX"
                            },
                            "extendedDocumentInformation": {
                                "rg - MG": {
                                    "documentNumber": "XXXXXXXX",
                                    "documentLast4Digits": "XXXX",
                                    "documentIssuingAgency": "SSP",
                                    "documentIssuingStateCode": "MG",
                                    "creationDate": "2019-10-24T21:42:13.957Z",
                                    "lastUpdateDate": "2020-11-25T20:54:20.308Z",
                                    "sources": [
                                        "MEI-RF",
                                        "ENADE"
                                    ]
                                }
                            },
                            "name": "XXXXXXXXXXX XXX XXXXXXXXXXX",
                            "aliases": {
                                "commonName": "XXXXXXXXXXX",
                                "standardizedName": "XXXXXXXXXXX XXXXXXXXXXX"
                            },
                            "gender": "F",
                            "nameWordCount": 7,
                            "numberOfFullNameNamesakes": 1,
                            "nameUniquenessScore": 1,
                            "firstNameUniquenessScore": 0.001,
                            "firstAndLastNameUniquenessScore": 0.11111111,
                            "birthDate": "1985-05-22T00:00:00Z",
                            "age": 39,
                            "zodiacSign": "GEMEOS",
                            "chineseSign": "Ox",
                            "birthCountry": "BRASILEIRA",
                            "motherName": "XXXXXXXXXXX XXXXXXXXXXX",
                            "fatherName": "",
                            "maritalStatusData": {},
                            "taxIdStatus": "REGULAR",
                            "taxIdOrigin": "RECEITA FEDERAL",
                            "taxIdFiscalRegion": "MG",
                            "hasObitIndication": false,
                            "taxIdStatusDate": "2024-05-03T00:00:00",
                            "taxIdStatusRegistrationDate": "2002-10-31T00:00:00Z",
                            "creationDate": "2016-11-26T00:00:00Z",
                            "lastUpdateDate": "2024-06-11T00:00:00Z"
                        }
                    }
                ]
            },
            {
                "name": "addresses_extended",
                "code": "addresses_extended_people_862909",
                "status": "DONE",
                "fromCache": false,
                "errors": [],
                "data": [
                    {
                        "matchKeys": "doc{XXXXXXXXXXX}",
                        "extendedAddresses": {
                            "totalAddresses": 5,
                            "totalActiveAddresses": 3,
                            "totalWorkAddresses": 5,
                            "totalPersonalAddresses": 0,
                            "totalUniqueAddresses": 1,
                            "totalAddressPassages": 8,
                            "totalBadAddressPassages": 0,
                            "oldestAddressPassageDate": "2015-08-01T00:00:00Z",
                            "newestAddressPassageDate": "2024-03-28T00:00:00Z",
                            "addresses": [
                                {
                                    "typology": "AV",
                                    "title": "",
                                    "addressMain": "PAULISTA DE",
                                    "number": "1047",
                                    "complement": "A 1865 LADO IMPAR 1483 CJ 1012",
                                    "neighborhood": "BELA VISTA",
                                    "zipCode": "01311200",
                                    "city": "SAO PAULO",
                                    "state": "SP",
                                    "country": "BRASIL",
                                    "type": "WORK",
                                    "addressCurrentlyInRFSite": false,

🟠400R125 Process expired or not found with the given ID

🟠400R101 A specified parameter is wrong

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Status

Status#

Requisição

Exemplos de Requisição

Respostas

Status