Skip to main content
POST
Create Inbound Email

Authorizations

x-api-key
string
header
required

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

Body

application/json
alias
string

Optional custom email prefix (e.g. john-portfolio@import.casparser.in). 3-32 chars, alphanumeric + hyphens, must start/end with a letter or number. If omitted, a random ID is generated.

Required string length: 3 - 32
Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
Example:

"john-portfolio"

reference
string

Your internal identifier (e.g., user_id, account_id). Returned in webhook payload for correlation.

Maximum string length: 256
Example:

"user_12345"

callback_url
string<uri> | null

Optional webhook URL where we POST parsed emails. Must be HTTPS in production (HTTP allowed for localhost). If omitted, retrieve files via GET /v4/inbound-email/{id}/files.

Example:

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

allowed_sources
enum<string>[]

Filter emails by CAS provider. If omitted, accepts all providers.

Available options:
cdsl,
nsdl,
cams,
kfintech
Example:
metadata
object

Optional key-value pairs (max 10) to include in webhook payload. Useful for passing context like plan_type, campaign_id, etc.

Example:

Response

Inbound email created successfully

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. If set, we POST each parsed email here. If omitted, files are only retrievable via GET /v4/inbound-email/{id}/files.

Example:

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

allowed_sources
enum<string>[]

Accepted CAS providers (empty = all)

Available options:
cdsl,
nsdl,
cams,
kfintech
Example:
status
enum<string>

Current inbound email lifecycle status

Available options:
active,
paused
Example:

"active"

metadata
object

Custom key-value metadata

Example:
created_at
string<date-time>

When the inbound email was created

Example:

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

updated_at
string<date-time>

When the inbound email was last updated

Example:

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