Skip to main content
Use the HTTP API for the complete client-facing Consignado surface. Use CloudEvents to consume immutable business facts and, when integrating through Lender, to send the supported commands. The two interfaces are complementary; the event stream is not the authority for every rail operation.

​
HTTP API

The API covers tenant credentials, margin and worker data, auctions and bids, registration, documents, disbursement, contract corrections, contract lifecycle, portability in both directions, refinancing, renegotiation, guarantees, reconciliation, funds, assignments, usage, throughput, and delivery subscriptions. Start with fetch worker margin, then use the API Reference navigation to find the remaining operation families. Each operation page is generated from the develop OpenAPI contract.

​
Lender commands consumed

The gateway reads one application command stream and dispatches by CloudEvent source and event key. Selection is by key, never by topic name, and a key the gateway does not handle is quarantined to its own dead-letter queue rather than skipped. Averbação is not a Lender command on develop. Submit it through the authenticated HTTP operation.

​
Declared and operational business facts

The runtime contract contains 25 business-fact definitions, and every one of them has a named production emission site on develop. There is no per-fact toggle: the published fact set is a projection of the runtime catalog, so a deployment either emits a fact or does not run the flow that produces it. What a deployment emits is gated by its configuration, never by the fact. Inbound portability discovery is off by default, so consignado.portability_proposal.received — committed atomically with its durable marker when the scheduled portability-discovery poller finds a live offer — appears only where that flow is enabled, and the same holds for any rail command a deployment does not run. The operational facts cover:
  • auction requests and inbound portability proposals
  • margin, employment, and absence reports
  • proposal acceptance, contract registration (consignado.contract.registered, including signed CCB artifact evidence), disbursement, and correction availability
  • averbação, exclusion, redirection, and origin-side portability outcomes
  • reconciliation, repasse exceptions, and calendars
  • funds, assignment, and throughput changes
See Consignado events for the full catalog and the exact CloudEvent resource/event mapping.

​
Application streams

With the lib-streaming v3 contract:
  • facts are produced to lerian.streaming.consignado-gw
  • Lender commands are consumed from lerian.streaming.lender.commands
  • fact types use studio.lerian.consignado-gw.<resource>.<event>
  • command types use studio.lerian.lender.<resource>.<event>
Route by CloudEvent source, resource type, and event type. Do not infer an event from a topic name alone.

​
Delivery subscriptions

Use the subscription API to register an HTTPS destination, inspect it, rotate its signing secret, test delivery, or revoke it. Treat the signing secret as write-only. A successful test proves delivery to the configured endpoint; it does not change the at-least-once semantics of business events.

​
Reliability contract

  • Business facts enter a transactional outbox before publication.
  • Delivery is at least once.
  • Deduplicate by (ce-source, ce-id).
  • Monetary values travel as decimal strings, never binary floating point.
  • Payload fields use snake_case; timestamps use UTC RFC 3339.
  • A missing required business identifier is terminal and goes to the consumer DLQ rather than to Dataprev.