Skip to content

finnest opin ​

Read and operate OPIN readiness (the default, opin status), Directory, conformance, receiver trail, consents, connections, PCM, MOP, retention and compliance watch; verify runs mTLS acceptance.

Grupo: Diagnóstico e suporte · Nível: secundário

Uso ​

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

Sem subcomando, executa finnest opin status.

Exemplos ​

bash
finnest opin status
finnest opin status --json
finnest opin verify
finnest opin verify --allow-skip
finnest opin verify --brcac-cert ./brcac.pem --brcac-key ./brcac.key --ssa-file ./ssa.jwt
finnest opin verify --org-id ORG --as-id AS --directory-client-id CLIENT --brcac-cert ./brcac.pem --brcac-key ./brcac.key
finnest opin conformance --emit-plan
finnest opin conformance --emit-plan --auth-method tls_client_auth --out ./conformance-plan.json
finnest opin conformance rp --suite-token-env OIDF_SUITE_TOKEN --modules static
finnest opin interactions --interaction-id 5b8e2c1a-4f3d-4e9a-8b7c-1d2e3f4a5b6c
finnest opin consents
finnest opin consents sweep --yes
finnest opin pcm status
finnest opin retention
finnest opin compliance-watch run --yes

Opções ​

  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --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.
  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --as-id <id> — Directory Authorisation Server id used to check the registered AS record.
  • --software-id <id> — Directory software statement id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --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.
  • --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.

Subcomandos ​

  • verify — Run an active mTLS registration probe; acceptance requires successful cleanup.
  • conformance — Emit the OIDF test-plan config (--emit-plan), or run the official RP plan against the receiver (rp).
  • status — Read-only readiness board; DCR acceptance requires an explicit opin verify run.
  • interactions — Read the receiver x-fapi-interaction-id trail: which id each call to a transmitter sent and what came back.
  • consents — Read the receiver consent lifecycle (pending revocations, anomalies, last sweep), or run its sweep now (sweep --yes).
  • directory — OPIN Directory introspection over your BRCAC (link / diff / certs), or refresh the deployed receiver now (run --yes) and see how its last refresh ended (status).
  • pcm — Read and operate the receiver OPIN PCM reporting: status, batches, batch, preview, lookup, doctor, config, approve, resend.
  • retention — Read the OPIN regulatory retention status (Res. CNSP 415/2021, art. 46): records, open connections and next expiry per class.
  • connection — Read one receiver connection's sync status: the last sync's verdict, its stored failure, who started the authorization and the latest lifecycle events.
  • mop — Read the participant's OPIN MOP reporting: flags, gateway health, outbox and each call's MOP events.
  • compliance-watch — Run the daily OPIN compliance watch now (run --yes).
  • receiver — Walk the OPIN receiver journey of a target (smoke): a dry run by default, real reads with --live.
  • logs — Read the receiver sync's diagnostic log lines (refused pages, failed families, refused reads) through the target's Grafana.

finnest opin verify ​

Run an active mTLS registration probe; acceptance requires successful cleanup.

Run the OPIN acceptance ladder: build the sanitized provider-DCR target report (must show zero warnings), then probe DCR registration over mTLS when BRCAC + SSA material is provided, then — when Directory coordinates are given (--org-id/--as-id/--brcac-cert/--brcac-key) — confirm the registered Directory Authorisation Server record still points at the deployed realm with DCR enabled. Without material the probe is reported as skipped — pass --allow-skip to accept that explicitly; 201 requires confirmed DCM cleanup to pass; 409 leaves acceptance unverified and requires reconciliation before retrying.

Opções ​

  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --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.
  • --ssa-file <path> — Path to a compact SSA JWT file (dcr ssa-summary, or the opin verify DCR probe).
  • --ssa-env <name> — Automation compatibility: name of an existing environment variable holding the compact SSA JWT; operators should use --ssa-file or dcr fetch-ssa.
  • --ca-bundle <path> — Optional CA bundle PEM override; Directory commands otherwise use the configured ICP-Brasil trust material.
  • --allow-skip — Accept a skipped DCR probe (no BRCAC/SSA material) as a passing opin verify.
  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --as-id <id> — Directory Authorisation Server id used to check the registered AS record.
  • --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.
  • --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 opin conformance ​

Emit the OIDF test-plan config (--emit-plan), or run the official RP plan against the receiver (rp).

