Understanding Esign APIs Headers
These following headers are required for most Esign APIs after token generation.
| Header | Required | Description | Example |
|---|---|---|---|
x-onekyc-token | Yes | Partner token from Get Partner Token API | eyJraWQiOiJlY... |
x-esign-onboarding-partner | Usually yes | Identifies your integration source (issued during onboarding) | CLIENT_X-BE-CERT_REG |
x-partner-user-id | Yes | Your internal user identifier tied to submission | user-12345 |
x-partner-user-id-type | Yes | Type/label of your user ID | CLIENT_X_USER_ID |
x-partner-session-id | Yes | Correlation ID generated by partner; must be unique per invocation | session-abc-001 |
Authentication token generation (GET /v1/esign/partner/authentication) is the only common exception and uses client-id and pass-key instead.
Endpoint-specific Note
For GET /esign-partner/v1/submissions (Get Submission Details), x-esign-onboarding-partner is not required in the current API spec.
Example Header Block
-H "x-onekyc-token: <TOKEN>" \
-H "x-esign-onboarding-partner: <ONBOARDING_PARTNER>" \
-H "x-partner-user-id: <PARTNER_USER_ID>" \
-H "x-partner-user-id-type: <PARTNER_USER_ID_TYPE>" \
-H "x-partner-session-id: <UNIQUE_SESSION_ID>"Updated about 2 hours ago