POST
/v1/verify/bank-account- Authentication
- Bearer token
- Scope
kyc:verify
Request body
| Field | Type | Required | Description |
|---|---|---|---|
account_number | string | Yes | Bank account number, 6 to 20 digits. |
ifsc | string | Yes | IFSC of the branch: four letters, a zero, then six letters or digits, for example HDFC0001234. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X POST 'https://grappi.ai/v1/verify/bank-account' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account_number": "123456782",
"ifsc": "HDFC0001234"
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"account_number_masked": "*****6782",
"ifsc": "HDFC0001234",
"valid": true,
"name_at_bank": "ASHA RAO"
}
}Response fields
| Field | Type | Description |
|---|---|---|
account_number_masked | string | The account number with all but the last four digits hidden. |
ifsc | string | The IFSC that was checked, in upper case. |
valid | boolean | True when the account exists. |
name_at_bank | string | Name of the account holder as the bank holds it, or null when not available. |
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.