Skip to main content
GET
/
v4
/
inbound-email
/
{inbound_email_id}
Get Inbound Email Details
curl --request GET \
  --url https://api.casparser.in/v4/inbound-email/{inbound_email_id} \
  --header 'x-api-key: <api-key>'
{
  "inbound_email_id": "ie_a1b2c3d4e5f6",
  "email": "ie_a1b2c3d4e5f6@import.casparser.in",
  "reference": "user_12345",
  "callback_url": "https://api.yourapp.com/webhooks/cas-email",
  "allowed_sources": [
    "cdsl",
    "nsdl"
  ],
  "status": "active",
  "metadata": {
    "plan": "premium"
  },
  "created_at": "2025-02-21T10:30:00Z",
  "updated_at": "2025-02-21T10:30:00Z"
}

Authorizations

​
x-api-key
string
header
required

Your API key for authentication. Use sandbox-with-json-responses as Sandbox key.

Path Parameters

​
inbound_email_id
string
required

Inbound Email ID (e.g., ie_a1b2c3d4e5f6)

Response

Mailbox details

An inbound email address for receiving forwarded CAS emails

​
inbound_email_id
string

Unique inbound email identifier

Example:

"ie_a1b2c3d4e5f6"

​
email
string<email>

The inbound email address to forward CAS statements to

Example:

"ie_a1b2c3d4e5f6@import.casparser.in"

​
reference
string | null

Your internal reference identifier

Example:

"user_12345"

​
callback_url
string<uri>

Webhook URL for email notifications

Example:

"https://api.yourapp.com/webhooks/cas-email"

​
allowed_sources
enum<string>[]

Accepted CAS providers (empty = all)

Available options:
cdsl,
nsdl,
cams,
kfintech
Example:
["cdsl", "nsdl"]
​
status
enum<string>

Current mailbox status

Available options:
active,
paused
Example:

"active"

​
metadata
object

Custom key-value metadata

Example:
{ "plan": "premium" }
​
created_at
string<date-time>

When the mailbox was created

Example:

"2025-02-21T10:30:00Z"

​
updated_at
string<date-time>

When the mailbox was last updated

Example:

"2025-02-21T10:30:00Z"