Skip to content

Mobile to VPA API

New

Find the UPI handle held against a mobile number your customer gave you. You can then address payouts and refunds without asking for bank details again.

Overview

A mobile to VPA lookup starts from a mobile number the customer has already given you and returns the UPI handle available against it. If you hold that number on a policy file, a seller record or a rider roster, the lookup removes a typing step that is easy to get wrong. As an API, the lookup runs inside the system that needs it: an onboarding form, a claims queue or a scheduled payout run. The fields returned vary by data source and by record, and a number may resolve to one handle, to several, or to none at all. Use it with the customer's consent, for a stated payment purpose. Pair it with a name confirmation where the amount or the risk profile warrants a closer look.

Coverage
India. UPI handles registered against a mobile number, where a record is available
Input
Customer-provided mobile number, collected with consent
Output
The UPI handle or handles available against the number, with any name information the source provides
Typical users
Payout, onboarding and claims teams across lending, insurance, marketplaces, logistics and gig platforms
Coverage note
Available fields vary by data source and record; a number may return one handle, several, or none

The overview and the sections after the reference are the FinSour API catalog’s own record for this service, rendered unaltered.

Endpoint URL and method

POSThttps://gateway.staging.finsour.io/v1/banking/vpa-by-mobile

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Authentication

Scheme API key travels in the X-Api-Key header

Send your API key in this header on every call, from your own server: a key sent from a browser is refused. A key starting fs_test_ calls the sandbox and one starting fs_live_ calls production, at the same address. Create keys in the FinSour console.

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Request parameters

Content type application/json

Headers

NameTypeRequiredDescriptionConstraints
Idempotency-KeystringRequiredA key you generate for each attempt. Sending the same key again returns the first answer instead of running the check twice; the same key with a different body is refused.8 to 255 characters. Matches ^[A-Za-z0-9._:-]+$

Body

NameTypeRequiredDescriptionConstraints
inputobjectRequiredThe details to check.—
input.mobilestringRequired—Matches ^[6-9][0-9]{9}$. Exactly 10 characters
optionsobjectRequiredSettings for this call. This API requires consent.—
options.referencestringOptionalYour own reference for this call. It comes back unchanged as meta.reference.1 to 128 characters
options.consentobjectRequiredThe person's consent to this check.—
options.consent.obtainedbooleanRequiredSend true once the person has agreed to the check.Always true
options.consent.atstring (date-time)RequiredWhen the person gave consent.—
options.consent.purposestringRequiredWhat the check is for, for example kyc.1 to 64 characters

Request samples

cURL

curl -X POST https://gateway.staging.finsour.io/v1/banking/vpa-by-mobile \
  -H "X-Api-Key: $FINSOUR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "mobile": "<mobile>"
  },
  "options": {
    "consent": {
      "obtained": true,
      "at": "2026-09-01T10:00:00Z",
      "purpose": "kyc"
    }
  }
}'

Node.js

const response = await fetch("https://gateway.staging.finsour.io/v1/banking/vpa-by-mobile", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.FINSOUR_API_KEY,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "input": {
      "mobile": "<mobile>"
    },
    "options": {
      "consent": {
        "obtained": true,
        "at": "2026-09-01T10:00:00Z",
        "purpose": "kyc"
      }
    }
  }),
});

console.log(response.status, await response.json());

Python

import os
import uuid

import requests

