> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paylead.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Consumer lifecycle

> Create a Consumer on the platform, set up transaction sharing, opt them in to Perks or Loyalty, and off-board them. The service-agnostic Consumer lifecycle.

A [Consumer](/glossary#consumer) is the anchor of your [Program](/glossary#program). Every [Reward](/glossary#reward), [Offer](/glossary#offer) eligibility check, and [Webhook](/glossary#webhooks) references one. This guide follows the lifecycle described in the [User journey](/program/user-journey/overview): the Consumer is created on the platform, transaction sharing is set up, and the Consumer opts in to one or both services.

## The Consumer lifecycle

<Steps>
  <Step title="Create on the platform">
    Create the Consumer with their `consumer_id`, the only required field. Service-agnostic: it registers the end user before any service opt-in.
  </Step>

  <Step title="Set up transaction sharing">
    Share the Consumer's transaction history (typically the last 12 months), then keep pushing new transactions.
  </Step>

  <Step title="Opt in to a service">
    Enroll the Consumer in [Perks](/glossary#perks), [Loyalty](/glossary#loyalty), or both. Each opt-in accepts that service's terms and unlocks it.
  </Step>

  <Step title="Add the Smart Ranking consent (Perks, optional)">
    On Perks, the Consumer can grant the `SMART_RANKING` consent to enable [Offer Smart Ranking](/glossary#offer-smart-ranking).
  </Step>

  <Step title="Assign Segments (Perks, optional)">
    On Perks, the Program Manager can assign one or more Segments to scope which Offers the Consumer sees.
  </Step>

  <Step title="Off-board">
    Deactivate the Consumer when they unsubscribe from all Paylead services.
  </Step>
</Steps>

***

## Create a Consumer on the platform

The Consumer ID you pass is the bank's internal identifier. Paylead reuses it across every downstream call (transactions, Rewards, Webhooks). Once chosen, it cannot be changed without a full off-board and re-onboard. It is also the identifier Paylead displays to represent the Consumer across all business units (support, marketing, technical).

Create the Consumer with [Onboard a consumer on Paylead platform](/program/api/thub/consumers/onboard-a-consumer-on-paylead-platform).

**Payload essentials**

* `id`: bank-internal Consumer ID. The only required field. Must be unique and stable across the Consumer's lifetime.
* `banks`: optional. The bank connections and accounts to link. One Consumer can hold several accounts under the same `id`, and accounts can be added later.

<Check>
  The Consumer exists on the platform and is ready to receive transactions.
</Check>

## Set up transaction sharing

Transactions are shared at the platform level and reused by whichever service the Consumer joins. Push the Consumer's history with [Create a bulk of historical transactions](/program/api/thub/bulk-transaction/create-a-bulk-of-historical-transactions), then keep them current with [Create a bulk of transactions](/program/api/thub/bulk-transaction/create-a-bulk-of-transactions).

<Note>
  Always call the historical endpoint, even when the Consumer has no history to share. With no past transactions, send an empty payload (`{ "banks": [] }`) to complete this step.
</Note>

For how Paylead ingests and matches transactions, see [Share transactions](/program/user-journey/concepts/transaction-lifecycle).

## Opt in to Perks

Enroll the Consumer in the Perks service with [Enroll a consumer into the perks program](/program/api/perks/consumers/enroll-a-consumer-into-the-perks-program-accept-cgu). Enrolling accepts the Program's terms and makes the Consumer eligible to match Offers. Enrollment marks the start of Reward eligibility on the Consumer's linked bank accounts.

<Note>
  Opting in is per service. A Consumer can be enrolled in Perks, Loyalty, or both. This guide covers the Perks-side operations; the Loyalty opt-in is covered in the [User journey](/program/user-journey/overview#the-loyalty-journey).
</Note>

## Smart Ranking consent (Perks, optional)

[Offer Smart Ranking](/glossary#offer-smart-ranking) personalizes the order of Offers from the Consumer's transaction data. It requires the Consumer's explicit `SMART_RANKING` consent.

Manage it through the Perks enrollment call: pass `SMART_RANKING` in `extra_consents` to grant it, and in `removed_consents` to withdraw it.

<Warning>
  **Capturing consent is the bank's responsibility.** Collect the Consumer's explicit choice in your own UI before sending it to Paylead. The Paylead call records the result; it does not replace your consent-capture flow under GDPR.
</Warning>

## Assign Segments (Perks, optional)

[Segments](/glossary#segment) let you expose Offers to a defined audience, set by your bank's own criteria, for example *Premium*, *New*, or *Gold*. A Consumer can belong to several Segments at once.

Segmentation is optional and managed by the Program Manager in [Shift](/glossary#shift) or through the API.

<Tip>
  Segment definitions are provisioned by your Paylead account manager after a compliance check on the criteria. The Program Manager then assigns Consumers to them in Shift or through the API. This keeps targeting rules under business control.
</Tip>

## Off-board a Consumer

Off-boarding stops Reward generation, revokes the Consumer's identifier, and locks their record. Use it when the Consumer leaves your Program, closes their bank account, or exercises their right to be forgotten under GDPR.

Off-board with [Offboard a consumer from Paylead platform](/program/api/thub/consumers/offboard-a-consumer-from-paylead-platform).

<Warning>
  Off-boarding is irreversible. Rewards already issued are preserved for accounting and [Ventilation](/glossary#ventilation), but no new Rewards are generated. To re-enroll the Consumer later, use a new `id`.
</Warning>

<Check>
  The Consumer is off-boarded. Reward generation stops. Existing Rewards in the Ventilation pipeline complete payout normally.
</Check>

## What's next

<CardGroup cols={2}>
  <Card title="The Offer catalog" icon="tags" href="/program/user-journey/guides/work-with-offers">
    Surface partner Brands and Offers to your onboarded Consumers.
  </Card>

  <Card title="Reward lifecycle" icon="refresh-cw" href="/program/user-journey/guides/reward-lifecycle">
    Track the Reward lifecycle and display statuses in your app.
  </Card>

  <Card title="Webhooks reference" icon="zap" href="/program/user-journey/concepts/webhooks">
    Subscribe to Consumer and Reward events for real-time updates.
  </Card>
</CardGroup>