Authentication
Verify API key
GET
Checks that an API key works and returns the ID of the Knock account it belongs to. Any active key issued for API access can call it, whichever endpoints it may use. It enriches nothing and uses no credits, so it is a safe first call when you set up an integration. It counts toward your rate limit like every other request.
ApiKeyAuthheader
x-api-key<token>Your Knock API key. Ask your Knock account team for one: a key with the Enrichment API role for enrichment, or the Viewer role for chats and meetings.
The API key is valid.
application/json- response
The account an API key belongs to.
vendorId*stringID of the Knock account that owns the API key.
Format
uuidcurl -X GET 'https://app.knock-ai.com/resources/whoami/v1' \ -H 'x-api-key: <YOUR_API_KEY>'Example Response
{ "vendorId": "3f2c8a71-5d4e-4b9a-8c1f-2e6d7a9b0c35"}