Full Check

curl --request POST \
  --url https://api.example.com/api/v1/full-check \
  --header 'Content-Type: application/json' \
  --data '
{
  "mobile": "<string>",
  "name": "<string>",
  "async": true
}
'

import requests

url = "https://api.example.com/api/v1/full-check"

payload = {
    "mobile": "<string>",
    "name": "<string>",
    "async": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({mobile: '<string>', name: '<string>', async: true})
};

fetch('https://api.example.com/api/v1/full-check', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/full-check",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mobile' => '<string>',
    'name' => '<string>',
    'async' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/full-check"

	payload := strings.NewReader("{\n  \"mobile\": \"<string>\",\n  \"name\": \"<string>\",\n  \"async\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/full-check")
  .header("Content-Type", "application/json")
  .body("{\n  \"mobile\": \"<string>\",\n  \"name\": \"<string>\",\n  \"async\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/full-check")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mobile\": \"<string>\",\n  \"name\": \"<string>\",\n  \"async\": true\n}"

response = http.request(request)
puts response.read_body

POST

api

full-check

Full Check

curl --request POST \
  --url https://api.example.com/api/v1/full-check \
  --header 'Content-Type: application/json' \
  --data '
{
  "mobile": "<string>",
  "name": "<string>",
  "async": true
}
'

import requests

url = "https://api.example.com/api/v1/full-check"

payload = {
    "mobile": "<string>",
    "name": "<string>",
    "async": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({mobile: '<string>', name: '<string>', async: true})
};

fetch('https://api.example.com/api/v1/full-check', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/full-check",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mobile' => '<string>',
    'name' => '<string>',
    'async' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/full-check"

	payload := strings.NewReader("{\n  \"mobile\": \"<string>\",\n  \"name\": \"<string>\",\n  \"async\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/full-check")
  .header("Content-Type", "application/json")
  .body("{\n  \"mobile\": \"<string>\",\n  \"name\": \"<string>\",\n  \"async\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/full-check")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mobile\": \"<string>\",\n  \"name\": \"<string>\",\n  \"async\": true\n}"

response = http.request(request)
puts response.read_body

Full Check

Comprehensive verification combining UPI lookup, KYC verification, and VPA chargeback check in a single request. Get complete customer intelligence in one API call.

Overview

This endpoint performs three verification steps:

UPI by Mobile - Retrieve all UPI VPAs linked to the mobile number
KYC by Mobile - Fetch KYC data (name, PAN, masked Aadhaar, DOB)
VPA Chargeback Check - Check discovered VPAs against the blocklist

This is ideal for comprehensive customer verification during onboarding or high-value transactions.

Request

mobile

string

required

Mobile number in Indian international format (+91XXXXXXXXXX)

name

string

required

Name of the mobile number owner (e.g., Rajesh Kumar). Required for UPI VPA lookup step.

async

boolean

default:"true"

If true (default), request is queued and result delivered via webhook. If false, wait for result synchronously (up to 30 seconds).

Headers

Header	Value	Required
`X-API-Key`	Your API key	Yes
`Content-Type`	`application/json`	Yes

Example Request (Async Mode - Default)

curl -X POST "https://api.txncheck.in/api/v1/full-check" \
  -H "X-API-Key: fb_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "+919876543210",
    "name": "Rajesh Kumar"
  }'

import requests

response = requests.post(
    "https://api.txncheck.in/api/v1/full-check",
    headers={
        "X-API-Key": "fb_your_api_key_here",
        "Content-Type": "application/json"
    },
    json={"mobile": "+919876543210", "name": "Rajesh Kumar"}
)
print(response.json())

const axios = require('axios');

const response = await axios.post(
  'https://api.txncheck.in/api/v1/full-check',
  { mobile: '+919876543210', name: 'Rajesh Kumar' },
  {
    headers: {
      'X-API-Key': 'fb_your_api_key_here',
      'Content-Type': 'application/json'
    }
  }
);
console.log(response.data);

<?php
$ch = curl_init("https://api.txncheck.in/api/v1/full-check");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-API-Key: fb_your_api_key_here",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "mobile" => "+919876543210",
    "name" => "Rajesh Kumar"
]));
$response = curl_exec($ch);
curl_close($ch);
echo $response;

