Skip to content

finnest dcr ​

Fetch/summarize an SSA, safely inspect and reconcile OFB or OPIN receiver DCR state, or read its HTTP trail.

Decode/fetch a provider DCR software statement (SSA), inspect a receiver DCR attempt, read the redacted HTTP exchanges the receiver made with a transmissora, or reconcile one exact registration after out-of-band provider confirmation. registration-status, exchanges and reconcile require --ecosystem ofb (the banking receiver, operator client finnest-ofb-dcr-operator in the finnest-ofb realm) or --ecosystem opin (the insurance receiver, finnest-opin-dcr-operator in the finnest-opin realm); the CLI never infers it. They need the tenant host (from config or --auth-base; a regulated deploy publishes no token route on auth., so pass --auth-base at a kubectl port-forward to Keycloak) and the DCR operator client secret of that ecosystem (persisted with finnest secrets write ofb-dcr-operator-client-secret --stdin or finnest secrets write opin-dcr-operator-client-secret --stdin, or set in FINNEST_OFB_DCR_OPERATOR_CLIENT_SECRET or FINNEST_OPIN_DCR_OPERATOR_CLIENT_SECRET). SSA/token/secret material and certificate thumbprints are never printed.

Grupo: Deploy e ciclo de vida · Nível: avançado

Comando avançado

Use este comando quando a documentação de operação ou o suporte Finnest indicar.

Uso ​

bash
finnest dcr [subcomando] [opções]

Sem subcomando, executa finnest dcr ssa-summary.

Exemplos ​

bash
finnest dcr ssa-summary --ssa-file ./ssa.jwt
finnest dcr ssa-summary --ssa-file ./ssa.jwt --json
finnest dcr fetch-ssa --org-id <id> --software-id <id> --directory-client-id <client-id> --brcac-cert ./brcac.pem --brcac-key ./brcac.key --out ./ssa.jwt
finnest dcr fetch-ssa --environment=prod --config-overlay ./finnest.prod.toml --brcac-cert ./brcac.pem --brcac-key ./brcac.key --out ./ssa.jwt
finnest dcr registration-status <authorisation-server-id> --ecosystem ofb
finnest dcr exchanges <authorisation-server-id> --ecosystem opin --verbose
finnest dcr reconcile <authorisation-server-id> <attempt-id> provider_confirmed_not_created --ecosystem ofb --evidence-reference <provider-ticket> --yes

Opções ​

  • --ssa-file <path> — Path to a compact SSA JWT file (dcr ssa-summary, or the opin verify DCR probe).
  • --log-level <level> — Diagnostic verbosity: error, warn, info, debug, or trace.
  • --plain — Force headless output even on an interactive TTY.
  • --verbose — Enable debug-level diagnostics.

As opções globais de saída também se aplicam.

Subcomandos ​

  • ssa-summary — Decode a compact SSA to a sanitized summary.
  • fetch-ssa — Fetch a fresh SSA from the Directory and write it to disk.
  • registration-status — Read the sanitized local OFB or OPIN DCR registration/attempt state.
  • exchanges — List the redacted DCR HTTP exchanges with an authorisation server.
  • reconcile — Delete one exact OFB or OPIN registration attempt after provider confirmation.

finnest dcr ssa-summary ​

Decode a compact SSA to a sanitized summary.

Opções ​

  • --ssa-file <path> — Path to a compact SSA JWT file (dcr ssa-summary, or the opin verify DCR probe).
  • --log-level <level> — Diagnostic verbosity: error, warn, info, debug, or trace.
  • --plain — Force headless output even on an interactive TTY.
  • --verbose — Enable debug-level diagnostics.

As opções globais de saída também se aplicam.

finnest dcr fetch-ssa ​

Fetch a fresh SSA from the Directory and write it to disk.

Fetch a fresh SSA using the Directory-required mTLS + directory:software bearer (the authorisation server receiving the registration only accepts an SSA whose iat is under 5 minutes old). The assertion path is the one the official OPIN Directory OpenAPI defines.

Opções ​

  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --software-id <id> — Directory software statement id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --brcac-cert <path> — Path to the BRCAC client certificate PEM used for mTLS.
  • --brcac-key <path> — Path to the BRCAC client key PEM used for mTLS.
  • --ca-bundle <path> — Optional CA bundle PEM override; Directory commands otherwise use the configured ICP-Brasil trust material.
  • --directory-base <url> — OPIN Directory mTLS API base; token endpoint comes from issuer discovery.
  • --directory-client-id <id> — Directory Software Statement ClientId used to obtain the Directory token.
  • --environment <environment> — Target environment: sandbox or prod.
  • --out <path> — Write the command output to this file (created with 0600 permissions).
  • --config <path> — Path to an explicit Finnest TOML configuration file.
  • --config-only <path> — Load only this Finnest TOML file; do not merge ambient user or project config.
  • --config-overlay <path> — Overlay this Finnest TOML file over operator and project config.
  • --log-level <level> — Diagnostic verbosity: error, warn, info, debug, or trace.
  • --plain — Force headless output even on an interactive TTY.
  • --verbose — Enable debug-level diagnostics.

