Skip to main content
POST
Caixa FGTS Regularity Certificate (CRF)

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

Idempotency-Key
string

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.

Maximum string length: 255
Example:

"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"

Body

application/json
document_number
string
required

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

Pattern: ^(?:[A-Za-z0-9]{12}\d{2}|[A-Za-z0-9]{2}\.[A-Za-z0-9]{3}\.[A-Za-z0-9]{3}\/[A-Za-z0-9]{4}-\d{2})$
include_history
boolean
default:false

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

Response

Successful response

data
object
required