---
title: "Read API Key info."
method: GET
path: "/api2/json/apiKeyInfo"
tags: ["admin"]
---

# Read API Key info.

`GET /api2/json/apiKeyInfo`

## Response `200`

Read API Key (uncached, i.e. DB read)

- APIKeyOut
  - `apiKey` string — The user API Key.
  - `userId` string — The user identifier.
  - `admin` boolean — The API Key has admin role.
  - `vetted` boolean — The API Key is vetted (assumed truthful) for machine learning.
  - `learnable` boolean — The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed).
  - `anonymized` boolean — The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed).
  - `partner` boolean — The API Key has partner role.
  - `striped` boolean — The API Key is associated to a valid Stripe account.
  - `corporate` boolean — The API Key has role corporate (ex SWIFT payments instead of Stripe payments).
  - `disabled` boolean — The API Key is temporarily or permanently disabled.
  - `explainable` boolean — The API Key supports the AI explainability option (may require a specific license).
  - `duplicateNamesRatio` integer — The duplicateNamesRatio = 0 ou 10 ou 20.
  - `ipAddress` string
  - `communityEngageOption` CommunityEngageOptionOut
    - `genderFilter` string[] — The gender filter (null to allow all)
    - `ethnicityFilter` string[] — The ethnicity filter (null to allow all)
    - `countryOutFilter` string[] — The output country filter (null to allow all)
    - `usRaceEthnicityFilter` string[] — The output US race/ethnicity filter (null to allow all)

## Other responses

- `401` — Missing or incorrect API Key
- `429` — Too Many Requests

---

[API](https://skmtc.net/namsor/apis/namsor-api-v2.md) · [All operations](https://skmtc.net/namsor/apis/namsor-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/namsor/namsor-api-v2/revisions/305e4f6eeaf5/schema)