Skip to main content

​
Quick Start

This guide will help you make your first verification request using the TxnCheck API.

​
Prerequisites

1

Obtain your API key

API keys are provided by the TxnCheck team during merchant onboarding. Contact your account manager or visit your dashboard to request access.
2

Choose your execution mode

TxnCheck supports two modes:
  • Async mode (default): Requests are queued, results delivered via webhooks or polling
  • Sync mode: Wait for results directly in the response (up to 30 seconds)
Merchant accounts and API keys are created by the TxnCheck team. Self-registration is not available.

​
Make Your First Request

Let’s verify a mobile number to get associated UPI VPAs. You can choose between async and sync modes.
Async mode queues your request and delivers results via webhooks or polling.
curl -X POST "https://api.txncheck.in/api/v1/upi-by-mobile" \
  -H "X-API-Key: fb_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "+919876543210"
  }'

​
Response (202 Accepted)

{
  "statusCode": 202,
  "message": "Request accepted and queued for processing",
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "QUEUED"
}

​
Get Results (Async Mode Only)

If you used async mode, results are delivered via webhooks (recommended) or by polling the status endpoint. If you have a webhook configured, you’ll receive the results automatically: 
{
  "event": "request.completed",
  "timestamp": "2025-01-11T10:30:05.000Z",
  "data": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "method": "upi-by-mobile",
    "status": "COMPLETED",
    "result": {
      "name": "JOHN DOE",
      "upi": [
        "johndoe@upi",
        "9876543210@paytm",
        "9876543210@ybl"
      ],
      "status": "1"
    },
    "completedAt": "2025-01-11T10:30:05.000Z"
  }
}

​
Option 2: Polling

Poll the request status endpoint until the status is COMPLETED, FAILED, or PARTIAL: 
curl -X GET "https://api.txncheck.in/api/v1/requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: fb_your_api_key_here"

​
Completed Response

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "method": "upi-by-mobile",
  "status": "COMPLETED",
  "result": {
    "name": "JOHN DOE",
    "upi": [
      "johndoe@upi",
      "9876543210@paytm",
      "9876543210@ybl"
    ],
    "status": "1"
  },
  "webhookStatus": "SENT",
  "createdAt": "2025-01-11T10:30:00.000Z",
  "completedAt": "2025-01-11T10:30:05.000Z"
}

​
Understanding the Response

FieldDescription
requestIdUnique identifier for tracking the request
statusCurrent status: QUEUED, PROCESSING, COMPLETED, FAILED, PARTIAL
resultVerification result data (when completed)
result.nameName associated with the mobile number
result.upiArray of UPI VPAs linked to the mobile number
result.status"1" indicates data was found

​
What’s Next?

Set up Webhooks

Receive real-time notifications when verifications complete

Explore All Methods

Learn about KYC verification, VPA checks, and more

Test Your Integration

Use test mode to validate your implementation

Error Handling

Learn how to handle API errors

​
Common Issues

Make sure you’re including the X-API-Key header with a valid API key.
Mobile numbers must be in Indian international format: +91 followed by 10 digits.Correct: +919876543210Incorrect: 9876543210, +1-987-654-3210
Your API key may not have access to this verification method. Contact your account manager to enable it.
Your account balance is insufficient. Top up your balance in the merchant dashboard.