Skip to main content
GET
Check a BYOK key
Test the saved credentials with the provider.
  • The check does not change the key and does not enrich a contact.
  • It works on a disabled key.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Sub-Account-ID
string<uuid>

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

Path Parameters

provider
enum<string>
required

Provider identifier. Case-insensitive. Provider identifier. Case-insensitive in requests; responses use lowercase.

Available options:
prospeo,
enrow,
cleon1,
datagma,
aviato,
wiza,
forager_ai,
icypeas,
contact_out,
people_data_labs,
lusha,
apollo_io,
zoominfo
Example:

"prospeo"

Response

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

status
enum<string>
required

valid: the provider accepted the credentials. rejected: the provider refused the credentials; replace them. unavailable: the provider did not answer; try again later.

Available options:
valid,
rejected,
unavailable
Example:

"valid"