A tabela abaixo detalha os campos aceitos na consulta a este dataset.
Campo
Descrição
Valores Possíveis
Tipo de Campo
document
Documento de identificação
CNPJ
Obrigatório
type
Identificador do tipo de consulta
ADVANCED, ADDITIONAL_INPUTS
Obrigatório
subproducts
Array de Slugs dos subprodutos que serão inclusos na busca
["certidao-fgts-pj"]
Obrigatório
Quando o parâmetro type for definido como ADVANCED, a resposta incluirá os dados da Consulta Básica.
Quando definido como ADDITIONAL_INPUTS, a resposta conterá apenas os subprodutos e providers explicitamente informados na requisição.
Corpo da Resposta
Campo
Tipo
Descrição
ticketId
string
Identificador da consulta
executadoEm
date
Data e hora da execução da consulta
status
string
'Executado'
'Executado com exceção'. Em caso de execução com exceção o campo exceptions será preenchido, porém a request retorna sucesso
resultado
object
Resposta da Consulta Básica
exceptions
array<object>
Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando status = 'Executado com exceção'
Estrutura de exceptions
Campo
Tipo
Descrição
message
string
Descrição do erro ocorrido. Exemplos: "Os slugs informados estão inativos.", "Os slugs informados não foram encontrados."
slugs
array<string>
Lista dos slugs que ocasionaram a exceção
Estrutura de resultado
Campo
Tipo
Descrição
certidao-fgts-pj
object
Lista com os detalhes do documento consultado
Estrutura de certidao-fgts-pj
Campo
Tipo
Descrição
name
string
Nome do subproduto consultado
status
integer
Status Code da Requisição
Result
object
Lista com os detalhes da consulta
Estrutura de Result
Nome
Tipo
Descrição
QueryId
string
Id único identificador da chamada.
ElapsedMilliseconds
number
A quantidade de milissegundos decorridos durante a chamada.
QueryDate
string
A data de quando o request foi recebido e processado.
Status
object
Lista de status para cada dataset.
OnlineCertificates
array of objects
Lista de certificados online retornados pela consulta.
Estrutura de OnlineCertificates
Nome
Tipo
Descrição
Origin
string
Fonte dos dados entregues.
InputParameters
string
Parâmetros de entrada.
ProtocolNumber
string
Número de protocolo da certidão emitida.
BaseStatus
string
Status simplificado da certidão emitida.
AdditionalOutputData
object
Dados adicionais.
QueryDate
string
Data de realização da consulta.
Language
Credentials
Header
Click Try It! to start a request and see the response here!
