FUfullenrich

Check a BYOK key

Changed on

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.

get/providers/{provider}/status

Request

Headers

Sub-Account-IDstring uuid

Manage the keys of one sub-account instead of the workspace keys. See the Sub-accounts section of the BYOK overview.

Response

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

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.

Example response

{
  "status": "valid"
}

Changes