ZOOP DOCUMENTATION V0

ZOOP DOCUMENTATION V0

Welcome to ZOOP.ONE, We are working towards building One platform for everyone to prove and share their identity easily and securely. ZOOP is a platform that aims to bring a change in the current KYC process and make it extremely secure and consent-driven by enabling users with a Universal Digital Identity.

The Zoop API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTPS response codes, and authentication. To get started, you essentially need:

An active ZOOP.ONE Customer Account. You can start with, a free trial account.

Subscribe to the API which you want to Test from the Products section.

Download and enable API Key & copy APP Id from the Manage App Section.

This document has been categorised into multiple sections. You can access the relevant section. The common Authentication method and Response Codes have been grouped into separate sections for easy reference. You can view code examples in the dark area to the right. You can switch the programming language of the examples using the tabs above. You can also go through multiple response examples available.

Signup for Free Trial

First, sign up for your free ZOOP trial account. The signup process includes verifying your Business email-id: this is a security measure that is mandatory before you try ZOOP API. Note: In case if you do not have a Domain Id, you can reach out to us at sales@zoop.one or fill out this inquiry form.

Once you finish signup, you should see your Test APP. This is your APP for testing our API with valid API Key.

We give you a small preloaded balance to test out ZOOP API functionality. You will not be charged for Product API or usage until you upgrade.

Subscribing Products

This is the initial step during account registration. You can do a product subscription now or later.

On the right side of the dashboard, go to products and choose the products that you wish to subscribe to.

The products that you have subscribed can be used for testing now. There are some testing credits for your apps that you can use. These credits will be deducted from your current plan credits.

 

 

Adding Products to App

Zoop has the capability to add multiple apps for customer onboard verification. You can add as many apps as you can here.

To add products to the app, click on Manage products and add the subscribed products.

 

 

App Key Management

For your app security, you can add an API key to integrate into the subscribed products. You will receive the OTP in the admin email. Toggle on Enable to generate API key.

Enter the OTP that you have received on the work email and click on Verify to complete app key management.

 

 

API Base URL

Environment

Base URL

Environment

Base URL

live

https://live.zoop.one/api/v0

Authentication Method

The Zoop API uses API keys and APP ID to authenticate requests. You can view and manage your API Keys and App ID in the Zoop customer dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTPS Headers. Provide your API Key and APP ID in the headers to perform the request.

Field

Value

Required

Field

Value

Required

app-id

ID of the created app. Available within the APP section.

Y

api-key

API key generated and active within the APP with above app-id.

Y

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Note: Before moving to production it is advised to enable IP whitelisting from the App setting as by default all IPs are allowed.

Merchant Verification

Fetch the GST registration details of a business, and the director's information, and validate its authenticity.

Transaction Status

Status Code

Description

Status Code

Description

0

FAILED

1

SUCCESS

Response Codes

Status Code

Billable

Description

Status Code

Billable

Description

99

false

Unknown Error

100

false

Internal Error

101

true

Success

102

true

Invalid ID number or combination of inputs

103

true

No records found for the given ID or combination of inputs

104

true

Max retries exceeded

105

true

Missing Consent

110

false

Source Unavailable


GST Lite

https://live.zoop.one/api/v0/in/merchant/gstin/lite
{ "gstin":"<< GST Number >>", "consent":"<< Y or N >>", "consent_text":"<< Consent Message >>" }


Missing/invalid GSTIN

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Gstin is either invalid or empty"}

Invalid consent

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent is required"}

Invalid consent text

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent text must be atleast 20 characters long."}

Transaction successful (a valid record)

