Documentação Técnica

Certidão FGTS

Descrição

A consulta de Certidão do FGTS retorna os dados referentes a emissão da certidão de regularidade do empregador frente ao FGTS. Todos os dados de certidões e certificações consultados em um modelo "on-demand" são retornados em uma mesma estrutura de objetos, e os objetos em si são retornados no campo de OnlineCertificates do objeto principal de retorno.

Origem da Informação

As informações retornadas nesta consulta são retiradas da consulta pública de regularidade do empregador, disponibilizada pela Caixa Econômica Federal.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,030
10001 - 50000R$ 0,028
50001 - 100000R$ 0,027
100001 - 500000R$ 0,026
500001 - 1000000R$ 0,025
1000001 - 5000000R$ 0,024
5000001 - 10000000R$ 0,023
10000001 - 50000000R$ 0,022
50000001 e acimaR$ 0,021

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
docDocumento de identificaçãoCNPJ🛑 Obrigatório

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "ondemand_fgts_company",
    "q": "doc{CNPJ}"  
}  

Descrição dos campos do objeto principal de retorno

CampoDescrição
OriginFonte dos Dados Entregues
InputParametersParâmetros de entrada
QueryDateData de realização da consulta
QueryResultData.IdNumberNúmero de identificação da empresa
QueryResultData.AddressCoreLogradouro da empresa
QueryResultData.NumberNúmero de porta da empresa
QueryResultData.ComplementComplemento do endereço da empresa
QueryResultData.NeighborhoodBairro da empresa
QueryResultData.CityCidade da empresa
QueryResultData.StateEstado da empresa
QueryResultData.ZipCodeCEP da empresa
QueryResultData.CountryPaís da empresa
QueryResultData.STATUSStatus retornado pela certidão
QueryResultData.CERTIFICATIONNUMBERNúmero da certidão
QueryResultData.VALIDITYValidade da certidão
Language
Credentials
Click Try It! to start a request and see the response here!