Get the Dataprev credential status

Returns the non-secret status of the tenant’s stored Dataprev credentials (cert presence + fingerprint + expiry, oauth presence) together with the two public values stored verbatim: the codigoSolicitante and the worker portal base URL. When nothing is stored it returns 200 with both presence flags false, NOT 404, and each verbatim value is absent rather than empty. NEVER returns secret material.

GET /v1/credentials/dataprev

Get the Dataprev credential status

cURL

curl --request GET \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/credentials/dataprev \
  --header 'Authorization: Bearer <token>'

200

{
  "certPresent": true,
  "oauthPresent": true,
  "provider": "dataprev",
  "updatedAt": "2026-06-23T12:00:00Z",
  "certFingerprint": "3b1f...c0",
  "certNotAfter": "2027-01-01T00:00:00Z",
  "codigoSolicitante": "341",
  "portalBaseUrl": "https://portal.example.com/formalizacao",
  "revokedAt": "2026-07-14T15:30:00Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Respuesta

200

application/json

OK

certPresent · boolean · requerido

Whether a client certificate is stored for the tenant.

oauthPresent · boolean · requerido

Whether OAuth2 client_credentials are stored for the tenant.

provider · string · requerido

External rail the credentials belong to.

Ejemplo:

"dataprev"

updatedAt · string<date-time> · requerido

Last-update timestamp (RFC 3339, UTC).

Ejemplo:

"2026-06-23T12:00:00Z"

certFingerprint · string

SHA-256 hex fingerprint of the stored certificate (absent when none).

Ejemplo:

"3b1f...c0"

certNotAfter · string<date-time>

RFC 3339 cert expiry (UTC); absent when no cert is stored.

Ejemplo:

"2027-01-01T00:00:00Z"

codigoSolicitante · string

Dataprev codigoSolicitante: the institution's BACEN COMPE code (3 digits, zero-padded, 001-999). Public, non-secret; absent when none is stored.

Ejemplo:

"341"

portalBaseUrl · string

Base URL of the tenant's worker portal. Public, non-secret; absent when none is stored.

Ejemplo:

"https://portal.example.com/formalizacao"

revokedAt · string<date-time>

Credential revocation timestamp (RFC 3339, UTC); absent when credentials were never revoked.

Ejemplo:

"2026-07-14T15:30:00Z"