[go: up one dir, main page]

0% found this document useful (0 votes)
18 views5 pages

PAN Validation API Document

The PAN Validation API document outlines the integration process for third-party vendors to validate PAN data using HTTP requests. It includes guidelines for API usage, methods for obtaining a Captcha, and validating PAN status, along with required authentication details. The document specifies response formats and provides examples for better understanding of the API responses.

Uploaded by

babai2408
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
18 views5 pages

PAN Validation API Document

The PAN Validation API document outlines the integration process for third-party vendors to validate PAN data using HTTP requests. It includes guidelines for API usage, methods for obtaining a Captcha, and validating PAN status, along with required authentication details. The document specifies response formats and provides examples for better understanding of the API responses.

Uploaded by

babai2408
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

Page 1 of 8

PAN Validation API Document

Prepared By: Webtel Electrosoft Pvt. Ltd.


Version: 1.9

Release Date: 15-Oct-2023


Page 2 of 8

Table of Contents:

1. Guidelines 3
2. Get PAN Captcha 4
3. Validate PAN 5
Page 3 of 8

Guidelines
APIs have been developed to integrate third party software to process Validating data. This Document
will technically help third party vendors to consume APIs and understand the validation process.

Some common features of the APIs are:

1. Platform independent APIs. HTTP request required to access APIs.


2. Request data should be in JSON format.
3. Response will be in JSON format.
4. Basic authentication is required to validate API call.

How to Use This Document: This document contains detailed section for each API. In each, section there
are certain sub section which have specific meaning. Here is the description of each sub section.

1. Points to Every API may have some pre or post requisites or it may have
Note some specific functional or technical conditions. User needs to
understand these points before making call to API.
2. Allowed This section defines all allowed request methods for a particular
Method API. Only use the method, defined in Allowed Method section, to
request any API.
Commonly used methods are GET, POST, PUT & OPTION
3. URI Full URL of API. In the URI section there is an expression
<Domain Name> which denotes the custom URL of client where
API is hosted.
4. URI This section defines the parameters which need to be supplied
Parameters with the URI. URI Parameter is commonly used in GET method.
5. Body This section contains the details of parameters which have to be
Parameters passed in body as Payload. If body parameter contains any
complex or user defined data type, you will get the detail of that
parameter in Body Parameter section itself.
6. Request This section further contains some sub sections :
Header -Authorization: Each API call requires authorization through valid
Username and Password which should be concatenated with
three colons (:::).
-Content-Type: It must be either application/json or text/json.
-Payload: Payload is the complete data required to push to API.
This data must in JSON format only.
7. Response This section contains information regarding the response. This
Information section also have further sub sections
Resource Description: Response will be in JSON formatted string
in most of the cases. You can check this section for detail of any
particular API.
Response Formats: text/plain, application/json, text/json
Sample: This section contains the response sample whichhelp
you to easily understand the response message.
Page 4 of 8
Page 4 of 8

Get PAN Captcha


Overview

This API is used to get the Captcha to Validate PAN.

Allowed Method: Get.

URI : http://services.webtel.in/integrationservice/getcaptchapan

Auth Type: Basic

Username: HHY&^$js15234GG
Password: $js15234GG&jnhdr22

Response Format:

{
"status": 1,
"id": "641f6dd2-dc4a-4950-bc1b-525700fd48ba",
"data": "iVBORw0KGgoAAAANSUhEUgAAALYAAAAyCAYAAADx0SHKAAAGb0lEQVR42u2dX4RdRxjAP8eKtdYSFbFW7Uut1Yd
9iaqqiHCttdY+hD5ERFW4IiKilqpaKyqs6ENeK6pWHkJFVOUtoqKuKCtqRa2yqiJihaiKWNfW6Rmd1ens/J9v5p5z7jd82dy5c+b
vb+Z88813zgUAKElIWij//qMITY7PnRawB8WxTPCsY65+GnR8K8BOMWClJ7wu0J8V5HYlTyp5zaXP02zz785FQF+HBYDAzgy2S1o
dULf53xOO+Yxw+SJi5R73rCOB3RKwQ9OaYPqT/2Wr6B7//EhK86KSmxJMYv5TlfyCpJZseLTTR8UhsGsOdqwOO1fJ1UruVLIZmJe
Y5zQH33TNX5WscXk3oM6D6KtGgt3IXW/kijOKXI8xriNvR+Y3UclSJeuV7CCDHXo9WUWqcEtT0OMaqSILnp10sJnbiejoaUFCrSo
xewxSRSIyZKvgG8PAzNRcx75UyXvSqn7S0TqxjwCljzUGA2IC2zH+gmVw12sA9qqmbr0ItUcnb5DAxrCMpFjxhwbsnmWg2aaqGCD
YN5D19sKS352EYIvxPyOqMQR24AZjAaEhmJuMYxHt7ljy/jgx2B84tnET8E9EySoC+Y+b5fijinxeIeiinQTtsQ6YEF54lDMD6U5
eW2sVUd2Sr2gK3OerZGi5vg18xe3FqvrF3oZXPepxV5DQFVKOk9vFVJLTwnh0kCfy0Kkiy1IHP+Xxv2oG7Kpj/uMIM5cdhuwq4os
AsH3KHZVs5SFg22Dfkja/I4o6y/ueowS2e/wPUud9yuM/0wzOVkaw+4q4XYfBs8Fl01uPCXemWPk9Uk0T01wjsN3iJyUb7r6wITs
euRkZh7Bj3nkh7d+K67+G+OPk15Zrew5WIh+wO4p67IH7yah8N22zfRsFbHlV/t5z5Rv0xiW0E13AFj0DZXmfS0x9ZbBHMvcXWUU
Sda6uowsIs1f7dGLfo74msEVdf9bDXMrCQ+m7jzR1PiIdGpFVxBL/oZTZc036l5rCzwZ2qk2PBDAf7fsMKMYgu4ZZT7jlBxJ+Eza
HYrlnhDSPSBWxx8sOT9c16W9qBuhBQrC3E4Id6gHoCjpLc96Q33O+CrNw3wL2Wzy+FPIlsA3xYwodb0aTfs5g055KBLYOQkAAex/
Sqlk2sJl0NW1kEC/x/5+RoB4W56gosLuem0HdEyWfJ771l5oNVsgg10mH7CKpRQS2xfBvS39Z09E7Ldy4zEl3KZ/QJJcGsooMsPN
LjeUgZvXadgA71LNOLnMZ9CeqB+F0xhW71VaRr5Ar8U1GVYTAJlVEG7+LDDYzzY0S2AT2oMFOIZ9ksopsIIB9L6GObTpckX1gWJg
EvYdfR7FpnySw84L9Yyaw2VH4eGKwD3VyArD3+PfrQtwT4c53ENhn0QvwBoF9OEwp7NDHPSswYwDinQRgq5zx1yLBvp4RbLCALbo
Gz2vy6Eh27qEBuw2+IkeE1U0Ma5qDoRiwF8D8CgdMsE2nj/L3hSaPQqHCkFVECPJ7NRYCZ1ZXU5lnA+xU30HOAbbJmesuHHbEKjL
0VetUkZNgdnjyqcCYZ+e5qCK2uFKjb68EDqjNg3A68oCGhRNIEIqTkJygpM/fgtnhCXMTmgLsa5qyVsD8SohQqC4igG0r4yeHO+i
EpIdfJrD/v8L2FRu9VGBP8DShT9Do6qDb9P1RyZcKvVS+fpSbJXuOYPvA7TphXgqWDxnsLUWdn4L+YYShB/uixjQXWwHdu/AuWcB
WyaIj5Mvg9tqCgtt8F/nn+8Lk7glt2AO3R7R85BQXlRfhBaEtVxRgzwtq0pIA9i7EH9BA08Bugyx6DEboQ8J9jarg+uyhKyinHPN
hViCXt7uylf1tIF8RqHM8RqMZ2KuAZ0lZCQS7EFSeaceJIodZ8NfFh+ZNUE0CGyNtChPhPTCfSPYE6XApHMvZsJjbNgHXnEmvX2g
o2CGmQdH56Bb891s0Yh5sY/Yd8i31nKausS+eBCTYCewGge0KO4Cbf0qoPAO/09eQFRcI7OEFGzzhZaELeO69qdraerCH8TdosHR
JX+hjfiuyjpOYrCLI8aleuBMyCcqISQEGlQZ7xc21iJAqUjOrCHadscDG+tm7XH1NYA9YxwZHMHKBHbsCp7R0ENgNA7tEAqlMBDa
GrwyB3cCGpNJHsXXXmGvqOtnJKpLYOpLDghCzgUyhiuSAtdFclCQkbZN/AHPMifu3vAEPAAAAAElFTkSuQmCC",
"errorMessage": null
}
Page 5 of 8

Validate PAN
Overview

This API is used to validate the status of PAN.

Allowed Method: GET.

URI: http://services.webtel.in/integrationservice/ValidatePan

Parameters :
UserID : XXXXXXX
TAN : XXXXXXX
Password : XXXXXX
Captcha : XXXXXX
PAN : XXXXXXXXXX
ResponseID : XXXXXXXXXXXXXXXXXXX ( received in captcha response)

Auth Type: Basic

Username: HHY&^$js15234GG
Password: $js15234GG&jnhdr22

Response Format:

{
"Name": "",
"PanStatus": "",
"Status": 0,
"Message": "Error :Invalid TAN/UserId/Password/Captcha"
}

You might also like