Add Client

The user needs to be added as a Quicko's ERI client. To add a user as a client, the PAN number and D.O.B of the user are required.

ERI or E-Return Intermediary are authorized by the Income Tax Department to assist taxpayers in filing their income tax returns on their behalf

get
Add Client

https://api.sandbox.co.in/itd/eri/authorize/otp
Adding a user as Quicko's ERI client
Request
Response
Request
Path Parameters
pan
required
string
dob
required
string
Headers
Authorization
required
string
JWT Authorization token
x-api-key
required
string
Public key required to authorize API access.
x-api-version
required
string
Response
200: OK
{
"code": 200,
"timestamp": 1616657388923,
"transaction_id": "206bafdf-af4c-44d3-a591-35d32b2454cf",
"data": {
"pan": "XXXPX1234A",
"transaction_id": "10215481234"
}
}
422: Unprocessable Entity
Invalid Pan pattern
PAN is already added as a client
Invalid DOB
Invalid DOB format
PAN does not exist
PAN is not registered in E-filing
Invalid Pan pattern
{
"code": 422,
"timestamp": 1616657356446,
"transaction_id": "68fe2c10-fe73-4675-aef3-56643c6767fe",
"message": "Invalid Pan pattern"
}
PAN is already added as a client
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "PAN is already added as a client"
}
Invalid DOB
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "Invalid DOB"
}
Invalid DOB format
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "Invalid DOB format"
}
PAN does not exist
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "PAN does not exist"
}
PAN is not registered in E-filing
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "PAN is not registered in E-filing"
}

Error Messages

Scenario

Error Message

If entered PAN is already added as a client

The PAN is already added as a client

If entered PAN is not registered with E-filing

PAN is not registered in E-filing

if entered PAN is invalid

PAN does not exist. Please retry

if entered D.O.B format is wrong

Invalid date of Birth. Please enter a valid date in DD/MM/YYYY format.

if entered D.O.B is wrong

Invalid date of Birth.

The user will receive OTP on his registered mobile number and email. This OTP verification authorizes Quicko to obtain the user's Tax details.

Mobile OTP
Email OTP
Mobile OTP
Email OTP

Reference

post
OTP Verification

https://api.sandbox.co.in/itd/eri/authorize/otp
Verify the OTP received by the user on their registered email and mobile number
Request
Response
Request
Path Parameters
transaction_id
required
string
email_otp
required
string
mobile_otp
required
string
Headers
Authorization
required
string
x-api-key
required
string
x-api-version
required
string
Response
200: OK
{
"code": 200,
"timestamp": 1616657388923,
"transaction_id": "206bafdf-af4c-44d3-a591-35d32b2454cf",
"data": {
"pan": "XXXPX1234A",
"status": “Assessee has been added successfully as a client"
}
}
422: Unprocessable Entity
Invalid Pan pattern
PAN is already added as a client
Invalid transaction id
Invalid mobile otp
Invalid email otp
PAN does not exist
PAN is not registered in E-filing
Invalid Pan pattern
{
"code": 422,
"timestamp": 1616657356446,
"transaction_id": "68fe2c10-fe73-4675-aef3-56643c6767fe",
"message": "Invalid Pan pattern"
}
PAN is already added as a client
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "PAN is already added as a client"
}
Invalid transaction id
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "Invalid transaction id"
}
Invalid mobile otp
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "Invalid mobile otp"
}
Invalid email otp
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "Invalid email otp"
}
PAN does not exist
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "PAN does not exist"
}
PAN is not registered in E-filing
{
"code": 422,
"timestamp": 1616657388923,
"transaction_id": "f10e86ac-da7c-460a-bc4c-702b3cc4fc96",
"message": "PAN is not registered in E-filing"
}