API reference / CAS (portfolio fetch)
3.1 CAS Auto Request — submit
Submits the statement request with the CAPTCHA answer. The RTA then e-mails the password-protected CAS to the investor.
POST
/v1/cas/request/submit- Authentication
- Bearer token
- Scope
cas:request
Before you integrate
- Step 2 of 2, after opening a session. Unknown fields in the body are rejected.
- The issuer e-mails the PDF to the investor, locked with cas_password. Then read it with the mailbox scan or an upload.
- If period is specific, from_date and to_date are both required.
- A reply with accepted false (for example a wrong CAPTCHA) is still a completed call and is charged. Open a new session and try again.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
session_id | string | Yes | The session_id from opening a session; 3 to 64 characters. |
pan | string | Yes | Investor PAN in capitals, for example ABCPE1234F; the fourth letter must be one of A, B, C, F, G, H, L, J, P, T. |
email | string | Yes | Where the issuer e-mails the statement; up to 120 characters. |
statement_type | string | No | summary or detailed. Defaults to summary (detailed adds every transaction). |
period | string | No | current_fy, previous_fy or specific. Defaults to current_fy. |
from_date | string | No | Start date as DD/MM/YYYY. Required when period is specific. |
to_date | string | No | End date as DD/MM/YYYY. Required when period is specific. |
cas_password | string | Yes | Password the PDF will be locked with: 8 to 12 characters with a capital letter, a small letter, a digit and a symbol. |
include_zero_balance_folios | boolean | No | Also list folios with no units left. Defaults to false. |
captcha | string | Yes | The characters the investor read from the picture; 1 to 10 characters. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X POST 'https://grappi.ai/v1/cas/request/submit' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"session_id": "cassn_replace_me",
"pan": "ABCPA1234A",
"email": "investor@example.com",
"statement_type": "detailed",
"period": "current_fy",
"cas_password": "Grappi@2026",
"captcha": "AB12CD"
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"request_id": "casrq_1a2b3c4d5e6f7a8b",
"source": "kfintech",
"status": "submitted",
"pan": "******234F",
"email": "asha.rao@example.com",
"statement_type": "detailed",
"period": "current_fy",
"from_date": null,
"to_date": null,
"rta_code": null,
"message": "Your request has been received. The statement will be e-mailed shortly.",
"created_at": "2026-11-06T09:30:00.000Z",
"submitted_at": "2026-11-06T09:30:04.000Z",
"accepted": true,
"next": "The RTA mails the PDF to the investor. Pick it up with POST /v1/cas/read/mailbox/scan, or upload it to POST /v1/cas/read."
}
}Response fields
| Field | Type | Description |
|---|---|---|
request_id | string | Id of this statement request; use it on the request history calls. |
source | string | Which statement issuer the request went to. |
status | string | submitted when accepted, rejected when refused, session_open or expired otherwise. |
pan | string | The investor's PAN, masked. |
email | string | Where the statement will be e-mailed. |
statement_type | string | summary or detailed. |
period | string | current_fy, previous_fy or specific. |
from_date | string | Start date, DD/MM/YYYY; null unless period is specific. |
to_date | string | End date, DD/MM/YYYY; null unless period is specific. |
rta_code | string | The issuer's own result code, if it sent one. |
message | string | The issuer's reply text, word for word. |
created_at | string | When the request was created, ISO 8601. |
submitted_at | string | When the issuer accepted it, ISO 8601; null if it did not. |
accepted | boolean | True when the issuer accepted the request and will e-mail the statement. |
reason | string | Why it was refused: invalid_captcha, no_investment_found or rta_error. Present only when accepted is false. |
next | string | What to do next, in plain words. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.