{ "id": "70808d7d-0f22-4474-a3a9-f013a3446e2d", "consent": "Y", "consent_text": "I hearby declare my random consent agreement for xyz company via abc and test 123.", "env": 2, "response_code": "101", "response_msg": "Success", "transaction_status": 1, "request_timestamp": "2019-06-06 11:01:37:320 +05:30", "response_timestamp": "2019-06-06 11:01:37:701 +05:30", "result": { "stjCd": "MH025", "lgnm": "QUAGGA TECH PRIVATE LIMITED", "stj": "PUNE-1", "dty": "Regular", "adadr": [], "cxdt": "", "gstin": "27AAACQ419XXXXXX", "nba": [ "Supplier of Services" ], "lstupdt": "14/04/2018", "rgdt": "12/07/2017", "ctb": "Private Limited Company", "pradr": { "addr": { "bnm": "MIDC IT TOWER", "st": "Kharadi South Main Road", "loc": "Pune", "bno": "S NO 5 2A 1 Office No 406", "stcd": "Maharashtra", "dst": "Pune", "city": "", "flno": "IT Division", "lt": "", "pncd": "411014", "lg": "" }, "ntr": "Supplier of Services" }, "tradeNam": "QUAGGA TECH PRIVATE LIMITED", "sts": "Active", "ctjCd": "UC0503", "ctj": "RANGE-III" }}

Transaction successful (an invalid record)

{ "id": "<< Transaction ID>>", "response_code": "103", "env": 1, "request_timestamp": "2018-09-19 18:08:55:947 +05:30", "response_timestamp": "2018-09-19 18:08:57:366 +05:30", "response_msg": "Invalid ID number or combination of inputs"}

Transaction failure

{ "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9", "response_code": 110, "error_message": "Source Unavailable", "transaction_status": 0, "request_timestamp": "2018-06-21 14:23:06:109 +05:30", "response_timestamp": "2018-06-21 14:23:08:295 +05:30"}

GST Advance

https://live.zoop.one/api/v0/in/merchant/gstin/advance
{ "gstin":"<< GST Number >>", "consent":"<< Y or N >>", "consent_text":"<< Consent Message >>" }

Missing/invalid GSTIN

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Gstin is either invalid or empty"}

Invalid consent

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent is required"}

Invalid consent text

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent text must be atleast 20 characters long."}

Transaction successful (a valid record)

{ "id": "00214021-49c4-48a9-88a5-73e6f56aa574", "env": 1, "request_timestamp": "2021-03-23 11:57:37:147 +05:30", "response_timestamp": "2021-03-23 11:57:38:231 +05:30", "transaction_status": 1, "result": { "canFlag": "NA", "pradr": { "adr": "SKY LOFT, CREATICITY MALL, 1ST AND 2ND FLOOR, OPP. GOLF COURSE, SHASTRI NAGAR, YERWADA, Pune, Pune, Maharashtra, 411006", "em": "accounts@zoop.one", "mb": 942011XXXX, "ntr": "Supplier of Services", "addr": "NA", "lastUpdatedDate": "NA" }, "contacted": { "mobNum": 942011XXXX, "email": "accounts@zoop.one", "name": "" }, "bzsdtls": [ { "saccd": "00440452", "sdes": "INFORMATION TECHNOLOGY SOFTWARE SERVICE" } ], "ctb": "Private Limited Company", "rgdt": "01/07/2017", "stj": "State - Maharashtra,Zone - Pune,Division - PUNE_SOUTH,Charge - VADGAON-SHERI_701", "ctj": "Commisionerate - PUNE - I,Division - DIVISION-V-VIMAN NAGAR,Range - RANGE-III (Jurisdictional Office)", "dty": "Regular", "cmpRt": "NA", "tradeNam": "QUAGGA TECH PRIVATE LIMITED", "sts": "Active", "gstin": "27AAACQ4198G1Z7", "lgnm": "QUAGGA TECH PRIVATE LIMITED", "nba": [ "Supplier of Services" ], "mbr": [ "RITESH MAHENDRA KOTXXXX ", "VIJAY CHHUXXXXX " ], "cxdt": "", "aggreTurnOver": "Slab: Rs.X Cr. to XX Cr.", "mandatedeInvoice": "No", "isFieldVisitConducted": "No", "gti": "Up to Rs. X.X lakhs", "gtiFY": "2018-2019", "filingStatus": [ [ { "fy": "2020-2021", "taxp": "February", "mof": "ONLINE", "dof": "11/03/2021", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "January", "mof": "ONLINE", "dof": "11/02/2021", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "December", "mof": "ONLINE", "dof": "11/01/2021", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "November", "mof": "ONLINE", "dof": "10/12/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "October", "mof": "ONLINE", "dof": "11/11/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "September", "mof": "ONLINE", "dof": "31/10/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "August", "mof": "ONLINE", "dof": "08/09/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "July", "mof": "ONLINE", "dof": "11/08/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "June", "mof": "ONLINE", "dof": "12/07/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "May", "mof": "ONLINE", "dof": "23/06/2020", "rtntype": "GSTR1", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "January", "mof": "ONLINE", "dof": "23/02/2021", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "December", "mof": "ONLINE", "dof": "24/01/2021", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "November", "mof": "ONLINE", "dof": "21/12/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "October", "mof": "ONLINE", "dof": "26/11/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "September", "mof": "ONLINE", "dof": "21/10/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "August", "mof": "ONLINE", "dof": "25/09/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "July", "mof": "ONLINE", "dof": "20/08/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "June", "mof": "ONLINE", "dof": "20/08/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "May", "mof": "ONLINE", "dof": "19/06/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" }, { "fy": "2020-2021", "taxp": "April", "mof": "ONLINE", "dof": "19/06/2020", "rtntype": "GSTR3B", "arn": "NA", "status": "Filed" } ] ] }, "response_msg": "Success", "response_code": "101" }

