Live demo of agent247 on Digio's docs — click the orange button at the bottom right to start.

VPA verification is used to find customer names against VPA in UPI and verify the status of the account.

There are 2 APIs, namely:

  1. VPA Verification: It checks if the VPA passed is an active VPA or not along with the customer name linked
  2. Mobile to Linked VPA: It gives all the VPA linked with a given mobile number along with the VPA status

For more details, refer to both the APIs as mentioned below.

For API Base URL's, click here. Kindly append the Base URL to the API endpoints below to integrate
Digio Apis

Getting started with Digio Rest Apis

API SERVER

SELECTED: https://api.digio.in
AUTHENTICATION
No API key applied
General ⦂

Bank Account Verification (VPA Verification)

post {BASE_URL}/v3/client/public/upi/check_vpa

Request Body Params (application/json)

Call this API to verify Virtual Payment Address in UPI Ecosystem

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
REQUEST BODY application/json
object
Single line description
Field
Type
Description
reference_id
string

Reference ID

Constraints: 1 to 32 chars
Pattern: ^[A-Za-z0-9-_]*$
unique_request_id
string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

Constraints: 1 to 32 chars
Pattern: ^[A-Za-z0-9-_]*$
virtual_address
string

Valid Virtual Payment Address

name
string
API Server
https://api.digio.in
Authentication
Required (None Applied)
curl -X POST "https://api.digio.in/v3/client/public/upi/check_vpa" \
 -H 'accept: application/json' 
RESPONSE
application/json
object
Single line description

List of VPA details.

Field
Type
Description
virtual_address
string

Virtual Payment Address (VPA)

customer_name
string

Name associated with the primary bank account linked to the VPA

status
enum

Status of the VPA

Allowed: available┃failed┃not_available
status_description
string

Description of the VPA Status

fuzzy_match_score
integer

Fuzzy match score against customerName

application/json
object
Single line description
Field
Type
Description
details
string

Details about the exception. Usually contains the exception id for reference.

code
string

Error code

message
string

Description of the error

errors
string

Custom errors

Digio Apis

Getting started with Digio Rest Apis

API SERVER

SELECTED: https://api.digio.in
AUTHENTICATION
No API key applied
General ⦂

Mobile to Linked VPA

post {BASE_URL}/v3/client/public/upi/search_vpa

Request Body Params (application/json)

It gives all the VPA linked with a given mobile number along with the VPA status

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
REQUEST BODY application/json
object
Single line description
Field
Type
Description
referenceId
string

Reference ID

Constraints: 1 to 32 chars
Pattern: ^[A-Za-z0-9-_]*$
uniqueRequestId
string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

Constraints: 1 to 32 chars
Pattern: ^[A-Za-z0-9-_]*$
handlePrefix
string

Mobile number

Constraints: 3 to 20 chars
Pattern: ^[^<>";=%!\*+?]*$
API Server
https://api.digio.in
Authentication
Required (None Applied)
curl -X POST "https://api.digio.in/v3/client/public/upi/search_vpa" \
 -H 'accept: application/json' 
RESPONSE
application/json
object
Single line description
Field
Type
Description
- vpaDetails
array of object

List of VPA details.
⮕ [ List of VPA details. ]

virtual_address
string

Virtual Payment Address (VPA)

customer_name
string

Name associated with the primary bank account linked to the VPA

status
enum

Status of the VPA

Allowed: available┃failed┃not_available
status_description
string

Description of the VPA Status

fuzzy_match_score
integer

Fuzzy match score against customerName

application/json
object
Single line description
Field
Type
Description
details
string

Details about the exception. Usually contains the exception id for reference.

code
string

Error code

message
string

Description of the error

errors
string

Custom errors

Was this page helpful?