TRANXACT.AI Help

Student Lifecycle · Students

Possible Duplicate Students

Every student whose name matches another record together with the date of birth or an email or phone — and, where Duplicate Check Settings says so, the same name alone (“Name only”, a lower-confidence match). Open both to compare. Different people: choose Not a duplicate and say why (or say why when saving with Create anyway), and the pair leaves this list.

Type REST7 operationsBase path /api/slcm/student-duplicatesPublished as /api/v1/student-duplicates

Download specification (OpenAPI 3.1) Screen: Possible Duplicate Students

Overview

PackageStudent Lifecycle
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Student Lifecycle › Possible Duplicate Students 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.
Tableslcm.students · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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/student-duplicatesList possible duplicate students

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "student_no": "STU-000001",
      "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "first_name": "Example",
      "last_name": "Example",
      "preferred_name": "Example",
      "email": "someone@example.com",
      "phone": "+1 555 0100",
      "date_of_birth": "2026-10-30",
      "nationality": "text",
      "address": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/slcm/student-duplicates?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/slcm/student-duplicates/{id}Read one student duplicates

Path parameters

NameTypeDescription
idstring (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",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "student_no": "STU-000001",
  "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "date_of_birth": "2026-10-30",
  "nationality": "text",
  "address": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/slcm/student-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/student-duplicates/{id}/not-duplicateNot duplicate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason*

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/student-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/not-duplicate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/slcm/student-duplicatesPost possible duplicate students

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/student-duplicates" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/student-duplicates/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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/student-duplicates/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/student-duplicates/{id}Put possible duplicate students

Path parameters

NameTypeDescription
idstring (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/student-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/slcm/student-duplicates/{id}Delete possible duplicate students

Path parameters

NameTypeDescription
idstring (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/student-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a student duplicates, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation id
student_notextread onlyStudent no
applicant_iduuidread onlyApplicant id
user_iduuidread onlyUser id
first_nametextread onlyFirst name
last_nametextread onlyLast name
preferred_nametextread onlyPreferred name
emailtextread onlyEmail
phonetextread onlyPhone
date_of_birthdateread onlyDate of birth
nationalitytextread onlyNationality
addresstextread onlyAddress
emergency_contacttextread onlyEmergency contact
program_iduuidread onlyProgram id
advisor_iduuidread onlyAdvisor id
admit_term_iduuidread onlyAdmit term id
expected_graduation_term_iduuidread onlyExpected graduation term id
enrollment_statustextread onlyEnrollment status
statustextread onlyStatus
cumulative_creditsnumericread onlyCumulative credits
cumulative_gpanumericread onlyCumulative gpa
academic_standingtextread onlyAcademic standing
residencytextread onlyResidency
cohorttextread onlyCohort
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
aid_grade_levelintegerread onlyAid grade level
housing_plantextread onlyHousing plan
account_iduuidread onlyAccount id
sponsor_account_iduuidread onlySponsor account id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Student Lifecycle › Possible Duplicate Students for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.