---
title: "List key formats"
method: GET
path: "/keyFormat"
tags: ["key-format"]
---

# List key formats

`GET /keyFormat`

Returns all configured key formats used by API-side key validation. Each item describes a `keyId` and its constraints: `formatType` (`CPF`, `TITULO`, `REGEX`, `ALPHANUMERIC`, `ALPHABETIC`, `NUMERIC`), optional `regex` (when `formatType=REGEX`), and optional `minLength`/`maxLength`. Use this endpoint to inspect which formats are currently enforced by the API during enroll/update when key-format validation is enabled.

## Response `200`

OK

- ListKeyFormatResponse
  - `httpResponse` HttpResponse
    - `httpCode` integer
    - `body` string
  - `data` KeyFormat[]
    - `keyId` string
    - `formatType` 'TITULO' | 'CPF' | 'ALPHANUMERIC' | 'NUMERIC' | 'ALPHABETIC' | 'REGEX'
    - `regex` string
    - `minLength` integer
    - `maxLength` integer

---

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