Skip to main content
POST

Mock Bank Verification

This endpoint doesn’t send a BANK webhook. Read the account with Get Bank Account to see the new status.

Error Codes and Messages

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
customer_id
string<uuid>
required

Zapyd customer ID (UUID) returned by Create Customer.

Example:

"c2cf861b-342b-4318-a90e-85cd0312e82f"

bank_id
string<uuid>
required

Bank account ID returned by Add Bank Account.

Example:

"cab47575-bbcb-4294-81a3-30774104f3b6"

bank_status
enum<string>
required

Result to set

Available options:
VERIFIED,
FAILED,
MANUAL_REVIEW
Example:

"VERIFIED"

failure_reason
enum<string>

Required when bank_status is FAILED. Use a real reason so your error handling gets tested.

Available options:
INVALID_IFSC,
INVALID_ACCOUNT_NUMBER,
ACCOUNT_TYPE_NRE,
PENNY_DROP_FAILED,
NAME_MISMATCH,
BANK_RISK_CHECK_FAILED
Example:

"NAME_MISMATCH"

Response

Bank account status updated

status
boolean
Example:

true

message
string
Example:

"Success"

data
object