Institution User Creation API

Institution User Creation API

Institution User Creation API

This guide explains how to create a new user through the institution API.

info

This endpoint is only available for accredited institutions. Contact us to become accredited.

Endpoint

POST /v2/institutions/users Authentication is performed with the X-Institution-API-Key header.

Request Body

FieldTypeRequiredDescription
emailstringyesEmail address of the new user.
namestringnoDisplay name of the user.
languagestringnoPreferred language (default de).
send_pw_reset_emailboolnoWhether to send a password reset email.

Example request using curl:

curl -X POST https://api.44ai.ch/v2/institutions/users \
-H "X-Institution-API-Key: <INSTITUTION_KEY>" \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","name":"Jane Doe","language":"de","send_pw_reset_email":true}'

Successful Response

201 Created with the following payload:

{
"id": "<user-id>",
"email": "user@example.com",
"name": "Jane Doe",
"language": "de",
"institution_id": "<institution-id>",
"password_reset_sent": true,
"created": "2024-01-01T12:00:00Z",
"api_key": ""
}

The endpoint automatically adds the user to the institution's default patient and template groups if configured. User creation will fail if the institution disabled user creation or if the email already exists.

    • Popular Articles

    • Funktionen

      Funktionen Konsultationsübersicht In der Konsultationsübersicht, sehen Sie alle Konsultationen die geplant, in Bearbeitung oder bereits abgeschlossen sind. Sie können Konsultationen entsprechend filtern oder nach ihnen suchen. Starten Sie eine ...
    • Patienten

      Patienten info Für den Zugriff auf eine Patientengruppe benötigen Sie die entsprechende Berechtigung. Für die Aufnahme in eine entsprechende Gruppe müssen Sie sich an den Admin Ihrer Institution wenden. Wollen Sie Ihre persönliche Patientengruppe ...
    • Registrierung

      Registrierung Eine Anmeldung ist mit jeder gängigen E-Mail Adresse möglich. Folgen Sie den nächsten Schritten, um ein Konto zu erstellen und sich anzumelden. info Verwenden Sie Ihre HIN-Adresse, um den Secure-Mail-Transfer zu nutzen. Besuchen Sie ...
    • Einstellungen

      Einstellungen Konto Mit einem Klick auf “Einstellungen” im Feld unten links, gelangen Sie zu Ihren Kontoeinstellungen. Hier können Sie die Standardeinstellungen bezüglich Sprache, Glossar sowie bezüglich Notizen- und Berichtsvorlage anpassen. ...
    • API Overview

      API Overview Welcome to the Haidy API documentation. Our API suite enables you to integrate powerful medical audio and document processing capabilities into your healthcare applications and workflows. What is the Haidy API? The Haidy API provides a ...