---
title: "Check a BYOK key"
method: GET
path: "/providers/{provider}/status"
---

# Check a BYOK key

`GET /providers/{provider}/status`

## Request

- Base URL: `https://app.fullenrich.com/api/v2`
- URL: `https://app.fullenrich.com/api/v2/providers/{provider}/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/docs/providers/:provider/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Send the saved credentials to the provider and return the result. The check does not change the key and does not enrich a contact. It works on a disabled key.

## Headers

- `Sub-Account-ID` string, uuid

## Response `200`

OK. The response contains the check result only: no credentials, balance, or provider payload.

- BYOKKeyStatus
  - `status` 'valid' | 'rejected' | 'unavailable', required: valid: the provider accepted the credentials. rejected: the provider refused the credentials; replace them. unavailable: the provider did not answer; try again later.

## Other responses

- `400`: Unknown provider name
- `401`: Unauthorized
- `403`: BYOK is not enabled for the workspace
- `404`: No key for this provider in the selected scope, or the sub-account named in the header does not exist
- `429`: Too Many Requests

## Changes

- **2026-11-05** `9e5fe5ba0794`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/changes/providers/:provider/status/get.md)

---

[API](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation.md) - [All operations](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/revisions/b5bec9933c01?raw)