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.

Veja mais informações em nossa central de ajuda: FGTS - Certificado de Regularidade

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/fgts/certificado-regularidade

URL Base:

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

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

Nome

Tipo

Obrigatório?

Descrição

cnpj

string

Sim

CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 9999999999999 ou 99.999.999/0009-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

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

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

Status 422

1 2 3 4 5 6 7 8 9 10 11 {   "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

Status

Significado

indefinido

Documento está irregular

regular

Documento está regular

inexistente

Ocorre quando o empregador não está cadastrado.

Resposta com registro encontrado

1 2 3 4 5 6 { "status": "indefinido", "cnpj": "99.999.999/9999-99", "razaoSocial": "EMPRESA LTDA", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
1 2 3 4 5 6 { "status": "regular", "cnpj": "99.999.999/9999-99", "razaoSocial": "EMPRESA LTDA", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }

Resposta com erro

1 2 3 4 { "status": "inexistente", "mensagem": "Empregador não cadastrado." }