--emit-plan emits the transmitter test-plan config prefilled from live discovery. rp creates a new plan on the hosted OIDF suite (fapi1-advanced-final-client-test-plan, OPIN variant) and drives every selected module headlessly against the receiver's conformance companion (/insurance/conformance, inside the real receiver's process): it seeds each module as an authorisation server, opens a connection with a synthetic holder CPF, and completes the redirect. A sandbox receiver runs every selected module; a production receiver runs the static modules only and reports each selected dynamic (brazildcr) module as skipped with its reason, never as passed, because dynamic DCR needs a sandbox Directory SSA. The receiver bearer is minted per module from the finnest-opin-conformance client with the opin:receiver:conformance scope; the suite API token is read from the variable --suite-token-env names and is never written. Each run writes the suite result, the allowlisted log projection of each module, and the receiver failures and rows it created to the run evidence; raw suite logs are never written. As each module finishes, its OIDF certification client log (client-data/<test>.log) is written from the receiver's own conformance trail, and the run archives them into the .zip that the suite asks for in "Publish for certification". rp exits 0 only when every module it runs passes strictly (suite PASSED, no log findings, the receiver evidence present, and no receiver failure) and every client log is complete.

Argumentos ​

  • [action] — rp: run the official OIDF RP plan against the receiver's conformance companion. Valores: rp.

Exemplos ​

bash
finnest opin conformance --emit-plan
finnest opin conformance rp --suite-token-env OIDF_SUITE_TOKEN
finnest opin conformance rp --suite-token-env OIDF_SUITE_TOKEN --modules static
finnest opin conformance rp --environment prod --suite-token-env OIDF_SUITE_TOKEN
finnest opin conformance rp --suite-token-env OIDF_SUITE_TOKEN --modules fapi1-advanced-final-client-brazildcr-happypath-test --json

Opções ​

  • --emit-plan — Emit the OPIN conformance suite test-plan config prefilled from live discovery.
  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --auth-method <method> — Token-endpoint auth method for the emitted conformance variant (default private_key_jwt). Valores: private_key_jwt, tls_client_auth.
  • --out <path> — Write the command output to this file (created with 0600 permissions).
  • --suite-token-env <name> — Name of the environment variable holding the conformance suite API token (created in the suite UI; never written to disk).
  • --modules <selection> — RP plan modules to run: static, dynamic, or comma-separated module names (default: every module).
  • --stdin — Read secret material (secrets write) or the holder CPF (opin conformance rp, opin and ofb receiver smoke --create-connection, ofb initiator smoke --create-payment) from piped stdin, never from argv.
  • --directory-client-id <id> — Directory Software Statement ClientId used to obtain the Directory token.
  • --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 opin status ​

Read-only readiness board; DCR acceptance requires an explicit opin verify run.

Opções ​

  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --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.
  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --as-id <id> — Directory Authorisation Server id used to check the registered AS record.
  • --software-id <id> — Directory software statement id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --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.
  • --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 opin interactions ​

Read the receiver x-fapi-interaction-id trail: which id each call to a transmitter sent and what came back.

Reads the receiver trail of calls to transmitter OPIN APIs (consents, resources, data) with the dedicated finnest-opin-dcr-operator client, requesting only the opin:interactions:read scope. Select by --interaction-id, --consent-id or --connection-id (at most one), or list every call in the window. The window defaults to the 24 hours before now and spans at most 31 days. Text and --json both show the endpoint template, the answer and the ids sent and returned, never the called URL or the consent. Read-only.

Exemplos ​

bash
finnest opin interactions --interaction-id 5b8e2c1a-4f3d-4e9a-8b7c-1d2e3f4a5b6c
finnest opin interactions --consent-id urn:transmissora:00000000-0000-4000-8000-000000000001 --from 2026-09-01T00:00:00Z --to 2026-09-26T00:00:00Z
finnest opin interactions --from 2026-09-25T00:00:00Z --json

Opções ​

  • --interaction-id <id> — The x-fapi-interaction-id a counterparty asked about (interaction trail, PCM report lookup, MOP status).
  • --consent-id <urn> — Interaction trail, PCM report lookup and MOP status: every recorded call of this consent (URN); never echoed by the PCM lookup or the MOP status.
  • --connection-id <uuid> — Interaction trail, PCM report lookup and MOP status: every recorded call of this receiver connection; opin logs sync: only the sync log lines of this connection.
  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --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).
  • --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 opin consents ​

Read the receiver consent lifecycle (pending revocations, anomalies, last sweep), or run its sweep now (sweep --yes).

