Authentication
External integrations authenticate with tenant API keys generated from the tenant portal.
API Key Authentication
Every external API request should include the tenant API key generated from the tenant portal. The key identifies the tenant and determines which product services the integration can access.
Headers
| Header | Required | Description |
|---|---|---|
| X-API-Key | Yes | Raw tenant API key created from the tenant portal. |
| X-Environment | Recommended | Environment for request routing and pricing. Usually `sandbox` or `live`. |
| Idempotency-Key | Recommended | Prevents duplicate processing on retries where supported. |
| X-Correlation-Id | Optional | Client trace ID for support and audit. |
API Key Example
bash
curl -X GET "http://identity.stg.parthiantechnology.com/api/v1/company/validation/company/rc?rcNumber=RC1234567" \ -H "X-API-Key: sk_test_your_key" \ -H "X-Environment: sandbox"