API
Authentication
Server to Server
Server to server traffic uses API Key authentication.
Vital API Keys can be created through the Vital Team Dashboard. Requests from your backend services should present the API Key
in the X-Vital-API-Key
header. For example:
cURL
curl --request GET
--url '{{BASE_URL}}/v2/providers'
--header 'X-Vital-API-Key: <YOUR-API-KEY>'
API Key format
Prefix | Environment | Region |
---|---|---|
sk_us_... | Sandbox | US |
sk_eu_... | Sandbox | Europe |
pk_us_... | Production | US |
pk_eu_... | Production | Europe |
Vital Mobile SDKs
Vital Mobile SDKs supports two authentication methods:
-
Vital Sign-In Token — Recommended for production usage
-
Vital API Keys — Recommended only for evaluation in Sandbox
Refer to the Mobile SDK Authentication documentation for more information.