Without an action, reads the receiver consent lifecycle summary with the dedicated finnest-opin-dcr-operator client, requesting only the opin:consent-lifecycle:read scope: connections per status, consents expiring within 7 days, revocations the transmitter has not confirmed (overdue after 1 hour), consents handed to the operator after an unexpected transmitter answer, and the last sweep run with what it expired, revoked and detected at the transmitters. It flags three alerts: an overdue revocation, an anomaly, and a sweep that has not run for more than 3 schedules (15 minutes) or never ran. sweep calls the same receiver route the scheduled sweep uses, requesting only the opin:consent-lifecycle:run scope: it expires consents past their validity, closes consents never authorised, retries revocations the transmitter did not confirm, and reads live consents at the transmitter to detect revocations made there. It changes receiver state and calls transmitters, so it requires --yes; it waits up to 5 minutes, and cancelling it stops the sweep before its next consent. A consent is named by its transmitter and the tail of its id only; no output carries a customer CPF, CNPJ or name.

Argumentos ​

  • [action] — sweep: run the receiver consent lifecycle sweep now (requires --yes) and print its totals. Valores: sweep.

Exemplos ​

bash
finnest opin consents
finnest opin consents --json
finnest opin consents sweep --yes
finnest opin consents sweep --yes --json

Opções ​

  • --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.
  • --yes — Approve a mutating operation.

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

finnest opin directory ​

OPIN Directory introspection over your BRCAC (link / diff / certs), or refresh the deployed receiver now (run --yes) and see how its last refresh ended (status).

Introspect the OPIN Directory with the customer's BRCAC over mTLS plus a directory:software bearer (no Finnest control plane). link auto-fills the per-tenant [opin] org/AS/software ids into finnest.toml; diff catches AS-record drift vs the deployed issuer; certs is the certificate expiry radar. The sandbox Directory host comes from the resolved context; override with --directory-base. run starts the deployed receiver's Directory refresh now: the refresh runs every six hours in the cluster as a CronJob (and once at each deploy that changes it), syncing the Directory's participants into the receiver's transmitter catalog. run creates one Job from that CronJob, as kubectl create job --from=cronjob/finnest-runtime-opin-directory-refresh would, through the cluster credentials derived from the target, after confirming the cluster API server answers (a paused or unreachable cluster is refused before anything is sent). It changes the cluster, so it requires --yes. The Job is named after the current minute, so repeating the command within the same minute reports the run already started instead of starting a second one. The command returns once the Job exists; it does not wait for the refresh. status is read-only: through the same target-derived credentials and API-server check, it shows the most recent refresh, whichever started it (the schedule, run, or the deploy's first load): its Job, when it started and finished, and whether it is running, succeeded or failed; a failed one names the reason its log states, such as where the Directory document left its schema. With --live, status also reads the public participants list of the Directory the target's environment follows (prod: the production Directory, data.directory.opinbrasil.com.br) and lists the transmitters a receiver can connect to; without it no request reaches the Directory and the report says so.

Exemplos ​

bash
finnest opin directory link --directory-client-id CLIENT --brcac-cert ./brcac.pem --brcac-key ./brcac.key
finnest opin directory link --org-id ORG --as-id AS --software-id SS --directory-client-id CLIENT --brcac-cert ./brcac.pem --brcac-key ./brcac.key
finnest opin directory diff --directory-client-id CLIENT --brcac-cert ./brcac.pem --brcac-key ./brcac.key
finnest opin directory certs --json --directory-client-id CLIENT --brcac-cert ./brcac.pem --brcac-key ./brcac.key
finnest opin directory run --yes
finnest opin directory run --cloud=aws --environment=prod --yes --json
finnest opin directory status
finnest opin directory status --cloud=aws --environment=prod --json

Opções ​

  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --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.
  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --as-id <id> — Directory Authorisation Server id used to check the registered AS record.
  • --software-id <id> — Directory software statement id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --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.
  • --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.

Auto-fill the [opin] org/AS/software ids into finnest.toml (read-only Directory GET).

Opções ​

  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --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.
  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --as-id <id> — Directory Authorisation Server id used to check the registered AS record.
  • --software-id <id> — Directory software statement id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --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.
  • --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 opin directory diff ​

Compare the registered AS record vs the deployed issuer; non-zero on drift.

Opções ​

  • --auth-base <url> — Authorization server base URL (the non-mTLS host, or a local port-forward to it) the command reaches the realm through.
  • --matls-auth-base <url> — Regulated mTLS authorization host base URL (matls-auth.<domain>).
  • --realm <realm> — Authorization realm for the OPIN target report (default finnest-opin).
  • --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.
  • --org-id <id> — Directory organisation id (selects the Directory records; dcr fetch-ssa also builds the SSA path from it).
  • --as-id <id> — Directory Authorisation Server id used to check the registered AS record.
  • --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.
  • --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 opin directory certs ​

Certificate expiry radar; non-zero if any Active cert is expired, warn ≤30d.

Opções ​

  • --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.
  • --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).
  • --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.
  • --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 opin directory run ​

