UPI Multiple VPA

This endpoint allows verification of multiple UPI VPA (Virtual Payment Address) IDs linked to a single mobile number.

Overview

The UPI Multiple Mobile Verification API enables you to fetch all UPI handles/VPAs associated with a mobile number. This is useful when customers have multiple UPI IDs linked to the same phone number.

Endpoint Details

POST /verification/upimobile_multiple

Headers

  • client-id: Your unique Client ID (required)
  • client-secret: Your unique Client Secret (required)
  • Content-Type: application/json (required)

Request Body

ParameterTypeRequiredDescription
consentstringYesMust be "Y" for consent
vpa_mobilestringYesMobile number to verify
clientDataobjectYesClient reference data
clientData.client_idstringYesUnique client identifier

Request Example

{
    "consent": "Y",
    "vpa_mobile": "9999999999",
    "clientData": {
        "client_id": "942wdq5142dxssasdx82"
    }
}

Response

Success Response (101)

{
    "status": "success",
    "statusCode": "101",
    "partner_id": "ARNPY17627619425159",
    "name": "RAKESH MITTAL",
    "vpa": "9999999999@kotak",
    "vpaList": [
        "9999999999@kotak",
        "9999999999@hdfc"
    ],
    "count": 2,
    "description": "UPI ID(s) found linked to the mobile number.",
    "accountStatus": "VALID",
    "clientData": {
        "client_id": "942wdq5142dxssasdx82",
        "mobile": "9999999999"
    },
    "message": "UPI handles fetched successfully."
}

Response Fields

FieldTypeDescription
statusstringAPI call status ("success" for successful calls)
statusCodestringHTTP status code ("101" for success)
partner_idstringUnique partner transaction ID
namestringAccount holder name associated with the mobile number
vpastringPrimary VPA ID linked to the mobile number
vpaListarrayList of all VPA IDs linked to the mobile number
countnumberTotal number of VPAs found
descriptionstringStatus description
accountStatusstringAccount validation status
clientDataobjectEcho of client data from request
messagestringSuccess message

Error Responses

Invalid Mobile Number

{
    "status": "failed",
    "statusCode": "400",
    "message": "Invalid mobile number format",
    "clientData": {
        "client_id": "942wdq5142dxssasdx82"
    }
}

No VPA Found

{
    "status": "failed", 
    "statusCode": "404",
    "message": "No UPI ID found linked to the mobile number",
    "clientData": {
        "client_id": "942wdq5142dxssasdx82"
    }
}

Use Cases

  1. Customer Onboarding: Verify customer's UPI capabilities during registration
  2. Payment Setup: Allow customers to choose from multiple VPA options
  3. Account Verification: Validate UPI account details before transactions
  4. KYC Compliance: Verify customer identity through UPI account validation

Best Practices

  • Always obtain user consent before verification
  • Store the partner_id for transaction tracking
  • Handle cases where multiple VPAs are returned
  • Implement proper error handling for failed verifications
  • Use secure HTTPS connections for all API calls
Language
Click Try It! to start a request and see the response here!