Caixa FGTS Regularity Certificate (CRF)

Check whether a Brazilian employer is up to date with the FGTS, by CNPJ, from Caixa Econômica Federal: regular with the current Certificado de Regularidade do FGTS (number, validity, establishment address), or irregular with which body reports the impediment (PGFN or Caixa). Optionally the certificates issued in the last 24 months. found: false when the CNPJ is not registered as an employer.

post/br/caixa/fgts-certificate/v1

Request

Base URL: https://api.croma.run
URL: https://api.croma.run/br/caixa/fgts-certificate/v1
Auth: HTTP bearer

Headers

Idempotency-Keystring

Example:0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Request body

document_numberstring required

CNPJ de la empresa, con o sin puntuación, p. ej. 33.000.167/0001-01. Solo empresas: un CPF no se acepta.

include_historyboolean

Si es true, la respuesta incluye history, los certificados emitidos en los últimos 24 meses (opcional).

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.