Create one Directory-refresh Job from the deployed receiver's CronJob now; requires --yes.

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --yes — Approve a mutating operation.
  • --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 opin directory status ​

Show the deployed receiver's most recent Directory refresh: its Job, times and outcome, and why it failed; with --live, also the target Directory's transmitters.

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --live — Make the real reads (Directory participants, cluster, deployed routes); without it nothing leaves the process.
  • --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 opin pcm ​

Read and operate the receiver OPIN PCM reporting: status, batches, batch, preview, lookup, doctor, config, approve, resend.

Reads and operates the OPIN PCM (Plataforma de Coleta de Métricas) reporting of the deployed receiver with the dedicated finnest-opin-dcr-operator client: reads request only opin:pcm:read; approve, resend and config --mode/--interval request only opin:pcm:operate, need --yes, and record the person named by --operator. Every surface says when real sending is off (FINNEST_OPIN_PCM_LIVE=off): the reports are then built and signed but never reach the PCM.

Exemplos ​

bash
finnest opin pcm status
finnest opin pcm batches --status failed
finnest opin pcm batch 0192f3a4-7c1e-7b20-9d4e-3f1a2b6c8d90 --state discarded
finnest opin pcm approve 0192f3a4-7c1e-7b20-9d4e-3f1a2b6c8d90 --operator ops@example.com --yes
finnest opin pcm resend 0192f3a4-7c1e-7b20-9d4e-3f1a2b6c8d90 --operator ops@example.com --yes
finnest opin pcm config --mode manual --interval 15 --operator ops@example.com --yes
finnest opin pcm lookup --interaction-id 5b8e2c1a-4f3d-4e9a-8b7c-1d2e3f4a5b6c
finnest opin pcm lookup --connection-id 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f --from 2026-09-01T00:00:00Z --to 2026-09-08T00:00:00Z
finnest opin pcm preview
finnest opin pcm doctor

Opções ​

  • --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 opin pcm status ​

Real sending on/off (and, when off, what the first live cycle would send), mode, today, last daily close, misses, batches and PCM pendencies.

Opções ​

  • --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 opin pcm batches ​

List the PCM batches, newest first, optionally in one status.

Opções ​

  • --status <status> — PCM batches: list only the batches in this status (default: every status). Valores: draft, awaiting_approval, posting, submitted, partially_discarded, failed, submit_unconfirmed.
  • --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).
  • --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 opin pcm batch ​

One batch: header, PCM receipts and POST attempts, discards grouped by sanitized message, and a page of its reports.

Reads one OPIN PCM batch of the deployed receiver: its header as opin pcm batches shows it (lane, status, events, window, created, approved by and at), the PCM receipts and the POST attempts (counts, statuses and instants only), the reports the PCM discarded grouped by the message the receiver sanitized, and one page of its reports, newest first (--state to filter, --limit 1-500, default 100; --cursor for the next page, which the page prints). An unknown batch is OPIN_PCM_BATCH_NOT_FOUND. Read-only.

Argumentos ​

  • <batch-id> — The batch UUID, as opin pcm status or opin pcm batches lists it.

Opções ​

  • --state <state> — PCM batch: list only the reports in this state (default: every state). Valores: discarded, invalid, accepted, batched.
  • --cursor <cursor> — PCM batch: list the reports after this cursor (the next-page cursor a page prints).
  • --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).
  • --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 opin pcm approve ​

Approve one batch awaiting approval; the receiver posts it to the PCM.

Argumentos ​

  • <batch-id> — The batch UUID, as opin pcm status or opin pcm batches lists it.

Opções ​

  • --operator <email> — Email of the person approving, resending or editing PCM reporting; the receiver records it.
  • --yes — Approve a mutating operation.
  • --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 opin pcm resend ​

Post one failed or unconfirmed batch to the PCM again (180-day window).

Argumentos ​

  • <batch-id> — The batch UUID, as opin pcm status or opin pcm batches lists it.

Opções ​

  • --operator <email> — Email of the person approving, resending or editing PCM reporting; the receiver records it.
  • --yes — Approve a mutating operation.
  • --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 opin pcm config ​

Show the submission settings, or replace them with --mode and --interval.

