Parent API: GST API Quickstart guide Authentication guide

GST Unregistered Applicant Validation

Q: What parameters and payload format are required for Unregistered Applicants Validation?

Requests are submitted via HTTP GET to '/public/unregistered-applicants-validation'. Required parameters: 'uid' (query parameter), 'email' (query parameter), 'ip_address' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). No request body payload is required for this call.

Q: What response status codes and format does Unregistered Applicants Validation return?

For Unregistered Applicants Validation (GET '/public/unregistered-applicants-validation'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

GEThttps://apisandbox.whitebooks.in/public/unregistered-applicants-validation

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

Parameters

query parameters

uidstringrequired

EnrolmentId of Unregistered Applicants

ecomEmailstringoptional

Email of Unregistered Applicant used in E-Comerce website

mobilestringoptional

Mobile Number of Unregistered Applicant used in E-Comerce website

emailstringrequired

header parameters

ip_addressstringrequired

IP Address

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Response

Not Found. If requested entity is not found or if requested API is not found.

Frequently Asked Questions

Requests are submitted via HTTP GET to /public/unregistered-applicants-validation. Required parameters: uid (query parameter), email (query parameter), ip_address (header parameter), client_id (header parameter), client_secret (header parameter). No request body payload is required for this call.

For Unregistered Applicants Validation (GET /public/unregistered-applicants-validation), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

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

Unregistered Applicants API

Request for OTP

GET/public/unregistered-applicants-validation

1const response = await fetch('https://apisandbox.whitebooks.in/public/unregistered-applicants-validation?uid=value&ecomEmail=value&mobile=value&email=value', {

2 method: 'GET',

3 headers: {

4 ip_address: "value",

5 client_id: "value",

6 client_secret: "value"

7},

8});

10const data = await response.json();

11console.log(data);

No example available.