NATIONAL SCHOLARSHIP

PORTAL (NSP 2.0)

API Specifications Document

National Informatics Centre

Department of Electronics & Information Technology (Deity),
Ministry of Communication & Information Technology,
Government of India
 NATIONAL SCHOLARSHIP PORTAL (NSP 2.0) API SPECIFICATIONS DOCUMENT

Technology: Restful web service

Request Body: Scholarship data in XML format
Usage: This web service will insert beneficiary data to NSP Portal database.
Limitation: It only appends beneficiaries’ data into existing data.
Server URL: /scholarships
Pre-Conditions:
1. Ensure that your scheme master tables should be mapped with NSP Portal master
tables.
2. Data should be prepared in the XML format described below for pushing to NSP
Portal.
Response Code: Standard HTTP codes.
Details of Fields in XML File:

S. No. Field Name Field Type Description

1 applicantName String Name of the Applicant

2 dateOfBirth Date Date of Birth

3 gender Alphabetic Gender (Refer Table 1)

4 religionId Numeric Religion Code (Refer Table 2)

5 categoryId Numeric Category Code (Refer Table 3)

6 disability Boolean Disability Flag (True/False)

7 mobileNumber String Mobile Number

8 emailId String Email Address

9 aadhaarNumber String Aadhaar Number

10 aadhaarEnrolmentNumber String Aadhaar Enrolment Number (If no

Aadhar)

11 aadhaarEnrolmentDate Date Aadhaar Enrolment Date (If no Aadhar)

12 bankBranchIfscCode String Branch IFSC Code

13 bankAccountNumber String Bank Account Number

14 motherName String Name of Mother

15 fatherName String Name of Father

Page 1 of 5
 NATIONAL SCHOLARSHIP PORTAL (NSP 2.0) API SPECIFICATIONS DOCUMENT

S. No. Field Name Field Type Description

16 annualFamilyIncome Numeric Annual Family Income

17 domicileStateId Numeric Domicile State

18 domicileDistrictId Numeric Domicile District

19 ministryId Numeric Ministry Code (Refer Table 4)

20 scholarshipName String Scholarship/Fellowship Name

21 schemeId Numeric Scheme Specific Unique ID

22 scholarshipStartYear Numeric Starting year of Scholarship

23 scholarDuration Numeric Duration of Scholarship in Years

24 diseOrAisheCode String DISE/AISHE Code

25 schoolCollegeStateId Numeric School/College State

26 schoolCollegeDistrictId Numeric School/College District

27 schoolCollegeName String School/College Name

28 scholarshipCategoryId Numeric Scholarship Category (Pre / Post Matric)

29 currentCourseName String Current Course Name

30 scholarshipAmount Numeric Scholarship Amount Transferred

31 scholarshipPaymentDate Date Scholarship Payment Date

32 fundTransferMethod Numeric Fund Transfer Method (Refer Table 5)

33 pfmsSchemeCode Numeric PFMS Scheme Code

34 pfmsBeneficiaryId AlphaNumeric PFMS beneficiary ID

Page 2 of 5
 NATIONAL SCHOLARSHIP PORTAL (NSP 2.0) API SPECIFICATIONS DOCUMENT

Table 1: Gender Code – Alphabetic Table 4: Ministry Code – Numeric

F Female 1 Ministry of Social Justice & Empowerment

M Male Department of Empowerment of Persons with

2
Disabilities
O Others
3 Department of Higher Education
4 Ministry of Tribal Affairs
Table 2: Religion ID – Numeric
5 Ministry of Minority Affairs
1 Hindu 6 Ministry of Social Justice & Empowerment
2 Muslim 7 Department of School Education & Literacy
3 Christian 8 Ministry of Human Resource Development
4 Sikh 9 Ministry of Labour & Employment
5 Parsi 10 Ministry of Home Affairs
6 Jain 11 North Eastern Council (NEC)
7 Buddhist 12 Ministry of Railways (Railway Board)
8 Others

Table 3: Category ID – Numeric Table 5: Fund Transfer Method – Numeric

1 SC

2 ST

3 OBC

4 GENERAL

1 Cash Payment

2 ABP (Aadhar Based Payment)

3 NEFT

4 PFMS

5 Others

Sample XML Format

<scholarship>
<applicantName>MyName</applicantName>

Page 3 of 5
 NATIONAL SCHOLARSHIP PORTAL (NSP 2.0) API SPECIFICATIONS DOCUMENT

……
……
……
<pfmsBeneficiaryId>VC0001456</pfmsBeneficiaryId>
</scholarship>

Page 4 of 5
 NATIONAL SCHOLARSHIP PORTAL (NSP 2.0) API SPECIFICATIONS DOCUMENT

Data set to be send to NSP through APIs by Ministries/Departments which are not on-boarded
S. No. Description
1 Name of the Applicant
2 Date of Birth
3 Gender
4 Religion Code
5 Category Code (SC/ST/OBC Etc)
6 Disability Flag (True/False)
7 Mobile Number
8 Email Address
9 Aadhaar Number
10 Aadhaar Enrolment Number (If no Aadhar)
11 Aadhaar Enrolment Date (If no Aadhar)
12 Branch IFSC Code
13 Bank Account Number
14 Name of Mother
15 Name of Father
16 Annual Family Income
17 Domicile State
18 Domicile District
19 Ministry Code
20 Scholarship/Fellowship Name
21 Scheme Specific Unique ID
22 Starting year of Scholarship
23 Duration of Scholarship in Years
24 DISE/AISHE Code
25 School/College State
26 School/College District
27 School/College Name
28 Scholarship Category (Pre / Post Matric)
29 Current Course Name
30 Scholarship Amount Transferred
31 Scholarship Payment Date
32 Fund Transfer Method
33 PFMS Scheme Code
34 PFMS beneficiary ID

Page 5 of 5