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

# Activate Earn

> Activates earn for a user, so their balance starts generating yield. Earn must be enabled for your client.

#### Request

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Authorization | Header | Yes | `Bearer <access_token>` obtained from **POST /api/v1/client/token**. |
| user_id | Path | Yes | Identifier of the user. |

#### Response

| Field | Description |
| --- | --- |
| id | Identifier of the user's earn account. |
| status | Status of the account. |
| earnEnabled | Whether earn is active for the user. |
| accumulatedEarnings | Earnings accumulated so far, or `null`. |
| annualRateLabel | Annual rate shown to the user or `null`. |
| registerDate | Creation date of the account. |

#### Errors

| Status | When |
| --- | --- |
| 400 | Earn is not enabled for your client, or the user does not exist. |



## OpenAPI

````yaml /stack/openapi.json patch /api/v1/admin/earn/activate/{user_id}
openapi: 3.1.0
info:
  title: Kravata Stack API
  version: '2.0'
  description: >-
    Kravata Stack API: users, accounts, custody wallets, liquidity ramps and
    fiat payments.
servers:
  - url: https://test-api-kore.kravata.co
    description: Test
  - url: https://partners-api.kravata.co
    description: Production (mTLS + IP allowlist)
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Users
  - name: Accounts
  - name: Earn
  - name: Custody
  - name: Liquidity Ramps
  - name: Payments
  - name: Webhooks
paths:
  /api/v1/admin/earn/activate/{user_id}:
    patch:
      tags:
        - Earn
      summary: Activate Earn
      description: >-
        Activates earn for a user, so their balance starts generating yield.
        Earn must be enabled for your client.


        #### Request


        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | Authorization | Header | Yes | `Bearer <access_token>` obtained from
        **POST /api/v1/client/token**. |

        | user_id | Path | Yes | Identifier of the user. |


        #### Response


        | Field | Description |

        | --- | --- |

        | id | Identifier of the user's earn account. |

        | status | Status of the account. |

        | earnEnabled | Whether earn is active for the user. |

        | accumulatedEarnings | Earnings accumulated so far, or `null`. |

        | annualRateLabel | Annual rate shown to the user or `null`. |

        | registerDate | Creation date of the account. |


        #### Errors


        | Status | When |

        | --- | --- |

        | 400 | Earn is not enabled for your client, or the user does not exist.
        |
      operationId: activate-earn
      parameters:
        - name: user_id
          in: path
          required: true
          description: Identifier of the user.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                  registerDate:
                    type: string
                  earnEnabled:
                    type: boolean
                  accumulatedEarnings:
                    type: number
                  annualRateLabel:
                    type: string
              examples:
                activate-earn:
                  summary: Activate Earn
                  value:
                    id: 9f1c2b3a-4d5e-4f60-8a7b-1c2d3e4f5a6b
                    status: APPROVED
                    registerDate: '2026-09-01T10:00:00'
                    earnEnabled: true
                    accumulatedEarnings: 1520.35
                    annualRateLabel: <annual rate label>
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token from POST /api/v1/client/token.

````