Transaction successful (an invalid record)

{ "id": "<< Transaction ID>>", "response_code": "103", "env": 1, "request_timestamp": "2018-09-19 18:08:55:947 +05:30", "response_timestamp": "2018-09-19 18:08:57:366 +05:30", "response_msg": "Invalid ID number or combination of inputs"}

Transaction failure

{ "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9", "response_code": 110, "error_message": "Source Unavailable", "transaction_status": 0, "request_timestamp": "2018-06-21 14:23:06:109 +05:30", "response_timestamp": "2018-06-21 14:23:08:295 +05:30"}

PAN VERIFICATION

 

{ "pan":"BDLPN2744P", "consent": "Y", "consent_text": "liuoytfdfgxcvbnjnbhjvghcvb kj" }

 

https://live.zoop.one/api/v0/in/identity/pan/lite

Transaction Status

Status Code

Description

Status Code

Description

0

FAILED

1

SUCCESS

Response Codes

Status Code

Billable

Description

Status Code

Billable

Description

99

false

Unknown Error

100

false

Internal Error

101

true

Success

102

true

Invalid ID number or combination of inputs

103

true

No records found for the given ID or combination of inputs

104

true

Max retries exceeded

105

true

Missing Consent

110

false

Source Unavailable

REQUEST JSON

BODY PARAMS

  • pan (required) - Pan number of the customer which needs to be verified

  • consent (required) - Consent of the end user to get their information for verification purpose

  • consent_text(required) - Purpose for which user has given their consent.

OUTPUT

Missing PAN input

Plain Text

{ "statusCode": 422, "errors": [], "message": "Missing parameter: pan" }

Invalid PAN format

Plain Text

{ "statusCode": 422, "errors": [], "message": "Invalid Pan Number(s) :- <<List of invalid PAN numbers>>" }

Invalid consent

Plain Text

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent is required" }

Invalid consent text

Plain Text

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent text must be atleast 20 characters long." }

Transaction successful (valid record)

Plain Text

{ "id": "3af402c9-e8fd-4273-87f9-0f1a356ceaa1", "env": 1, "request_timestamp": "2018-11-22 18:04:56:300 +05:30", "response_timestamp": "2018-11-22 18:04:58:142 +05:30", "transaction_status": 1, "data": { "pan_number": "BFZPT1XXXX", "name": "MOHXX XXXXX", "pan_status": "VALID" }, "response_msg": "Success", "response_code": "101" }

Transaction successful (invalid record)

Plain Text

