Student Lifecycle · Financial Aid (US)
ISIR Records
Each ISIR transaction received, the student it matched (by SSN, else date of birth and name) and what it says: SAI, dependency, Pell eligibility, verification, C-codes. The SSN shows as its last four.
/api/slcm/isir-recordsPublished as /api/v1/isir-recordsOverview
| Package | Student Lifecycle |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Student Lifecycle › ISIR Records on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | slcm.isir_records · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/isir-recordsList isir records
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"import_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"award_year": "text",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"match_status": "draft",
"match_method": "text",
"transaction_number": 10,
"transaction_receipt_date": "2026-10-30",
"fafsa_uuid": "text",
"first_name": "Example",
"last_name": "Example",
"date_of_birth": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/isir-records?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/isir-records/{id}Read one isir records
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"import_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"award_year": "text",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"match_status": "draft",
"match_method": "text",
"transaction_number": 10,
"transaction_receipt_date": "2026-10-30",
"fafsa_uuid": "text",
"first_name": "Example",
"last_name": "Example",
"date_of_birth": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/isir-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/isir-records/{id}/matchMatch
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
student_idResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/isir-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"value"}'POST/api/slcm/isir-recordsPost isir records
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/isir-records" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/isir-records/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/isir-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/slcm/isir-records/{id}Put isir records
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/isir-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/isir-records/{id}Delete isir records
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/slcm/isir-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a isir records, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
import_id | uuid | read only | Import id |
line_no | integer | read only | Line no |
award_year | text | read only | Award year |
student_id | uuid | read only | Student id |
match_status | text | read only | Match status |
match_method | text | read only | Match method |
transaction_number | integer | read only | Transaction number |
transaction_receipt_date | date | read only | Transaction receipt date |
fafsa_uuid | text | read only | Fafsa uuid |
first_name | text | read only | First name |
last_name | text | read only | Last name |
date_of_birth | date | read only | Date of birth |
ssn_cipher | bytea | read only | Ssn cipher |
ssn_hash | text | read only | Ssn hash |
ssn_last4 | text | read only | Ssn last4 |
dependency_status | text | read only | Dependency status |
sai | integer | read only | Sai |
sai_formula | text | read only | Sai formula |
pell_eligible | boolean | read only | Pell eligible |
verification_selected | boolean | read only | Verification selected |
verification_group | text | read only | Verification group |
c_flag | boolean | read only | C flag |
c_codes | _text | read only | C codes |
school_codes | _text | read only | School codes |
raw_masked | text | read only | Raw masked |
is_current | boolean | read only | Is current |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Student Lifecycle › ISIR Records for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.