## Caixa / Regularidade do Empregador (FGTS)
Consulta a situação de regularidade do empregador e obtém os dados correspondentes ao Certificado de Regularidade do FGTS (CRF), Fundo de Garantia do Tempo de Serviço.


### Site URL
- https://consulta-crf.caixa.gov.br/consultacrf/pages/consultaEmpregador.jsf

### Request
POST endpoint: `https://api.infosimples.com/api/v2/consultas/caixa/regularidade`



| Parameter                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token*                     | The token that will authenticate and authorize the request.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| cnpj**                     | CNPJ of the company to be queried.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| cei**                      | Specific INSS Registration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| preferencia_emissao**      | Deve ser informado um dos valores a seguir: <br><ul><li><strong>nova</strong> para emitir um novo certificado</li><li><strong>2via</strong> para preferência em emitir segunda via de certificado (valor padrão)</li></ul><strong></strong>                                                                                                                                                                                                                                                                                                                                                                                   |
| aceita_resultado_parcial** | Define o comportamento da API quando a fonte consulta a situação da empresa (ex: "REGULAR") com sucesso, mas falha ao gerar algum outro dado, como, por exemplo, o Certificado de Regularidade ou o histórico do empregador.<ul><li><strong>"0"</strong>: opção padrão. A API retorna código 620. Garante que você só receba código 200 se a informação completa estiver disponível.</li><li><strong>"1"</strong>: a API retorna código 200, com dados parciais. Você receberá os dados que estiverem disponíveis e alguns outros, como os referentes ao Certificado de Regularidade, eventualmente estarão vazios.</li></ul> |

> * Required parameter.

> ** Optional parameter. Sometimes it is necessary to set at least one of the optional parameters for the service to work properly.


