Sync

A rota Sync oferece uma consulta síncrona que fornece os resultados completos da pesquisa realizada.

INFO

Para consultas on-demand recomenda-se o uso da rota Async.

Status

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

Status	query	dataset
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.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método Authentication/Authenticate

Example:

Bearer {{bearer_token}}

Body Params application/json

query

string

required

Nome identificador da consulta, como, por exemplo, pf, pj, fiscal_tracking (consultas padronizadas) ou nome definido pelo suporte conforme cliente/contexto aplicável para consultas personalizadas.

parameters

object

required

Parâmetro necessário para o dataset que compõe a query a ser consultada. Veja aqui a lista de datasets e os respectivos parâmetros necessários (coluna F).

string

required

Example

{
    "query": "",
    "parameters": {"":""}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

result

object

required

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

processId

string

required

ID referente ao consumo síncrono ao Enrichment.

tier

string

deprecated

query

string

required

Nome identificador da consulta realizada.

status

string

required

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

Examples:

DONEERROR

parameters

object

required

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

datasets

array [object {6}] | null

optional

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

requestId

string

required

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

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

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

code

string

required

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

message

string | null

required

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

errors

array [object {2}] | null

required

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

Examples

Sucesso - Exemplo Query PFSucesso - Exemplo Query FISCAL_TRACKINGSOURCE IS TOO SLOW

{
    "result": {
        "processId": "009a7d10-a1ba-437e-a46f-b945bafb77a8",
        "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",

🟠400R101 A specified parameter is wrong

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Status#

Request

Request samples

Responses

Status