Sign in
credit-registration-admin

POST `/api/v0/main-frontend/credit-registration-admin/account-linking/resolve-person` - Looks one student number up in the study registry without changing anything. The preview a manual link is gated on. Writes nothing but the call log row every study registry call writes.

Changed on
post/api/v0/main-frontend/credit-registration-admin/account-linking/resolve-person

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

student_numberstring required

Response

Who the study registry says the number belongs to

already_linked_to_user_emailstring nullable
already_linked_to_user_idstring uuid nullable
already_linked_via'emailed_link' | 'admin_manual' | 'study_registry'

How a student number was proven to belong to an account.

codestring nullable

The registry's own per-item code, an identifier rather than prose.

first_namesstring nullable
foundboolean required
last_namestring nullable
lookup_error_codestring nullable

The registry's per-item code when it answered with an error other than personNotFound, which leaves it unknown whether the number exists.

sisu_person_idstring nullable

Echoed back to the manual-link endpoint, which refuses without it.

student_numberstring required
study_registry_unavailableboolean required

Changes

  • a9e34d23136aRevision changes
    • ●

      added the new study_registry enum value to the //// response property for the response status

    • ○

      added the optional property to the response with the status

    • ○

      removed the email_match_fast_track enum value from the //// response property for the response status

  • 7c5f18aafa45Revision changes
    • ○

      endpoint added