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 |
|---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
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: 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 |
|---|---|---|---|
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
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}
|
Status 422
{
"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 | Documento está irregular |
regular | Documento está regular |
erro | Ocorre quando o documento informado não existe |
Resposta com registro encontrado
{
"status": "indefinido",
"cnpj": "99.999.999/9999-99",
"razaoSocial": "EMPRESA LTDA",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
"status": "regular",
"cnpj": "99.999.999/9999-99",
"razaoSocial": "EMPRESA LTDA",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
Resposta com erro
{
"status": "inexistente",
"mensagem": "Empregador não cadastrado."
}