{ "id": "6bf2cfb8-0a48-4756-a3d0-478e29500701", "env": 1, "request_timestamp": "2019-10-11 14:58:01:402 +05:30", "response_timestamp": "2019-10-11 14:58:01:436 +05:30", "transaction_status": 0, "data": { "pan_number": "ABNPNXXXXX", "pan_status": "INVALID" }, "response_msg": "Invalid ID number or combination of inputs", "response_code": "102" }

Transaction failure

Plain Text

{ "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9", "response_code": 110, "error_message": "Source Unavailable", "pan_count": 1, "pan_success_count": 0, "transaction_status": 0, "request_timestamp": "2018-06-21 14:23:06:109 +05:30", "response_timestamp": "2018-06-21 14:23:08:295 +05:30" }

 

Request Headers:

Content-Type

application/json

qt_api_key

qt_agency_id

Bodyraw (json)

 

PAN-ADVANCE

This is an API-based service that allows you to validate PAN with rich data

{ "pan": "{{single pan number here}}" }

 

'https://live.zoop.one/api/v0/in/identity/pan/advance

Transaction Status

Status Code

Description

Status Code

Description

0

FAILED

1

SUCCESS

2

PARTIAL_SUCCESS

Response Codes

Status Code

Billable

Description

Status Code

Billable

Description

1

true

Successful

2

false

Source Downtime

3

false

Source Downtime

7

false

Number of PANs exceeds the limit (5)

8

false

Source Downtime

11

false

Source Downtime

12

false

Source Downtime

13

false

Source Downtime

16

false

Source Downtime

99

false

Unknown Error

100

false

Internal Error

110

false

Source Unavailable

PAN STATUSES (As marked in Government Records)

Description

Description

1

VALID

2

FAKE

3

DEACTIVATED

4

DELETED

5

INVALID

6

AMALGAMATION

7

ACQUISITION

8

DEATH

9

DISSOLUTION

10

LIQUIDATED

11

MERGER

12

PARTITION

13

SPLIT

14

UNDER LIQUIDATION

REQUEST JSON

BODY PARAMS

  • pan (required) - Pan number of the customer which needs to be verified

OUTPUT

Missing PAN input

Plain Text

{ "statusCode": 422, "errors": [], "message": "Missing parameter: pan" }

Invalid PAN format

Plain Text

{ "statusCode": 422, "errors": [], "message": "Invalid Pan Number(s) :- <<List of invalid PAN numbers>>" }

Transaction successful (valid record)

Plain Text

{ "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9", "response_code": 1, "data": [ { "pan_number": "<pan_number_here>", "pan_status": "VALID", "last_name": "<last_name_here>", "first_name": "<first_name_here>", "middle_name": "<middle_name_here>", "pan_holder_title": "<Shri/MR/MRS etc>", "pan_last_updated": "<DD/MM/YYYY>" } ], "pan_count": 1, "pan_success_count": 1, "transaction_status": 1, "request_timestamp": "2018-06-21 14:23:06:109 +05:30", "response_timestamp": "2018-06-21 14:23:08:295 +05:30" }

Transaction successful (invalid record)

Plain Text

{ "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9", "response_code": 1, "data": [ { "pan_number": "<pan_number_here>", "pan_status": "INVALID" } ], "pan_count": 1, "pan_success_count": 1, "transaction_status": 1, "request_timestamp": "2018-06-21 14:23:06:109 +05:30", "response_timestamp": "2018-06-21 14:23:08:295 +05:30" }

Transaction failure

Plain Text

{ "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9", "response_code": 110, "error_message": "Source Unavailable", "pan_count": 1, "pan_success_count": 0, "transaction_status": 0, "request_timestamp": "2018-06-21 14:23:06:109 +05:30", "response_timestamp": "2018-06-21 14:23:08:295 +05:30" }

 

Request Headers

qt_api_key

qt_agency_id

Content-Type

Bodyraw (json)

 

DL VERIFICATION

This is an API-based service that allows you to validate Driving Licence from Government sources.

 

{   "dl_no": "<<Dl Number>>",   "consent": "<< Y or N >>",   "dob": "<<dd-mm-yy>>(optional)",   "consent_text": "<< Consent Message >>" }


