FGTS - Certificado de Regularidade

O que é#

Nesta consulta você verifica se um empregador está com o cadastro regular no FGTS e tem a possibilidade de emitir o Certificado de Regularidade do FGTS - CRF.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/fgts/certificado-regularidade

Parâmetros do header#

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body#

Nome	Tipo	Obrigatório?	Descrição
cnpj	string	Sim	CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999999 ou 99.999.999/9999-99
cei	String	Obrigatório se o campo "cnpj" não for preenchido	CEI válido, com ou sem máscara.

Retornos possíveis da requisição#

Status	Significado	Descrição	Informações retornadas
201	Created	Solicitação criada	Campo requestId, com o ID da requisição criada.
422	Unprocessable Entity	A solicitação contém erro	Em quais campos houve erro.

Exemplos de retornos#

Status 201

JSON

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

JSON

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#

Valores possíveis do campo "status"

Status	Significado
indefinido	Não foi possível determinar a regularidade (informações insuficientes ou indisponibilidade transitória da consulta à PGFN).
regular	Documento está regular
inexistente	Ocorre quando o empregador não está cadastrado.
irregular	Constam impedimentos na CAIXA e o empregador não pode emitir o CRF.

Resposta com registro encontrado

JSON

{
  "status": "indefinido",
  "cnpj": "99.999.999/9999-99",
  "razaoSocial": "EMPRESA LTDA",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "regular",
  "cnpj": "99.999.999/9999-99",
  "razaoSocial": "EMPRESA LTDA",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "irregular",
  "mensagem": "Constam impedimentos na CAIXA para a comprovação da regularidade do empregador no FGTS.",
  "cnpj": "99.999.999/9999-99",
  "razaoSocial": "EMPRESA LTDA",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

JSON

{
  "status": "inexistente",
  "mensagem": "Empregador não cadastrado."
}