payload := map[string]string{"mobile": "+919876543210", "name": "Rajesh Kumar"}
body, _ := json.Marshal(payload)

req, _ := http.NewRequest("POST", "https://api.txncheck.in/api/v1/full-check", bytes.NewBuffer(body))
req.Header.Set("X-API-Key", "fb_your_api_key_here")
req.Header.Set("Content-Type", "application/json")

client := &http.Client{}
resp, _ := client.Do(req)

Example Request (Sync Mode)

curl -X POST "https://api.txncheck.in/api/v1/full-check" \
  -H "X-API-Key: fb_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "+919876543210",
    "name": "Rajesh Kumar",
    "async": false
  }'

const axios = require('axios');

const response = await axios.post(
  'https://api.txncheck.in/api/v1/full-check',
  { mobile: '+919876543210', name: 'Rajesh Kumar', async: false },
  {
    headers: {
      'X-API-Key': 'fb_your_api_key_here',
      'Content-Type': 'application/json'
    }
  }
);
console.log(response.data);

Full Check performs multiple verification steps and may take longer to complete. Consider using async mode (default) to avoid timeouts.

Response

Async Mode (202)
Sync Mode (200)

202 Accepted

Request accepted and queued for processing.

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

200 OK

Request completed synchronously with all results in response.

{
  "statusCode": 200,
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "method": "full-check",
  "status": "COMPLETED",
  "stepStatuses": {
    "upiByMobile": "ok",
    "kycByMobile": "ok",
    "vpaChargebackCheck": "ok"
  },
  "result": {
    "upiByMobile": { "name": "JOHN DOE", "vpas": ["johndoe@upi"], "status": "1" },
    "kycByMobile": { "fullName": "JOHN DOE", "pan": "ABCDE1234F", ... },
    "vpaChargebackCheck": {
      "vpas": [
        { "vpa": "johndoe@upi", "isBlocklisted": false }
      ]
    }
  },
  "createdAt": "2025-01-11T10:30:00.000Z",
  "completedAt": "2025-01-11T10:30:10.000Z"
}

Sync mode has a 30-second timeout. Full Check may approach this limit due to multiple verification steps.

Result Data (via webhook, polling, or sync response)

When the request completes successfully:

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "method": "full-check",
  "status": "COMPLETED",
  "stepStatuses": {
    "upiByMobile": "ok",
    "kycByMobile": "ok",
    "vpaChargebackCheck": "ok"
  },
  "result": {
    "upiByMobile": {
      "name": "JOHN DOE",
      "vpas": [
        "johndoe@upi",
        "9876543210@paytm",
        "9876543210@ybl"
      ],
      "status": "1"
    },
    "kycByMobile": {
      "fullName": "JOHN DOE",
      "pan": "ABCDE1234F",
      "maskedAadhaar": "XXXXXXXX1234",
      "dob": "1990-01-15",
      "status": "1"
    },
    "vpaChargebackCheck": {
      "vpas": [
        {"vpa": "johndoe@upi", "isBlocklisted": false},
        {"vpa": "9876543210@paytm", "isBlocklisted": false},
        {"vpa": "9876543210@ybl", "isBlocklisted": false}
      ]
    }
  },
  "webhookStatus": "SENT",
  "createdAt": "2025-01-11T10:30:00.000Z",
  "completedAt": "2025-01-11T10:30:10.000Z"
}

Partial Completion