Opções ​

  • --mode <mode> — PCM settings: automatic posts batches on their own; manual waits for opin pcm approve. Valores: automatic, manual.
  • --interval <minutes> — PCM settings: minutes between submitter passes, 1-1440 (pass with --mode).
  • --operator <email> — Email of the person approving, resending or editing PCM reporting; the receiver records it.
  • --yes — Approve a mutating operation.
  • --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 opin pcm lookup ​

Where the calls of one x-fapi-interaction-id, consent or connection stand in the PCM reporting.

Takes exactly one of --interaction-id, --consent-id or --connection-id. By interaction id it shows the receiver's calls sent or answered with that id. By consent or connection it shows, for the window [--from, --to) (default the 24 hours before --to, which defaults to now; at most 31 days), the receiver's own calls (client side) and the consent-funnel steps of the consent's connections or of the connection, each list newest first and cut at --limit (1-500, default 200). The consent and the connection are matched by the receiver and never echoed. Read-only.

Opções ​

  • --interaction-id <id> — The x-fapi-interaction-id a counterparty asked about (interaction trail, PCM report lookup, MOP status).
  • --consent-id <urn> — Interaction trail, PCM report lookup and MOP status: every recorded call of this consent (URN); never echoed by the PCM lookup or the MOP status.
  • --connection-id <uuid> — Interaction trail, PCM report lookup and MOP status: every recorded call of this receiver connection; opin logs sync: only the sync log lines of this connection.
  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --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).
  • --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 opin pcm preview ​

What the next submitter cycle would send, per lane: pending, valid, refused and why.

Previews the next OPIN PCM submitter cycle on the deployed receiver without claiming, signing or sending anything: per lane (transactional, consent-funnel), the valid reports pending inside the 180-day cutoff, which the next live cycle drains, and its first page (at most 5,000 reports) built as the run builds it, with counts per endpoint or funnel step and HTTP class and the refused reports grouped by reason. Works with real sending off (what the first live cycle would send) or on. Read-only.

Opções ​

  • --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 opin pcm doctor ​

Compare the configured, deployed and organisation-keystore signing kid; warn if sending is off.

Compares three views of the kid OPIN PCM reports are signed with: the active target's opin_pcm_signing_kid, the deployed service's signing identity (kid and certificate digest), and the organisation's public JWKS in the OPIN Directory keystore (org_jwks_uri, no Directory session). The kid must be an active signing key (use "sig"), absent from the inactive JWKS, and its x5c certificate must be the one the service uses; the verdict is org-level, inactive, absent, certificate-mismatch or keystore-unreachable. Warns when real sending is off. Read-only.

Opções ​

  • --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 opin retention ​

Read the OPIN regulatory retention status (Res. CNSP 415/2021, art. 46): records, open connections and next expiry per class.

Reads the regulatory retention status of the deployed participant, whatever its role (Res. CNSP 415/2021, art. 46), with the dedicated finnest-opin-dcr-operator client, requesting only the opin:retention:read scope. For each retained record class (the consent lifecycle and the x-fapi-interaction-id trail, as receiver and as transmitter) it shows the legal basis, the record count with the oldest and newest record, the connections or served consents still open (their records are held until they close), the closed ones, and when the earliest record of a closed connection reaches the end of the retention term. Read-only: nothing is changed or deleted. No output carries a customer CPF, CNPJ or name. verify asks the insurance service, with the same scope, to verify its immutable archive: every sealed day (or the UTC days --from YYYY-MM-DD through --to YYYY-MM-DD) has its manifest and class files present with the SHA-256 the seal ledger recorded, each manifest links to the previous sealed day, every object is retained for the configured lock period (immutably in production), and the source tables still hold the sealed number of records. An intact archive exits 0; any finding fails the command (OPIN_RETENTION_ARCHIVE_DIVERGENT) with the full report in the run evidence (.finnest/runs). It waits up to 5 minutes. hold lists the legal holds (Circ. SUSEP 605/2020, art. 3º, §§ 2º and 3º) with opin:retention:read; hold place suspends the retention term of every record (--tenant) or of the receiver records of one connection (--connection UUID) while a sanctioning proceeding at Susep, a judicial proceeding or another legal cause interrupting prescription runs, or once the liquidation of the participant is decreed (--basis), naming the redacted proceeding number (--reference, never a CPF, CNPJ or e-mail); hold release HOLD-ID records the end of that proceeding. Placing and releasing request only opin:retention:hold and require --yes.

Argumentos ​

  • [action] — status (the default): read the regulatory retention status. verify: verify the sealed regulatory archive (optionally --from DAY --to DAY). hold: list, place or release legal holds. Valores: status, verify, hold.
  • [hold-action] — With hold: list (the default) the legal holds; place one (--tenant or --connection, --basis, --reference, --yes); release one (<hold-id>, --yes). Valores: list, place, release.
  • [hold-id] — With hold release: the legal hold UUID, as opin retention hold lists it.

