Set up EWB credentials

Required to generate or modify e-Way Bills against a GSTIN (or TRANSIN). The flow is the same shape as IRN credentials — different portal, different endpoint.

Prerequisites

  • An OAuth client provisioned via the Developer hub (single gstn-india scope).
  • An API user account on ewaybillgst.gov.in for the target GSTIN. Create from For GSP → Registration in the EWB portal. The credential you set there is what you upload below.

Transporters without a GSTIN: register for a TRANSIN on the EWB portal and treat it as your gstin value (the API field is named gstin but it accepts either).

Upload (or rotate)

POST /v1/gsp-credentials/ewb HTTP/1.1
Host: api.in.onefinops.com
Authorization: Bearer ...
{
  "gstin": "29ABCDE1234F1Z5",
  "userName": "29ABCDEEWB001",
  "password": "<plaintext>",
  "notes": "Rotated 2026-05-04"
}

Same rules as IRN: password required on create, optional on update. Returns the metadata record (no plaintext echo). Rate-limited to 10 requests/minute per OAuth client.

Verify metadata

GET /v1/gsp-credentials/ewb/{gstin}

Test connection

POST /v1/gsp-credentials/ewb/test-connection
{
  "gstin": "29ABCDE1234F1Z5",
  "userName": "29ABCDEEWB001",
  "password": "<plaintext>"
}

Returns { ok, latencyMs, vendorErrorCode, vendorMessage }. Use before upsert when onboarding a new GSTIN/TRANSIN.

Remove

DELETE /v1/gsp-credentials/ewb/{gstin}

Soft-deletes; subsequent EWB calls for that GSTIN will fail until a new credential is uploaded.

A note on dual portals

NIC keeps the IRP and EWB portals on separate authentication systems. You need both an IRN credential and an EWB credential for the same GSTIN if you want both flows. The credentials are independent: the username and password may differ.