GET
/api/v1/student-documents/:studentIdList
student:viewSCREEN GUIDE · 11 OCT 2026
Student profile & guardians
Use student profile & guardians in the school workspace. Maintain student profiles, guardians and documents, and manage campus release or school exit.
OVERVIEW
What you can do
01
Verify
02
Send back
03
Remove
04
List
05
Upload a document for a student
06
Mark a document as checked against the original
07
Send a document back with a reason
08
Get Profile360
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
Required permission keys
student:viewstudent:updatestudent:managestudent:deleteUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Create or open the student profile
A school account with the permissions shown below.
- 02
Review guardian contacts and required documents
Send back is part of the documented workflow.
- 03
Use the gate-pass workflow for an authorized early release
Remove is part of the documented workflow.
- 04
Use clearance and exit workflows for withdrawal or transfer
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
type | string | Required by declaration |
title | string | Optional |
expiresAt | string | Optional |
reason | string | Required by declaration |
CURRENT BEHAVIOUR
Rules & current limits
- Campus release is distinct from withdrawal from the school rolls. Transfer certificates require a valid exited record.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try student profile & guardians
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
6 source-declared operations
POST
/api/v1/student-documents/:studentIdUpload a document for a student
student:updateDeclared request fields: type (required), title (optional), expiresAt (optional).
POST
/api/v1/student-documents/verify/:idMark a document as checked against the original
student:managePOST
/api/v1/student-documents/reject/:idSend a document back with a reason
student:manageDeclared request fields: reason (required).
DELETE
/api/v1/student-documents/:idRemove
student:deleteGET
/api/v1/students/:id/profile-360Get Profile360
student:viewOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.