Exemplos ​

bash
finnest opin retention
finnest opin retention --json
finnest opin retention verify
finnest opin retention verify --from 2026-09-01 --to 2026-09-30 --json
finnest opin retention hold
finnest opin retention hold place --connection 3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b --basis judicial-proceeding --reference "Processo 0001234-**.2026.8.26.0100" --yes
finnest opin retention hold place --tenant --basis sanctioning-proceeding --reference "PAS 15414.000***/2026" --yes
finnest opin retention hold release 0192f3a4-7c1e-7b20-9d4e-3f1a2b6c8d90 --yes

Opções ​

  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --tenant — Legal hold: suspend the retention term of every record of the receiver (instead of --connection).
  • --connection <uuid> — Legal hold: suspend the retention term of this receiver connection only.
  • --basis <basis> — Legal hold: why the term is suspended (Circ. SUSEP 605/2020, art. 3º): sanctioning-proceeding (Susep), judicial-proceeding, prescription-interruption (another legal cause interrupting prescription) or liquidation (of the participant).
  • --reference <text> — Legal hold: the redacted proceeding number (letters, digits and case-number separators; no CPF, CNPJ or e-mail).
  • --yes — Approve a mutating operation.
  • --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 opin connection ​

Read one receiver connection's sync status: the last sync's verdict, its stored failure, who started the authorization and the latest lifecycle events.

Reads the sync status of one connection of the deployed receiver with the dedicated finnest-opin-dcr-operator client, requesting only the opin:connections:status:read scope. It shows the connection status, the last sync's verdict (completo, parcial with the product families it could not read, sync_failed, sync_stalled, or nunca sincronizou), when the connection last synced, the error code it stored and whether the transmitter refused the access, each unread family with its reason, who started the authorization (the operator or the holder's own link) and the 10 latest lifecycle events (event, when, kind of actor). A stored detail or reason is shown only in the closed grammar the receiver writes it in; any other text reads as [detalhe omitido: formato não reconhecido]. Neither text nor --json carries the connection id, the consent, the holder, product data, a link or a token. A connection the receiver does not hold and one this operator may not read are the same OPIN_CONNECTION_NOT_FOUND. A token without the scope is OPIN_CONNECTION_SCOPE_DENIED: run finnest deploy so the realm grants it. Read-only.

Argumentos ​

  • <connection-id> — The receiver connection UUID, as opin interactions or opin consents names it. Never echoed.

Exemplos ​

bash
finnest opin connection 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f
finnest opin connection 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f --json

Opções ​

  • --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 opin mop ​

Read the participant's OPIN MOP reporting: flags, gateway health, outbox and each call's MOP events.

Reads the OPIN MOP (Módulo de Operações OPIN) reporting of the deployed participant with the dedicated finnest-opin-dcr-operator client, requesting only the opin:interactions:read scope. It shows the effective flags (MOP on, real receiver, role, the client and server sides reported, a gateway configured), the MOP Client gateway's health (UP, DOWN, unreachable), the outbox of the last 24 hours by state with the age of the oldest event still owed to the gateway, and the calls of the trail with their Request and Response events: state, attempts out of 10, next attempt, last failure, and the gateway's verdict and violation count. queued means accepted by the gateway (202); Finnest does not confirm the final delivery to the MOP, and the gateway's own queue and DLQ are outside this view. Select by --interaction-id, --consent-id or --connection-id (at most one) or read every call in the window [--from, --to) (default the 24 hours before --to, which defaults to now; at most 31 days), cut at --limit (1-500, default 50). --connection-id covers the client side only, and --consent-id does not find the server-side consent creation (POST /consents). The consent and the connection are matched by the receiver and never echoed; neither text nor --json carries a report, its headers, a called URL, a consent, a resource id or a software statement id. Read-only.

Exemplos ​

bash
finnest opin mop status
finnest opin mop status --consent-id urn:transmissora:0d2b8c7e-1f3a-4b5c-9d6e-7f8a9b0c1d2e
finnest opin mop status --connection-id 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f --from 2026-09-01T00:00:00Z --to 2026-09-08T00:00:00Z
finnest opin mop status --json

Opções ​

  • --interaction-id <id> — The x-fapi-interaction-id a counterparty asked about (interaction trail, PCM report lookup, MOP status).
  • --consent-id <urn> — Interaction trail, PCM report lookup and MOP status: every recorded call of this consent (URN); never echoed by the PCM lookup or the MOP status.
  • --connection-id <uuid> — Interaction trail, PCM report lookup and MOP status: every recorded call of this receiver connection; opin logs sync: only the sync log lines of this connection.
  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --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).
  • --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 opin mop status ​