If some steps fail but others succeed, the status will be PARTIAL:

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "method": "full-check",
  "status": "PARTIAL",
  "stepStatuses": {
    "upiByMobile": "ok",
    "kycByMobile": "failed",
    "vpaChargebackCheck": "ok"
  },
  "result": {
    "upiByMobile": {
      "name": "JOHN DOE",
      "vpas": ["johndoe@upi"],
      "status": "1"
    },
    "vpaChargebackCheck": {
      "vpas": [{"vpa": "johndoe@upi", "isBlocklisted": false}]
    }
  },
  "error": {
    "kycByMobile": {
      "class": "PROVIDER_TEMPORARY",
      "message": "KYC service temporarily unavailable"
    }
  },
  "webhookStatus": "SENT",
  "createdAt": "2025-01-11T10:30:00.000Z",
  "completedAt": "2025-01-11T10:30:10.000Z"
}

Step Statuses

Status	Description
`ok`	Step completed successfully
`failed`	Step failed (check error details)
`skipped`	Step was skipped (e.g., no VPAs found for chargeback check)
`pending`	Step not yet executed

Result Fields

upiByMobile

Field	Type	Description
`name`	string	Name associated with the mobile number
`vpas`	string[]	Array of UPI VPAs
`status`	string	`"1"` if data found

kycByMobile

Field	Type	Description
`fullName`	string	Full name as per KYC records
`pan`	string	PAN number
`maskedAadhaar`	string	Masked Aadhaar number
`dob`	string	Date of birth (`YYYY-MM-DD`)
`status`	string	`"1"` if data found
`cached`	boolean	`true` if response is from cache

vpaChargebackCheck

Field	Type	Description
`vpas`	array	VPA results with blocklist status
`vpas[].vpa`	string	VPA
`vpas[].isBlocklisted`	boolean	`true` if VPA is in blocklist
`vpas[].source`	string	Source of blocklist data (optional)

Error Responses

400 Bad Request

Invalid mobile number format.

{
  "statusCode": 400,
  "message": ["Mobile must be in format +91XXXXXXXXXX (Indian number)"],
  "error": "Bad Request"
}

401 Unauthorized

Invalid or missing API key.

{
  "statusCode": 401,
  "message": "Invalid API key",
  "error": "Unauthorized"
}

402 Payment Required

Insufficient account balance.

{
  "statusCode": 402,
  "message": "Insufficient wallet balance",
  "error": "Payment Required"
}

403 Forbidden

Method not enabled for your account.

{
  "statusCode": 403,
  "message": "Access to method 'full-check' is not allowed",
  "error": "Forbidden"
}

408 Request Timeout (Sync Mode Only)

Request processing timed out.

{
  "statusCode": 408,
  "message": "Request processing timed out after 30 seconds",
  "error": "Request Timeout"
}

429 Too Many Requests

Rate limit exceeded.

{
  "statusCode": 429,
  "message": "Too Many Requests",
  "error": "Too Many Requests"
}

Use Cases

Customer Onboarding

Get complete customer verification in a single API call during account creation.

High-Value Transactions

Perform comprehensive verification before processing large transactions.

Enhanced Due Diligence

Meet compliance requirements with thorough identity verification.

Risk Assessment

Build a complete risk profile combining identity, UPI, and blocklist data.

Full Check is billed as three separate verifications. Ensure your account has sufficient balance for all steps.

VPA Chargeback Check Bulk VPA Check

​Full Check

​Overview

​Request

​Headers

​Example Request (Async Mode - Default)

​Example Request (Sync Mode)

​Response

​202 Accepted

​200 OK

​Result Data (via webhook, polling, or sync response)

​Partial Completion

​Step Statuses

​Result Fields

​upiByMobile

​kycByMobile

​vpaChargebackCheck

​Error Responses

​400 Bad Request

​401 Unauthorized

​402 Payment Required

​403 Forbidden

​408 Request Timeout (Sync Mode Only)

​429 Too Many Requests

​Use Cases

Full Check

Overview

Request

Headers

Example Request (Async Mode - Default)

Example Request (Sync Mode)

Response

202 Accepted

200 OK

Result Data (via webhook, polling, or sync response)

Partial Completion

Step Statuses

Result Fields

upiByMobile

kycByMobile

vpaChargebackCheck

Error Responses

400 Bad Request

401 Unauthorized

402 Payment Required

403 Forbidden

408 Request Timeout (Sync Mode Only)

429 Too Many Requests

Use Cases