Unregistered Applicants Validation API Details#

This API is used to validate Mobile Number and Email Address of unregistered applicants

Route

/basic/gstn/{flynn-version}/commonapi/{gstn-api-version}/unregistered-applicants-validation?action={action}&uid={uid}&email={email_id}&mobile={mobile_number}

active ‘flynn-version’: v1.0
method: GET

URL Parameters#

Name	Description	Type
flynn-version	version of the API for example, v1.0	string
gstn-api-version	as per the version of the GST API Documentation for example, v1.0	string

QUERY Parameters#

Name	Description	Type
uid	UID of the Unregistered Applicants for example, 292200000001ES9	string
action	Api action for example, TP	string
email	Email of Unregistered Applicant used in E-Commerce website for example, abcd@gmail.com	string
mobile	Mobile Number of Unregistered Applicant used in E-Commerce website for example, 9898989898	string

Note : Either mobile number or Email id is mandatory in query params

Headers#

All required headers to make an authenticated API call.

Apart from the common headers need to pass below headers

header	Description
X-FLYNN-N-GSTIN	GST Identification Number for example, 33GSPTN0791G1Z5
X-FLYNN-N-GSTN-GSP-CODE	vay

Response#

`200`#

Successful response will be the same payload as per the ‘GST API Documentation’ for the “Unregistered Applicants Validation” API.

Sample Response Body

{
  "status": "1",
  "data": {
    "Enrolment Number": "372300000015ES1",
    "Mobile Number": "matched",
    "Email Address": "unmatched"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Errors#

GSTN Error

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-gstn-returned-error",
        "type": "Gstn",
        "args": {
            "details": [
                {
                    "ErrorCode": "FO8015",
                    "ErrorMessage": "Please provide at least 1 value to validate."
                }
            ]
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}

Invalid UID

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-gstn-returned-error",
        "type": "Gstn",
        "args": {
            "details": [
                {
                    "ErrorCode": "FO8012",
                    "ErrorMessage": "The Enrolment Id passed in the request is invalid."
                }
            ]
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}

Client Error

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-param-is-mandatory",
        "type": "ClientRequest",
        "args": {
            "parameter-name": "uid"
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}

Response Status	Description
400	Invalid GSTN API Version
502	Error at GSTN end

Common Errors

check here for other common errors.