The MOP flags, the gateway's health, the outbox of 24 hours and the MOP events of the selected calls.

Reads the OPIN MOP (Módulo de Operações OPIN) reporting of the deployed participant with the dedicated finnest-opin-dcr-operator client, requesting only the opin:interactions:read scope. It shows the effective flags (MOP on, real receiver, role, the client and server sides reported, a gateway configured), the MOP Client gateway's health (UP, DOWN, unreachable), the outbox of the last 24 hours by state with the age of the oldest event still owed to the gateway, and the calls of the trail with their Request and Response events: state, attempts out of 10, next attempt, last failure, and the gateway's verdict and violation count. queued means accepted by the gateway (202); Finnest does not confirm the final delivery to the MOP, and the gateway's own queue and DLQ are outside this view. Select by --interaction-id, --consent-id or --connection-id (at most one) or read every call in the window [--from, --to) (default the 24 hours before --to, which defaults to now; at most 31 days), cut at --limit (1-500, default 50). --connection-id covers the client side only, and --consent-id does not find the server-side consent creation (POST /consents). The consent and the connection are matched by the receiver and never echoed; neither text nor --json carries a report, its headers, a called URL, a consent, a resource id or a software statement id. Read-only.

Opções ​

  • --interaction-id <id> — The x-fapi-interaction-id a counterparty asked about (interaction trail, PCM report lookup, MOP status).
  • --consent-id <urn> — Interaction trail, PCM report lookup and MOP status: every recorded call of this consent (URN); never echoed by the PCM lookup or the MOP status.
  • --connection-id <uuid> — Interaction trail, PCM report lookup and MOP status: every recorded call of this receiver connection; opin logs sync: only the sync log lines of this connection.
  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --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).
  • --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 opin compliance-watch ​

Run the daily OPIN compliance watch now (run --yes).

The compliance watch runs daily in the deployed cluster as a CronJob: it reads the public material of the participant (served certificates, public hosts, the Directory keystore and participants list) and records its findings. run starts it now by creating one Job from that CronJob, as kubectl create job --from=cronjob/finnest-runtime-compliance-watch would, through the cluster credentials derived from the target, after confirming the cluster API server answers (a paused or unreachable cluster is refused before anything is sent). It changes the cluster, so it requires --yes. The Job is named after the current minute, so repeating the command within the same minute reports the run already started instead of starting a second one. The command returns once the Job exists; it does not wait for the run.

Exemplos ​

bash
finnest opin compliance-watch run --yes
finnest opin compliance-watch run --cloud=aws --environment=prod --yes --json

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --yes — Approve a mutating operation.
  • --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 opin compliance-watch run ​

Create one compliance-watch Job from its CronJob now; requires --yes.

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --yes — Approve a mutating operation.
  • --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 opin receiver ​

Walk the OPIN receiver journey of a target (smoke): a dry run by default, real reads with --live.

smoke walks the receiver journey of the selected target in order: the participants list of the Directory its environment follows (prod: the production Directory), the last Directory refresh in its cluster, the receiver redirect_uri (it must end with /callback) and the callback's public result page, then the DCR at a transmitter and the POST /connections the receiver would make. It drives only the real receiver's routes (traffic real), never the /insurance/conformance companion. Without --live nothing leaves the process: every step is shown as planned. --live makes the three reads and still writes nothing. --create-connection makes the one real write: the receiver creates a connection owned by the finnest-opin-dcr-operator client, with a real DCR and a real consent at the --transmitter server, for the holder whose CPF is piped to --stdin (never argv; it is never printed or logged). It needs --live, --transmitter, --stdin and --yes, never runs in CI, and prints the URL where the holder authorises the consent. Its request carries a random x-idempotency-key; a refused create prints it, and re-running with the same CPF and --idempotency-key <uuid> makes the receiver replay a connection it already created instead of creating a second one.

Exemplos ​

