Skip to navigation

Check your credentials

Returns the partner your key belongs to, the environment it is bound to, and every registry it can reach. No side effects.

The fastest way to confirm a key works and is pointed at the right environment — worth making the first call in any integration, and the first thing to try when something 401s or 403s.

Authentication

AuthorizationBearer

Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Response headers

X-Request-IdstringOptional

The ID of this request. On an error it equals request_id in the body. If you sent an X-Request-Id, it is your value, returned unchanged. Log it, and quote it when contacting CONFIRM support.

Response

The identity behind this key.
partnerstringOptional
Your partner slug.
namestringOptional
environmentenumOptional

The environment this key is bound to. A key presented to any other environment is refused with wrong_environment.

Allowed values:
organizationslist of objectsOptional
Every registry this key can reach, by your own reference.

Errors

401
Unauthorized Error
403
Forbidden Error