### Response examples (OK)
```json
{
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": {
    "api_version": "v2",
    "service": "caixa/regularidade",
    "parameters": {
      "cnpj": "11111111111111"
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.2",
    "requested_at": "2019-03-11T10:36:41.000-03:00",
    "elapsed_time_in_milliseconds": 3,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX19oRSJmIwWDb4d8z1FmsjZpSV+dg/QoF1X3iiQEjQUghCi/NFaFUtQ701TVdax3i/psZO//knpA/g=="
  },
  "data_count": 1,
  "data": [
    {
      "crf": "1111111111111111111111",
      "datahora": "10/03/2019 11:13:56",
      "endereco": "ROD RS 324 / SN / S J DA BELA VISTA PASSO FUNDO - RS",
      "historico_cabecalho": [
        "Data de Emissão/Leitura",
        "Data de Validade - Início",
        "Data de Validade - Fim",
        "Número do CRF"
      ],
      "historico_lista": [
        [
          "26/02/2019",
          "26/02/2019",
          "27/03/2019",
          "2019022602493515835020"
        ],
        [
          "07/02/2019",
          "07/02/2019",
          "08/03/2019",
          "2019020702123047511768"
        ],
        [
          "19/01/2019",
          "19/01/2019",
          "17/02/2019",
          "2019011901573935096397"
        ],
        [
          "31/12/2018",
          "31/12/2018",
          "29/01/2019",
          "2018123101381926846041"
        ],
        [
          "12/12/2018",
          "12/12/2018",
          "10/01/2019",
          "2018121202402590755372"
        ],
        [
          "22/11/2018",
          "22/11/2018",
          "21/12/2018",
          "2018112200330170103584"
        ],
        [
          "25/10/2018",
          "25/10/2018",
          "23/11/2018",
          "2018102523374260861921"
        ],
        [
          "05/10/2018",
          "05/10/2018",
          "03/11/2018",
          "2018100505052554284146"
        ],
        [
          "16/09/2018",
          "16/09/2018",
          "15/10/2018",
          "2018091604221700719409"
        ],
        [
          "28/08/2018",
          "28/08/2018",
          "26/09/2018",
          "2018082804493189736666"
        ],
        [
          "09/08/2018",
          "09/08/2018",
          "07/09/2018",
          "2018080905292286470767"
        ],
        [
          "21/07/2018",
          "21/07/2018",
          "19/08/2018",
          "2018072105383690699713"
        ],
        [
          "02/07/2018",
          "02/07/2018",
          "31/07/2018",
          "2018070204091091306000"
        ],
        [
          "13/06/2018",
          "13/06/2018",
          "12/07/2018",
          "2018061305371315602884"
        ],
        [
          "25/05/2018",
          "25/05/2018",
          "23/06/2018",
          "2018052505073302817602"
        ],
        [
          "06/05/2018",
          "06/05/2018",
          "04/06/2018",
          "2018050605221347160830"
        ],
        [
          "16/04/2018",
          "16/04/2018",
          "15/05/2018",
          "2018041603465640368656"
        ],
        [
          "28/03/2018",
          "28/03/2018",
          "26/04/2018",
          "2018032804541852385484"
        ],
        [
          "09/03/2018",
          "09/03/2018",
          "07/04/2018",
          "2018030905001293282304"
        ],
        [
          "18/02/2018",
          "18/02/2018",
          "19/03/2018",
          "2018021805341379229016"
        ],
        [
          "30/01/2018",
          "30/01/2018",
          "28/02/2018",
          "2018013012052686093374"
        ],
        [
          "10/01/2018",
          "10/01/2018",
          "08/02/2018",
          "2018011011450566221225"
        ],
        [
          "22/12/2017",
          "22/12/2017",
          "20/01/2018",
          "2017122206172326008230"
        ],
        [
          "03/12/2017",
          "03/12/2017",
          "01/01/2018",
          "2017120305285252987363"
        ],
        [
          "14/11/2017",
          "14/11/2017",
          "13/12/2017",
          "2017111403550479271842"
        ],
        [
          "26/10/2017",
          "26/10/2017",
          "24/11/2017",
          "2017102603315350690311"
        ],
        [
          "07/10/2017",
          "07/10/2017",
          "05/11/2017",
          "2017100704185767114512"
        ],
        [
          "18/09/2017",
          "18/09/2017",
          "17/10/2017",
          "2017091802360444160106"
        ],
        [
          "30/08/2017",
          "30/08/2017",
          "28/09/2017",
          "2017083003164659270453"
        ],
        [
          "11/08/2017",
          "11/08/2017",
          "09/09/2017",
          "2017081103370644694533"
        ],
        [
          "23/07/2017",
          "23/07/2017",
          "21/08/2017",
          "2017072303220493517676"
        ],
        [
          "04/07/2017",
          "04/07/2017",
          "02/08/2017",
          "2017070403433185407090"
        ],
        [
          "15/06/2017",
          "15/06/2017",
          "14/07/2017",
          "2017061503220573878082"
        ],
        [
          "27/05/2017",
          "27/05/2017",
          "25/06/2017",
          "2017052703324288129406"
        ],
        [
          "08/05/2017",
          "08/05/2017",
          "06/06/2017",
          "2017050802292719295254"
        ],
        [
          "19/04/2017",
          "19/04/2017",
          "18/05/2017",
          "2017041903120433903194"
        ],
        [
          "31/03/2017",
          "31/03/2017",
          "29/04/2017",
          "2017033103394447956970"
        ],
        [
          "12/03/2017",
          "12/03/2017",
          "10/04/2017",
          "2017031202201940782255"
        ]
      ],
      "inscricao": "11111111/1111-11",
      "razao_social": "Empresa XYZ",
      "situacao": "REGULAR",
      "validade_fim_data": "11/11/1111",
      "validade_inicio_data": "11/11/1111",
      "site_receipt": "https://api.infosimples.com/receipt/exemplo-de-url"
    }
  ],
  "site_receipts": [
    "https://api.infosimples.com/receipt/exemplo-de-url"
  ]
}
```


### Preview file

The preview file (`site_receipts`) in the response JSON is **generated by the source (website/app)** that processed the automation.

### Code snippets


#### Python
```python
# Tested with: Python 3.10.19, Python 3.14.0
import requests

url = 'https://api.infosimples.com/api/v2/consultas/caixa/regularidade'
args = {
  "cnpj":                     "VALUE_OF_PARAMETER_CNPJ",
  "cei":                      "VALUE_OF_PARAMETER_CEI",
  "preferencia_emissao":      "VALUE_OF_PARAMETER_PREFERENCIA_EMISSAO",
  "aceita_resultado_parcial": "VALUE_OF_PARAMETER_ACEITA_RESULTADO_PARCIAL",
  "token":                    "WRITE_YOUR_TOKEN_HERE",
  "timeout":                  "300"
}

response = requests.post(url, args)
response_json = response.json()
response.close()

if response_json['code'] == 200:
  print("Retorno com sucesso: ", response_json['data'])
elif response_json['code'] in range(600, 799):
  mensagem = "Resultado sem sucesso. Leia para saber mais: \n"
  mensagem += "Código: {} ({})\n".format(response_json['code'], response_json['code_message'])
  mensagem += "; ".join(response_json['errors'])
  print(mensagem)

print("Cabeçalho da consulta: ", response_json['header'])
print("URLs com arquivos de visualização (HTML/PDF): ", response_json['site_receipts'])
```


## We are here to help
Do you still need to figure something out? Reach us at [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) and our highly qualified support team will be happy to help.