post https://example.com/api-gateway/v1/sign-up
Self sign up for patients
This API is used by a patient to sign up. The patient will be created with the provided information.
If registration code is provided - the patient will be assigned to the device linked to the provided registration code.
The Registration code must exist and be linked to a device.
That device should not be assigned to any patient, and be in the same organization as the patient or in the manufacturer's organization.
(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.
Request Body Parameters:
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| _name | object | true | ||
| _name.firstName | string | true(*) | A person's first name | John |
| _name.lastName | string | true(*) | A person's last name | Smith |
| _description | string | false | A description, can be up to 5000 characters long | Lorem Ipsum |
| _email | string | true | An email address in the RFC-5322 specification | [email protected] |
| _phone | string | false | A person's phone An E.164 formatted phone number | +12345678901 |
| _locale | string | false | A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase. | en-us |
| _gender | string | false | A persons gender Values:MALE,FEMALE,UNDISCLOSED | FEMALE |
| _dateOfBirth | string | false | A person's date of birth A UTC date in the ISO-8601 format | Thu Dec 20 00:00:00 UTC 2007 |
| _address | object | false | ||
| _address.countryCode | string | true(*) | A 2-letter country code defined in ISO-3166 | US |
| _address.state | string | false | A state | Massachusetts |
| _address.city | string | false | A city | Boston |
| _address.zipCode | string | false | A zipcode | 02101 |
| _address.address1 | string | false | An address | 11 Main St. |
| _address.address2 | string | false | An address's specifics | Entry B, Apartment 1 |
| _mfa | object | false | ||
| _mfa.enabled | boolean | true(*) | MFA login enabled or disabled | |
| _mfa.expirationInMinutes | integer | false | MFA expiration time in minutes | |
| _credentialType | string | false | What type of credentials is used when logging in to the system. Default:PASSWORD Values:PASSWORD,OTP | |
| _additionalPhone | string | false | An E.164 formatted phone number | +12345678901 |
| _nationalId | string | false | A person's national ID | 123456789 |
| _username | string | true | User's username. Can be an email or a regular username. With this username you login to the system. | [email protected] or john123 |
| _password | string | true | A password | Aa123456 |
| _deviceRegistrationCode | string | false | The registration code entity that is attached to the device | RegistrationCode123 |
| _ownerOrganization | object | true | ||
| _ownerOrganization.id | string | true(*) | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| _caregiver | object | false | ||
| _caregiver.id | string | true(*) | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
This API is public.