> ## 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.

# Get Earn Status

> Returns the earn status and accumulated earnings of a user.

#### 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. |

Returns 404 when the user has no earn account.



## OpenAPI

````yaml /stack/openapi.json get /api/v1/admin/earn/{user_id}/status
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/{user_id}/status:
    get:
      tags:
        - Earn
      summary: Get Earn Status
      description: >-
        Returns the earn status and accumulated earnings of a user.


        #### 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. |


        Returns 404 when the user has no earn account.
      operationId: get-earn-status
      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:
                get-earn-status:
                  summary: Get Earn Status
                  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.

````