As opções globais de saída também se aplicam.

finnest dcr registration-status ​

Read the sanitized local OFB or OPIN DCR registration/attempt state.

Argumentos ​

  • <authorisation-server-id> — Directory Authorisation Server UUID.

Exemplos ​

bash
finnest dcr registration-status <authorisation-server-id> --ecosystem ofb
finnest dcr registration-status <authorisation-server-id> --ecosystem opin --environment=sandbox --json

Opções ​

  • --ecosystem <ecosystem> — DCR operations: the ecosystem whose receiver and Keycloak realm to reach, ofb (banking, finnest-ofb) or opin (insurance, finnest-opin). Required; never inferred. Valores: ofb, opin.
  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --environment <environment> — Target environment: sandbox or prod.
  • --config <path> — Path to an explicit Finnest TOML configuration file.
  • --config-only <path> — Load only this Finnest TOML file; do not merge ambient user or project config.
  • --config-overlay <path> — Overlay this Finnest TOML file over operator and project config.
  • --log-level <level> — Diagnostic verbosity: error, warn, info, debug, or trace.
  • --plain — Force headless output even on an interactive TTY.
  • --verbose — Enable debug-level diagnostics.

As opções globais de saída também se aplicam.

finnest dcr exchanges ​

List the redacted DCR HTTP exchanges with an authorisation server.

List the HTTP exchanges the receiver of --ecosystem (ofb or opin) made with the transmissora of an authorisation server (registration POST, compensation and removal DELETE), newest first: one line per exchange with its time, method, answer status, operation/purpose and attempt. --verbose adds the redacted request and answer headers and bodies; --json prints the page as the receiver serves it. Pages hold 1-100 exchanges (default 20); a page that has more prints the --before cursor of the next one.

Argumentos ​

  • <authorisation-server-id> — Directory Authorisation Server UUID.

Opções ​

  • --ecosystem <ecosystem> — DCR operations: the ecosystem whose receiver and Keycloak realm to reach, ofb (banking, finnest-ofb) or opin (insurance, finnest-opin). Required; never inferred. Valores: ofb, opin.
  • --limit <n> — Most records to return: interaction trail 1-500 (default 100); MOP status calls 1-500 (default 50); PCM batches 1-100 (default 20); PCM batch reports 1-1000 (default 100); PCM lookup by consent or connection 1-1000 per list (default 200); DCR exchanges 1-100 (default 20); sync log lines 1-1000 (default 200, the newest kept).
  • --before <exchange-id> — DCR exchanges: list the exchanges recorded before this exchange id (the next-page cursor a page prints).
  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --environment <environment> — Target environment: sandbox or prod.
  • --config <path> — Path to an explicit Finnest TOML configuration file.
  • --config-only <path> — Load only this Finnest TOML file; do not merge ambient user or project config.
  • --config-overlay <path> — Overlay this Finnest TOML file over operator and project config.
  • --log-level <level> — Diagnostic verbosity: error, warn, info, debug, or trace.
  • --plain — Force headless output even on an interactive TTY.
  • --verbose — Enable debug-level diagnostics.

As opções globais de saída também se aplicam.

finnest dcr reconcile ​

Delete one exact OFB or OPIN registration attempt after provider confirmation.

Argumentos ​

  • <authorisation-server-id> — Directory Authorisation Server UUID.
  • <attempt-id> — Exact attempt UUID returned by registration-status.
  • <resolution> — Provider-confirmed disposition of the registration (not-created applies only to a pending attempt). Valores: provider_confirmed_not_created, provider_confirmed_deleted.

Opções ​

  • --ecosystem <ecosystem> — DCR operations: the ecosystem whose receiver and Keycloak realm to reach, ofb (banking, finnest-ofb) or opin (insurance, finnest-opin). Required; never inferred. Valores: ofb, opin.
  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --environment <environment> — Target environment: sandbox or prod.
  • --evidence-reference <reference> — Provider ticket or retained evidence reference for exact-attempt reconciliation.
  • --yes — Approve a mutating operation.
  • --config <path> — Path to an explicit Finnest TOML configuration file.
  • --config-only <path> — Load only this Finnest TOML file; do not merge ambient user or project config.
  • --config-overlay <path> — Overlay this Finnest TOML file over operator and project config.
  • --log-level <level> — Diagnostic verbosity: error, warn, info, debug, or trace.
  • --plain — Force headless output even on an interactive TTY.
  • --verbose — Enable debug-level diagnostics.

As opções globais de saída também se aplicam.

Finnest Power — plataforma Open Finance Brasil e Open Insurance Brasil. Contato: oi@finnest.com.br