Orientações e respostas da equipe da Direct Data

/api/CaixaRegularidadeEmpregadorFGTS

💡 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.

Introdução

A API Caixa - Regularidade do Empregador (FGTS) oferece informações completas sobre a situação de regularidade de empregadores, incluindo:

• Dados cadastrais da empresa;
• Situação de regularidade com o FGTS;
• Endereço do empregador;
• Histórico de certificados emitidos.

Essa API é ideal para onboarding de clientes e fornecedores e análise de risco/crédito.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/CaixaRegularidadeEmpregadorFGTS

Esse endpoint retorna informações detalhadas sobre a regularidade de um empregador perante o FGTS.

Regras

1. Apenas um CNPJ deve ser enviado por requisição.
2. É possível incluir a geração de um comprovante PDF por um custo adicional.

Autenticação

A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401).

Regras de Autenticação

1. O TOKEN deve ser incluído como parâmetro obrigatório.
2. Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.

Campos da API

Dados Retornados

• Inscrição: Número de inscrição do empregador (CNPJ).
• Razão Social: Nome oficial da empresa.
• Nome Fantasia: Nome fantasia da empresa.
• Flag Irregularidade: Indica se há irregularidades no FGTS.
• Status: Situação atual perante o FGTS.
• Data de Emissão: Data de emissão do certificado.
• Número do Certificado: Número do Certificado de Regularidade do FGTS.
• Endereço:
  • Logradouro: Nome da rua/avenida.
  • Número: Número do imóvel.
  • Complemento: Detalhes adicionais do endereço.
  • Bairro: Bairro do endereço.
  • Cidade: Cidade do endereço.
  • UF: Unidade Federativa (Estado) do endereço.
  • CEP: Código de Endereçamento Postal.
• Período de Validade:
  • Início: Data de início do período de validade.
  • Fim: Data de término do período de validade.
• Histórico:
  • Data de Emissão: Data de emissão de certificados anteriores.
  • Número do CRF: Número do certificado anterior.
  • Período de Validade:
    • Início: Data de início do período de validade.
    • Fim: Data de término do período de validade.

Parâmetros

Exemplo de Requisição

Usando cURL

curl -X 'GET' \
  'https://apiv3.directd.com.br/api/CaixaRegularidadeEmpregadorFGTS?CNPJ=12345678901234&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE&GERARCOMPROVANTE=habilitar' \
  -H 'accept: application/json'

Respostas

Sucesso (200)

A consulta foi realizada com sucesso e retorna os dados do empregador.

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Caixa - Regularidade do Empregador (FGTS)",
    "consultaUid": "direct-123456",
    "mensagem": "Consulta realizada com sucesso.",
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 150,
    "gerarComprovante": true,
    "urlComprovante": "https://apiv3.directd.com.br/comprovantes/123456.pdf"
  },
  "retorno": {
    "inscricao": "12345678901234",
    "razaoSocial": "Empresa Exemplo Ltda",
    "nomeFantasia": "Exemplo",
    "possuiIrregularidade": false,
    "status": "Regular",
    "dataEmissao": "01/01/2024",
    "numeroCertificado": "987654321",
    "endereco": {
      "logradouro": "Rua Exemplo",
      "numero": "123",
      "complemento": "Bloco A",
      "bairro": "Centro",
      "cidade": "São Paulo",
      "uf": "SP",
      "cep": "01000-000"
    },
    "periodoValidade": {
      "inicio": "01/01/2024",
      "fim": "31/12/2024"
    },
    "historico": [
      {
        "dataEmissao": "01/01/2023",
        "numeroCrf": "123456789",
        "periodoValidade": {
          "inicio": "01/01/2023",
          "fim": "31/12/2023"
        }
      }
    ]
  }
}

Erros Comuns

Notas Importantes

• Certifique-se de utilizar um TOKEN válido para acesso à API.
• Apenas um CNPJ deve ser enviado por requisição.
• O parâmetro GERARCOMPROVANTE é opcional, mas adiciona um custo extra à consulta.
• Em caso de dúvidas ou problemas, entre em contato pelo e-mail: suporte@directd.com.br.