API reference / KYC / Identity
Reverse penny drop: send amount
Credits a small random amount to the account and returns a reference_id. The holder reports the amount back to prove they control the account. name and mobile are optional.
POST
/v1/verify/bank-account/dynamic- Authentication
- Bearer token
- Scope
kyc:verify
Before you integrate
- This is step 1 of 2. A small random amount is credited to the account. Ask the account holder what they received, then call /v1/verify/bank-account/dynamic/confirm with the referenceid and that amount.
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. |
name | string | No | Account holder's name, 2 to 100 characters. When given, the name is matched against the bank's record. |
mobile | string | No | Account holder's mobile number. 10-digit Indian mobile number starting 6 to 9; a leading +91, 91 or 0 and spaces are ignored. |
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/dynamic' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account_number": "123456782",
"ifsc": "HDFC0001234"
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"referenceid": "ref_123456",
"active": "yes",
"reason": "",
"name_match": "yes",
"name_match_score": "100",
"mobile_match": "no",
"bank_transfer": {
"response": "Success",
"bank_rrn": "612345678901",
"bene_name": "ASHA RAO",
"bene_ifsc": "HDFC0001234"
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
referenceid | string | Reference for this transfer. Send it as reference_id to /v1/verify/bank-account/dynamic/confirm. |
active | string | Whether the account is active. |
reason | string | Reason given when the account could not be confirmed. |
name_match | string | Whether the name you sent matches the bank's record. |
name_match_score | string | How closely the names match. |
mobile_match | string | Whether the mobile number matches the bank's record. |
audit_trail | object | When and how the check was made. |
audit_trail.nature | string | Kind of check made. |
audit_trail.value | string | What was checked. |
audit_trail.timestamp | string | When the check was made. |
bank_transfer | object | Details of the small transfer to the account. |
bank_transfer.response | string | Bank's response to the transfer. |
bank_transfer.bank_rrn | string | Bank reference number of the transfer. |
bank_transfer.bene_name | string | Account holder name returned by the bank. |
bank_transfer.bene_mobile | string | Mobile number returned by the bank. |
bank_transfer.bene_ifsc | string | IFSC returned by the bank. |
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.