https://live.zoop.one/api/v0/in/identity/dl/advance

Transaction Status

Status Code

Description

Status Code

Description

0

FAILED

1

SUCCESS

Response Codes

Status Code

Billable

Description

Status Code

Billable

Description

99

false

Unknown Error

100

false

Internal Error

101

true

Success

102

true

Invalid ID number or combination of inputs

103

true

No records found for the given ID or combination of inputs

104

true

Max retries exceeded

105

true

Missing Consent

110

false

Source Unavailable

Result Parameters

Field Name

Description

Field Name

Description

name

Name of as per Driving License

dob

Date of Birth as per Driving License

issue_date

Date of issue of the license

blood_group

Blood Group as per Driving License

father/husband

Name of Relative

address

Registered address as per Driving License

cov_details

Category of Vehicles the licensee is authorized to drive along with effective date

validity

Validity of the license as per purpose of driving – transport or non-transport

DL ADVANCE

REQUEST JSON

Body Params

  • dl_no (required) - DL number of the customer which needs to be verified NOTE : DL numbers are case sensitive and sensitive to spaces and hyphens.If DL number has more than 16 digits then you need to follow the standard format SS-RRYYYYNNNNNNN OR SSRR YYYYNNNNNNN.
    SS represents the character of the state.
    RR two-digit of RTO registration number.
    YYYY is the four-digit year.
    The last digit is a seven-digit number, if there is a shortage of number then a zero should be added, and if extra zeros are present then it should be removed in order to make the proper seven-digit number.

  • consent (required) - Consent of the end user to get their information for verification purpose

  • consent_text (required) - Purpose for which user has given their consent.

  • dob (optional)-Date of birth of the customer which needs to be verified Note : It is only required when DL number has no smart chip that basically means if it is not in the required format. Also for TL state DOB is mandatory.

  • Note : If response is not generated please try with DOB.

OUTPUT

Missing/invalid DL input

 

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: DL number should be atleast 5 characters long" }

Invalid consent

 

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent is required" }

Invalid consent text

Plain Text

{ "statusCode": 422, "errors": [], "message": "Invalid parameter: Consent text must be atleast 20 characters long." }

Transaction successful (valid record)

Plain Text

{ "id": "80bb7b10-9124-4d7e-8bc2-800f2c33be71", "env": 1, "request_timestamp": "2020-02-11 01:12:45:344 +05:30", "response_timestamp": "2020-02-11 01:12:52:425 +05:30", "transaction_status": 1, "result": { "address": [ { "addressLine1": "FLAT NO 302 BLOCK-1 CONFIDENT LEO SARJAPUR", "completeAddress": "FLAT NO 302 BLOCK-1 CONFIDENT LEO SARJAPUR MN RD NEAR DECATHLON HADOSIDsxsDAPURA BLAGURU SOUTH,BANGALORE,KA", "country": "India", "district": "BLAGURU SOUTH,BANGALORE,KA", "pin": "560135", "state": "Karnataka", "type": “P”resent” }, { "addressLine1": "FLAT NO 302 BLOCK-1 CONFIDENT LEO SARJAPUR", "completeAddress": "FLAT NO 302 BLOCK-1 CONFIDENT LEO SARJAPUR MN RD NEAR DECATHLON HADOSIDsxsDAPURA BLAGURU SOUTH,BANGALORE,KA", "country": "India", "district": "BLAGURU SOUTH,BANGALORE,KA", "pin": "560135", "state": "Karnataka", "type": "Permanent" } ], "blood_group": "U", "cov_details": [ { "cov": "LMV", "expiryDate": "", "issueDate": "28-11-2017" } ], "dl_number": “dl_number”, "dob": "22-09-1968", "expiryDate": "21-09-2023", "father/husband": “name of husband”, "img": “base”_64_of_image, "issue_date": "28-11-2017", "name": “name of dl card holder”, "state": "Karnataka", "status": "Active", "statusDetails": { "from": "", "remarks": "", "to": "" }, "validity": { "nonTransport": { "from": "22-09-2018", "to": "21-09-2023" }, "transport": { "from": "", "to": "" } } }, "response_msg": "Success", "response_code": "101" }

