Integrate with Lerian Consignado — Dataprev

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 lifecycle, portability, 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.

Event key	Runtime behavior
`consignado.margin.requested`	The consumer is always bound when the Dataprev and streaming runtime is enabled and reads worker margin. Current Lender `develop` has no production publisher for this command; use the authenticated HTTP margin operation unless your deployment provides one.
`consignado.redirecionamento.requested`	Executes when a redirection adapter is wired; otherwise returns a named refusal that can be replayed after configuration.
`consignado.exclusao.requested`	Uses the same idempotent exclusion service as the HTTP operation when the runtime is available; otherwise returns a named unavailability error.

Averbação is not a Lender command on develop. Submit it through the authenticated HTTP operation.

Declared and operational business facts

The runtime manifest declares 21 business facts, and all 21 have production emission sites on develop. consignado.portability_proposal.received is emitted when the scheduled portability-discovery poller finds a live M011 offer and atomically commits its durable marker with the streaming outbox envelope. 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), and disbursement
averbação, exclusion, and redirection 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.

​HTTP API

​Lender commands consumed

​Declared and operational business facts

​Application streams

​Delivery subscriptions

​Reliability contract