response = requests.post(
    "https://gateway.staging.finsour.io/v1/banking/vpa-by-mobile",
    headers={
        "X-Api-Key": os.environ["FINSOUR_API_KEY"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "input": {
            "mobile": "<mobile>",
        },
        "options": {
            "consent": {
                "obtained": True,
                "at": "2026-09-01T10:00:00Z",
                "purpose": "kyc",
            },
        },
    },
    timeout=30,
)

print(response.status_code, response.json())

Generated from the fields above. Replace each value in angle brackets with your own; the key is read from FINSOUR_API_KEY.

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Response schema

Status 200 · content type application/json

NameTypePresentDescriptionConstraints
dataobjectAlwaysThe result of the check.—
data.foundbooleanAlways——
data.maskedMobilestringAlwaysThe mobile number sent, as its display form.Matches ^X{6}[0-9]{4}$
data.vpasarray of stringsAlways——
data.nameAtBankstring or nullAlwaysThe name registered against the handles, where the source gives one.—
data.sourceobjectAlways——
data.source.fetchedAtstringAlwaysWhen the answer was fetched: RFC 3339 UTC with a Z, never an epoch or an IST offset.Matches ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Error codes

CodeStatusMeaningRetrying
API_VERSION_UNSUPPORTED400That API version is no longer supported.Do not retry automatically
IDEMPOTENCY_KEY_INVALID400That Idempotency-Key does not meet the required format.Do not retry automatically
IDEMPOTENCY_KEY_REQUIRED400An Idempotency-Key header is required for this request.Do not retry automatically
REQUEST_MALFORMED400The request could not be parsed.Do not retry automatically
AUTH_KEY_EXPIRED401The API key is not valid.Do not retry automatically
AUTH_KEY_INVALID401The API key is not valid.Do not retry automatically
AUTH_KEY_MISSING401No API key was presented.Do not retry automatically
AUTH_KEY_REVOKED401The API key is not valid.Do not retry automatically
INSUFFICIENT_BALANCE402The available balance is not enough for this request.Do not retry automatically
AUTH_IP_NOT_ALLOWED403This API key may not be used from this address.Do not retry automatically
ENTITLEMENT_MISSING403This organization is not entitled to that product in this environment.Do not retry automatically
ORGANIZATION_SUSPENDED403This organization is not active.Do not retry automatically
PRODUCT_NOT_AVAILABLE403That product is not available.Do not retry automatically
PRODUCT_RETIRED403That product has been withdrawn.Do not retry automatically
SCOPE_INSUFFICIENT403This API key does not carry the scope this product requires.Do not retry automatically
PRODUCT_NOT_FOUND404No such product.Do not retry automatically
IDEMPOTENCY_KEY_REUSED409That idempotency key was already used for a different request.Do not retry automatically
PRICE_UNAVAILABLE409No active price covers this product right now.Safe to retry
REQUEST_IN_PROGRESS409An earlier attempt with this key is still running.Safe to retry
SETTLEMENT_PENDING409This request is awaiting reconciliation by an operator.Do not retry automatically
API_VERSION_SUNSET410That API version passed its announced sunset date.Do not retry automatically
REQUEST_TOO_LARGE413The request body is too large.Do not retry automatically
UNSUPPORTED_MEDIA_TYPE415That content type is not accepted on this route.Do not retry automatically
CONSENT_REQUIRED422This product requires an explicit consent flag.Do not retry automatically
SANDBOX_FIXTURE_MISSING422No sandbox fixture exists for this input. Use a different test value.Do not retry automatically
UPSTREAM_REJECTED422The upstream source rejected the input.Do not retry automatically
VALIDATION_FAILED422The request payload is invalid.Do not retry automatically
CONCURRENCY_LIMIT429Too many simultaneous requests.Safe to retry
QUOTA_EXCEEDED429The allowance for this window is spent.Do not retry automatically
RATE_LIMITED429Too many requests.Safe to retry
INTERNAL_ERROR500An unexpected error occurred.Safe to retry
OUTCOME_UNCERTAIN502The outcome of this request is not yet known. Retry with the same Idempotency-Key.Do not retry automatically
UPSTREAM_UNAVAILABLE502The upstream source is unavailable. Retry shortly.Safe to retry
MAINTENANCE_MODE503The service is in a maintenance window.Safe to retry
NO_PROVIDER_AVAILABLE503No provider can serve this product right now.Safe to retry
SERVICE_OVERLOADED503The service is shedding load. Retry shortly.Safe to retry
UPSTREAM_TIMEOUT504The upstream source did not respond in time.Safe to retry

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Rate limits

ScopeLimitWindowAt the limit
Your API key, within your organisation's limitThe figure in X-RateLimit-LimitPer minute429 RATE_LIMITED, with Retry-After in seconds. Every answer past authentication carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Use cases

  • Lending: address a disbursement or refund using the handle resolved from the borrower's number
  • Insurance: prepare claim settlement and premium refund payouts from the number on the policy file
  • Marketplaces: resolve seller settlement and buyer refund destinations captured at registration
  • Logistics and fleet: pay riders and last-mile partners without collecting full bank details
  • Gig and staffing platforms: build frequent wage payout files from the roster already maintained
  • Telecom and travel: direct channel commissions and cancellation refunds to a resolved handle

What this service does

  • Works from the number on your roster

    Most customers register a UPI handle against the mobile number attached to their bank account. A number you captured at onboarding can therefore become a payout destination, with no further request to the customer.

  • The handle, and any name the source holds

    The response carries the UPI handle or handles associated with the submitted number, together with any name information the source makes available. The exact fields returned vary by data source and by record, and some numbers return no handle at all.

  • One less handle to type by hand

    Handles collected by hand pass through forms, support calls and spreadsheets. Each step can introduce a character that later shows up as a failed or misdirected transfer. A lookup removes that step.

  • Runs on screen or in a batch

    The lookup can run while the customer is on screen, so a wrong number can be corrected. It can also run as part of a batch assembled ahead of a scheduled disbursement cycle.

How a check runs

  1. Collect the number under a payment notice

    Capture the customer's mobile number for a stated payment purpose, with a notice that explains what the lookup is for.

  2. Send the number to the VPA lookup

    Your application sends the mobile number through the API from the onboarding form, claims queue or payout run that needs the destination.

  3. Read the handle that comes back

    The response carries the UPI handle or handles available against that number, with any name information the source provides.

  4. Let the customer confirm or change it

    Show the resolved handle for confirmation where the journey allows it, and let the customer override it or supply a different one.

  5. Store the handle for the payout run

    Keep the confirmed handle against the customer record with a timestamp, and refresh it when a payout fails or the customer changes their number.

Questions

What is a Mobile to VPA API?
An interface that takes a customer-provided mobile number and returns the UPI Virtual Payment Address available against it. A business can then address a payout or a collection request from a number it already holds, instead of collecting bank details separately.
What does a mobile to VPA response contain?
The UPI handle or handles associated with the submitted number, along with any name information the underlying source makes available. Available fields vary by data source and by record. A response may carry less than the maximum for a given number.
What if a mobile number has no UPI handle?
The lookup can return no result. A customer may never have enabled UPI, or may use a number other than the one registered with their bank. Treat an empty result as unknown, and keep a path for the customer to supply payout details another way.
Does a resolved UPI handle confirm who the customer is?
No. It shows where a payment can be addressed. It is not an identity check, and it does not establish that the person on your record controls the account behind the handle. Pair it with a name confirmation and your existing risk checks where the amount warrants it.
Do I need consent to resolve a UPI handle from a mobile number?
Yes. Both the number you submit and the handle that comes back are personal data. Collect the number for a stated payment purpose, under a notice that covers the lookup. Do not reuse the result for anything the customer was not told about.
Can I run mobile to VPA lookups in bulk before a payout run?
The lookup can be built into a batch prepared ahead of a scheduled disbursement run, as well as inline during onboarding. What is available to you depends on the selected service contract.

Catalog entry last updated .