Transaction successful (invalid record)

 

{   "id": "65dc07f1-5eb2-40f8-b8b8-7f865f005f96",   "env": 1,   "request_timestamp": "2019-10-11 15:26:00:847 +05:30",   "response_timestamp": "2019-10-11 15:26:17:910 +05:30",   "transaction_status": 0,   "response_msg": "No records found for the given ID or combination of inputs",   "response_code": "103" }

Transaction failure

 

{   "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9",   "response_code": 110,   "error_message": "Source Unavailable",   "transaction_status": 0,   "request_timestamp": "2018-06-21 14:23:06:109 +05:30",   "response_timestamp": "2018-06-21 14:23:08:295 +05:30" }

 

Request Headers:

Content-Type

qt_api_key

qt_agency_id

Bodyraw (json)

 

BANK ACCOUNT VERIFICATION

 

This API can be used to verify any Indian bank’s account number

{   "Account": "<<Account Number Here>>",   "IFSC": "<<Bank's IFSC code>>",   "Advance": "Y" }

https://live.zoop.one/api/v0/in/financial/bav/lite

REQUEST JSON

Body Params

  • Account (required) - Bank Account Number which needs to be verified

  • IFSC (required) - IFSC Code of corresponding bank

  • Advance - If advance bank account verification Required (Y)

OUTPUT

Missing account number

Plain Text

{ "statusCode": 400, "errors": [], "message": "Invalid parameter: Account Number is either missing or Invalid" }

Missing/invalid IFSC

Plain Text

{ "statusCode": 400, "errors": [], "message": "Invalid parameter: IFSC is either missing or Invalid" }

Transaction successful (valid record)

Plain Text

{ "id":"f44791a7-6179-4a6d-9d00-32cfdd690af6", "transaction_status":1, "response_code":"TXN", "response_message":"Account details successfully verified.", "data":{ "BeneName":"Mr XXXX XXXX", "BankRef":"9127130XXXXX", "Remark":"Transaction Successful",, "Amount": "1.06", "Status":"VERIFIED" }, "request_timestamp":"2019-05-07 13:13:37:148 +05:30", "response_timestamp":"2019-05-07 13:13:41:702 +05:30" }

Transaction successful (invalid record)

Plain Text

{   "id": "36c42025-c506-4698-a158-c81704b8e8a8",   "transaction_status": 2,   "response_code": "IAN",   "response_message": "Account details could not be verified.",   "data": {     "Remark": "Invalid Account Number",     "Status": "NOT VERIFIED"   },   "request_timestamp": "2019-10-13 18:52:09:123 +05:30",   "response_timestamp": "2019-10-13 18:52:14:827 +05:30" }View more

Transaction failure

Plain Text

{   "id": "bbe85f62-6be0-48ee-9864-8f1308ccb9a9",   "response_code": 110,   "error_message": "Source Unavailable",   "transaction_status": 0,   "request_timestamp": "2018-06-21 14:23:06:109 +05:30",   "response_timestamp": "2018-06-21 14:23:08:295 +05:30" }

 

Request Headers:

Content-Type

qt_api_key

qt_agency_id

Bodyraw (json)

 

VOTER ID VERIFICATION

This is an API based service that allows you to validate Voter ID from Government sources.

 

{   "epic_no": "<< Voter Id Number >>",   "consent": "<< Y or N >>",   "consent_text": "<< Consent Message >>" }

 

https://live.zoop.one/api/v0/in/identity/voter/advance

Transaction Status

Status Code

Description

Status Code

Description

0

FAILED

1

SUCCESS

Response Codes

Status Code

Billable

Description

Status Code

Billable

Description

99

false

Unknown Error

100

false

Internal Error

101

true

Success

102

true

Invalid ID number or combination of inputs

103

true

No records found for the given ID or combination of inputs

104

true