bash
finnest opin receiver smoke --cloud=aws --environment=prod
finnest opin receiver smoke --cloud=aws --environment=prod --live
printf '%s' "$HOLDER_CPF" | finnest opin receiver smoke --cloud=aws --environment=prod --live --create-connection --stdin --transmitter <authorisation-server-id> --yes

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --live — Make the real reads (Directory participants, cluster, deployed routes); without it nothing leaves the process.
  • --create-connection — Receiver smoke (opin, ofb): create one real connection (consent at the transmitter) with the holder CPF from --stdin; requires --live, --transmitter and --yes.
  • --transmitter <authorisation-server-id> — Receiver or initiator smoke: the Directory authorisation server id of the transmitter.
  • --idempotency-key <uuid> — Receiver or initiator smoke: the UUID the write (--create-connection or --create-payment) carries as x-idempotency-key; reuse the one a refused write printed, so it is replayed instead of made a second time.
  • --stdin — Read secret material (secrets write) or the holder CPF (opin conformance rp, opin and ofb receiver smoke --create-connection, ofb initiator smoke --create-payment) from piped stdin, never from argv.
  • --yes — Approve a mutating operation.
  • --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 opin receiver smoke ​

Walk the receiver journey: dry run by default, real reads with --live, one real connection with --create-connection.

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --live — Make the real reads (Directory participants, cluster, deployed routes); without it nothing leaves the process.
  • --create-connection — Receiver smoke (opin, ofb): create one real connection (consent at the transmitter) with the holder CPF from --stdin; requires --live, --transmitter and --yes.
  • --transmitter <authorisation-server-id> — Receiver or initiator smoke: the Directory authorisation server id of the transmitter.
  • --idempotency-key <uuid> — Receiver or initiator smoke: the UUID the write (--create-connection or --create-payment) carries as x-idempotency-key; reuse the one a refused write printed, so it is replayed instead of made a second time.
  • --stdin — Read secret material (secrets write) or the holder CPF (opin conformance rp, opin and ofb receiver smoke --create-connection, ofb initiator smoke --create-payment) from piped stdin, never from argv.
  • --yes — Approve a mutating operation.
  • --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 opin logs ​

Read the receiver sync's diagnostic log lines (refused pages, failed families, refused reads) through the target's Grafana.

sync reads the three diagnostic events the receiver sync writes, insurance.receiver.sync.page-invalid, insurance.receiver.sync.family.failed and insurance.receiver.sync.read-failed, from the target's bundled Grafana (grafana.<domain>) with a Viewer service-account token. The token is read from the private file FINNEST_GRAFANA_VIEWER_TOKEN_FILE names (default ~/.finnest/credentials/grafana-viewer-token), saved from the runtime's finnest-grafana-cli-viewer Secret; it is never a flag and never printed. The window defaults to the 24 hours before now, ends no later than now and spans at most 31 days; --connection-id, --event (repeatable) and --family narrow it, and --limit (1-1000, default 200) keeps the newest lines. Text and --json show only the fields each event is read by, each checked against the sync log vocabulary (a value that is not prints as redacted): never a page body, URL, log message, consent or document. A target whose Grafana is external or disabled is refused before any request; the README has the LogQL query to run there. Read-only.

Exemplos ​

bash
finnest opin logs sync --cloud=aws --environment=prod
finnest opin logs sync --cloud=aws --environment=prod --event page-invalid --family patrimonial --json
finnest opin logs sync --cloud=aws --environment=prod --connection-id 3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b --from 2026-11-18T00:00:00Z --to 2026-11-19T00:00:00Z

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --connection-id <uuid> — Interaction trail, PCM report lookup and MOP status: every recorded call of this receiver connection; opin logs sync: only the sync log lines of this connection.
  • --event <event> — opin logs sync: the sync log events to read, page-invalid, family-failed or read-failed; repeat it or separate with commas (default: all three).
  • --family <family> — opin logs sync: only the lines of this OPIN data family (patrimonial, auto, person, ...).
  • --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).
  • --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 opin logs sync ​

Read the receiver sync's page-invalid, family-failed and read-failed lines of a window, allowlisted fields only.

Opções ​

  • --cloud <cloud> — Target cloud for setup, deploy, and diagnostics.
  • --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.
  • --from <iso> — Window start, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: 24 hours before --to), a UTC day YYYY-MM-DD for opin retention verify (with --to).
  • --to <iso> — Window end, ISO 8601: an instant with its offset for opin interactions, opin mop status, opin pcm lookup by consent or connection and opin logs sync (default: now, at most 31 days after --from; opin logs sync: not later than now), a UTC day YYYY-MM-DD for opin retention verify (with --from).
  • --connection-id <uuid> — Interaction trail, PCM report lookup and MOP status: every recorded call of this receiver connection; opin logs sync: only the sync log lines of this connection.
  • --event <event> — opin logs sync: the sync log events to read, page-invalid, family-failed or read-failed; repeat it or separate with commas (default: all three).
  • --family <family> — opin logs sync: only the lines of this OPIN data family (patrimonial, auto, person, ...).
  • --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).
  • --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