Skip to main content
POST
india.gst.consent.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
gstin
string
required

Taxpayer GSTIN, including a sole proprietor's tax identifier.

Required string length: 1 - 15
Pattern: ^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z][Z1-9A-J][0-9A-Z]$
username
string
required

GST portal username.

Required string length: 1 - 100
services
enum<string>[]
required

Distinct tax services.

Required array length: 1 - 3 elements

Tax service to connect.

Available options:
returns,
einvoice,
ewaybill
einvoiceCredentials
object
ewaybillCredentials
object

Response

The result

status
enum<string>
required

Consent state.

Available options:
pending,
connected,
expired,
revoked
services
enum<string>[]
required

Distinct tax services.

Required array length: 1 - 3 elements

Tax service to connect.

Available options:
returns,
einvoice,
ewaybill
expiresAt
string<date-time>

Timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
ref
string

Reference to what this call created. Pass it as ref to india.gst.consent.verify, india.gst.consent.get or any consent-bound operation.