Max retries exceeded

105

true

Missing Consent

110

false

Source Unavailable

Result Parameters

Field Name

Description

Field Name

Description

epic_no

EPIC Voter ID number to be authenticated

name

Name of the card holder in English

name_v1/2/3

Card holder’s name in vernacular language

rln_name

Name of relative in English

rln_name_v1/2/3

Name of Relative in vernacular language

rln_type

Blood Group as per Driving License

gender

Name of Relative

age

Registered address as per Driving License

dob

Category of Vehicles the licensee is authorized to drive along with effective date

house_no

Validity of the license as per purpose of driving – transport or non-transport

part_name

Name of the part (Location) in the constituency applicable to the card holder

pc_name

Parliamentary Constituency applicable to the card holder

ac_name

Assembly Constituency applicable to the card holder

district

District of the Electoral Office

state

State of the registered Electoral Office

st_code

State Code

part_no

Number of the part (location) in the constituency applicable to the card holder

ps_lat_long

Lat Long for the polling booth applicable to the card holder

ps_name

Polling Booth Address applicable for the card holder

section_no

Section of the constituency part applicable to the card holder

slno_inpart

Serial number of the card holder in the polling list in the applicable part

id

Unique ID of the card holder [st_code+ ac_no + section_no + slno_inpart]

last_update

Last date of update to the records against the given epic_no in Government Records.

 

REQUEST JSON

Body Params

  • epic_no(require) - Voter ID Number

  • consent(require) - Consent of the end user to get their information for verification purpose

  • consent_text(require) - Purpose for which user has given their consent

Request timeout: 1 minute

OUTPUT

Transaction successful

 

{ "env": 1, "id": "2c63b3cf-75bc-444a-b49c-e8b36a91cac0", "request_timestamp": "2019-12-20 11:55:10:810 +05:30", "response_code": "101", "response_msg": "Success", "response_timestamp": "2019-12-20 11:55:21:717 +05:30", "result": { "ac_name": "Vikasnagar", "ac_name_v1": "विकासनगर", "ac_no": "16", "age": 24, "dist_name_v1": "देहरादून", "district": "Dehradun", "district_code": "13", "email_id": "", "epic_no": "NRB0399436", "gender": "M", "house_no": "278A", "id": "S280160053010315", "last_update": "Tue Jun 18 22:17:20 IST 2019", "mob_no": "9412975205", "name": "Mohak Talwal ", "name_v1": "मोहक तलवाल ", "name_v2": "", "name_v3": "", "part_name": "Vikasnagar West Part R.No.3", "part_name_v1": "विकासनगर पश्‍चिम भाग क.नं.3", "part_no": "53", "pc_name": "Tehri Garhwal", "pc_name_v1": "टिहरी गढ़वाल", "pc_no": "1", "ps_lat_long": "30.42012,77.68142", "ps_lat_long_0_coordinate": 30.42012, "ps_lat_long_1_coordinate": 77.68142, "ps_name": "Shri Hoshira Singh Buddhumal Jain Girls Inter College vikasnagar, p.o. vikasnagar,teshil- vikasnagar. district- dehradun 248198", "ps_name_v1": "श्री होशियार सिंह बुद्धुमल्‍ल जैन बालिका इण्‍टर कालेज विकासनगर, पो0 ओ0 विकासनगर, तहसील- विकासनगर, जिला- देहरादून 248198", "ps_no": "53", "rln_name": "Naresh Talwar ", "rln_name_v1": "नरेश तलवार ", "rln_name_v2": "", "rln_name_v3": "", "rln_type": "F", "section_no": "1", "slno_inpart": "315", "st_code": "S28", "state": "Uttarakhand", "status": "N" }, "transaction_status": 1 }

Transaction failure

Plain Text

{   "id": "<< Transaction ID >>",   "response_code": "102",   "env": 1,   "request_timestamp": "2018-09-19 18:08:55:947 +05:30",   "response_timestamp": "2018-09-19 18:08:57:366 +05:30",   "response_msg": "Invalid ID number or combination of inputs" }