O endpoint /api/CaixaRegularidadeEmpregadorFGTS permite consultar a situação de regularidade de empregadores perante o FGTS, condição obrigatória para que possam se relacionar com órgãos públicos e instituições de crédito. O serviço fornece informações detalhadas e permite a emissão do Certificado de Regularidade do FGTS (CRF), conforme previsto em Lei.
FGTS - Regularidade do Empregador
Estar regular perante o FGTS é condição obrigatória para que o empregador possa relacionar-se com os órgãos da Administração
Pública e com instituições oficiais de crédito. Nesta página você poderá consultar a situação de regularidade do empregador e obter
o correspondente Certificado de Regularidade do FGTS - CRF, para os fins previstos em Lei.
Casos de Uso
- Integração com FGTS - Regularidade do Empregador
- Validação e padronização de dados cadastrais
- Automação de consultas para decisões operacionais
- Integração com fluxos de risco, crédito e compliance
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Documentação de FGTS - Regularidade do Empregador acessível e atualizada
- Reduz custos e erros manuais
- Aumenta confiabilidade das decisões
- Integração simples e escalável
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/CaixaRegularidadeEmpregadorFGTSEndpoint
GET https://apiv3.directd.com.br/api/CaixaRegularidadeEmpregadorFGTS?Cnpj={0}&Token=Seu_TokenDescrição: Endpoint para realizar consultas FGTS - Regularidade do Empregador .
Nota: Esta consulta gera comprovantes em PDF.
Esta API suporta geração de comprovantes em PDF
Campos Retornados
- Bairro: Bairro do endereço
- CEP: Número CEP do endereço
- Cidade: Cidade do registro em questão
- Complemento: Complemento do endereço do registro em questão
- Data de Emissão: Data da emissão do certificado
- Endereço: Informa o endereço do indivíduo
- Fim: Fim da validade do certificado
- Flag Irregularidade: Informa se a empresa possui ou não irregularidade. True(verdadeiro) ou false(falso)
- Início: Início da validade do certificado
- Inscrição: Retorna a inscrição do documento consultado
- Lista Histórico: Lista do histórico de certificados de regularidade perante o FGTS da empresa
- Logradouro: Nome da rua, avenida, travessa, alameda ou outros onde está localizado o endereço.
- Nome Fantasia: Nome fantasia da empresa
- Número: Número do registro em questão
- Número do Certificado: Número único identificador do certificado
- Número do CRF: Número identificador do certificado
- Período de Validade: Informa o período de validade do certificado
- Razão Social: Razão social da empresa
- Status: Retorna detalhes sobre o status do registro em questão
- UF: Unidade Federativa (estado) referente ao registro
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CNPJ | string | Sim | O parâmetro CNPJ pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"inscricao": "string",
"razaoSocial": "string",
"nomeFantasia": "string",
"possuiIrregularidade": true,
"status": "string",
"dataEmissao": "string",
"numeroCertificado": "string",
"endereco": {
"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"cidade": "string",
"uf": "string",
"cep": "string"
},
"periodoValidade": {
"inicio": "string",
"fim": "string"
},
"historico": [
{
"dataEmissao": "string",
"numeroCrf": "string",
"periodoValidade": {
"inicio": "string",
"fim": "string"
}
}
]
}
}Erros Comuns
| Código | Descrição |
|---|---|
400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- Para obter o comprovante desta consulta, utiliza-se: '&GerarComprovante=habilitar' na URL
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228