---
title: "Get the caller's KYC lookup allowance and usage"
method: GET
path: "/api/v1/persons/lookup/usage"
tags: ["User"]
---

# Get the caller's KYC lookup allowance and usage

`GET /api/v1/persons/lookup/usage`

Account-only quota metadata. It returns tier_allowed=false instead of exposing any lookup data when the plan is not eligible.

## Response `200`

KYC tier and usage metadata

- KycPersonLookupUsageResponse
  - `tier_allowed` boolean, required
  - `message` string, nullable
  - `upgrade_url` string, nullable
  - `usage` KycUsage
    - `used` integer, required
    - `max` integer, required
    - `remaining` integer, required
    - `window_days` integer, required
    - `unlimited` boolean, required
  - `disclaimer` string, nullable

## Other responses

- `401` — Authentication required (no active session)
- `503` — KYC helper unavailable

---

[API](https://skmtc.net/openmercantil/apis/openmercantil-public-api.md) · [All operations](https://skmtc.net/openmercantil/apis/openmercantil-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openmercantil/openmercantil-public-api/versions/996f96a11758/schema)