POSTUPI ID (VPA) Verification

Validate a UPI Virtual Payment Address (VPA) and retrieve the registered payee name and mobile number in real time.

POST/customer/payment/upi/validate-vpa

Confirms whether a UPI ID (VPA) is active and returns the verified recipient name and registered mobile number. Use this before initiating any UPI transfer to reduce wrong-payee failures and payment fraud.

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`user_code`	string	required	User code of the retailer/agent the service is run for.e.g. 20810200
`client_ref_id`	string	optional	Unique reference id per API call, generated by your system.e.g. REQ-20260101-001
`customer_vpa`Customer VPA	string	required	The UPI Virtual Payment Address (VPA / UPI ID) to validate, e.g. rajesh.kumar@okicici.e.g. rajesh.kumar@okicici
`recipient_mobile`	string	required	Mobile number of the recipient linked to the VPA, used for additional verification.e.g. 9876543210
`name`	string	required	Name of the recipient as expected — returned for match validation against the bank-verified payee name.e.g. Rajesh Kumar
`latlong`	string	required	Geo-coordinates of the request origination point (latitude,longitude).e.g. 28.6139,77.2090

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

user_codestringRequired

User code of the retailer/agent the service is run for.

example: 20810200

client_ref_idstringoptional

Unique reference id per API call, generated by your system.

example: REQ-20260101-001

customer_vpastringRequired· Customer VPA

The UPI Virtual Payment Address (VPA / UPI ID) to validate, e.g. rajesh.kumar@okicici.

example: rajesh.kumar@okicici

recipient_mobilestringRequired

Mobile number of the recipient linked to the VPA, used for additional verification.

example: 9876543210

namestringRequired

Name of the recipient as expected — returned for match validation against the bank-verified payee name.

example: Rajesh Kumar

latlongstringRequired

Geo-coordinates of the request origination point (latitude,longitude).

example: 28.6139,77.2090

Headers

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- vpastring
  The validated UPI Virtual Payment Address (VPA / UPI ID) exactly as registered.
- validboolean
  Whether the VPA is active and valid. true = valid VPA; false = invalid or inactive.
- recipient_namestring
  Verified payee name as returned by the UPI network — use this for name-match checks before payment.
- mobile_numberstring
  Registered mobile number linked to the VPA.
- transaction_idstring
  Unique transaction / verification request ID generated by Eko's system for audit and support reference.