Understanding Esign APIs Headers

These following headers are required for most Esign APIs after token generation.

HeaderRequiredDescriptionExample
x-onekyc-tokenYesPartner token from Get Partner Token APIeyJraWQiOiJlY...
x-esign-onboarding-partnerUsually yesIdentifies your integration source (issued during onboarding)CLIENT_X-BE-CERT_REG
x-partner-user-idYesYour internal user identifier tied to submissionuser-12345
x-partner-user-id-typeYesType/label of your user IDCLIENT_X_USER_ID
x-partner-session-idYesCorrelation ID generated by partner; must be unique per invocationsession-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>"