User

NOTE: Use the following endpoints only if you intend to store the personal information of your users on GIZO platform.

Update Profile

The endpoint is designed to handle requests for updating or modifying the profile information of a user. It allows users to make changes to their profile data, such as their name, email address, contact information, or any other relevant details.

patch

Authorizations

Body

application/jsontext/jsonapplication/*+json

firstNamestring · min: 1Required

lastNamestring · min: 1Required

emailstring | nullableOptional

birthDatestring · date-time | nullableOptionalExample: 2025-06-11

genderinteger · enumOptionalPossible values:

companyCodestring | nullableOptional

Responses

200

Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v3/User/profile HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "birthDate": "2025-06-11",
  "gender": 0,
  "companyCode": "text"
}

application/jsontext/jsonapplication/*+json

200

Success

{
  "userName": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "phoneNumber": "text",
  "profileImagePath": "text",
  "birthDate": "2025-06-11",
  "gender": 0
}

Header Request Parameters

Authentication Bearer Token

Request Body Parameters

firstName: first name of the user, and it is expected to be a string value, e.g."David".

lastName: last name of the user, and it is expected to be a string value. e.g. "Smith".

email: email of the user, and it is expected to be a string value, e.g. "[email protected]".

NOTE: email can be an empty text. If not, it must be sent in the proper format of email.

birthDate: the birthDate property represents the user's birth date. In the provided response, it is formatted as "yyyy-MM-dd", which indicates the date in ISO 8601 format. e.g. "1999-08-02".

gender: the gender property represents the user’s gender. Here, 0 is used for females, 1 for males, while 2 is used for unspecified.

companyCode: this property represents the code identifying a company to which a user is associated. It is expected to be a string value.

NOTE: company code is either null or string.

Response

The provided endpoint response contains several properties, including:

userName: this property represents the user's phone number. It is expected to be a string value, e.g. "+49_1747707607", where the "+49" on the left side of the underscore represents the country code, and "1747707607" on the right side of the underscore is the number.

firstName: this property represents the user's first name. It is expected to be a string value, e.g. “David”.

lastName: the lastName property represents the user's last name. It is also expected to be a string value, e.g. "Smith".

email: this property represents the user's email address. It is expected to be a string value, e.g. "[email protected]".

NOTE: email can be an empty text. If not, it must be sent in the proper format of email.

phoneNumber: the phoneNumber property represents the user's phone number. It is also expected to be a string value, e.g. "+49_1747707607", where the "+49" on the left side of the underscore represents the country code, and "1747707607" on the right side of the underscore is the number.

profileImagePath: this property represents the path or location of the user's profile image. It is expected to be a string value that specifies the image file location or URL, e.g. "ProfilePic/93/picture.jpg".

birthDate: the birthDate property represents the user's birth date. In the provided response, it is formatted as "yyyy-MM-dd", which indicates the date in ISO 8601 format, e.g. "1999-08-02".

gender: the gender property represents the user's gender. Here, 0 is used for females, 1 for males, and 2 for unspecified.

Update Profile Image

The endpoint is designed to handle requests for uploading or updating the profile image of a user. It allows users to provide an image file representing their profile picture or avatar.

patch

Authorizations

Body

ProfileImagestring · binaryOptional

Responses

200

Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/User/uploadProfileImage HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 25

{
  "ProfileImage": "binary"
}

200

Success

{
  "userName": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "phoneNumber": "text",
  "profileImagePath": "text",
  "birthDate": "2025-08-23",
  "gender": "Female"
}

Header Request Parameters

Authentication Bearer Token

Request Body Parameters

profileImage: it’s a profile picture or avatar that must be sent in multi-part/form-data format. It is expected to be a string value.

Response

The provided endpoint response contains several properties, including:

userName: this property represents the user’s phone number. It is expected to be a string value, e.g. “+49_1747707607”, where the "+49" on the left side of the underscore represents the country code, and "1747707607" on the right side of the underscore is the number.

firstName: this property represents the user’s first name. It is expected to be a string value, e.g. “David”.

lastName: the lastName property represents the user’s last name. It is expected to be a string value, e.g. “Smith”.

email: this property represents the user’s email address. It is expected to be a string value, e.g. “[email protected]“.

NOTE: email can be an empty text. If not, it must be sent in the proper format of email.

phoneNumber: the phoneNumber property represents the user’s phone number. It is also expected to be a string value, e.g. “+49_1747707607”, where the "+49" on the left side of the underscore represents the country code, and "1747707607" on the right side of the underscore is the number.

profileImagePath: this property represents the path or location of the user’s profile image. It is expected to be a string value that specifies the image file location or URL, e.g. “ProfilePic/93/picture.jpg”.

birthDate: the birthDate property represents the user’s birth date. In the provided response, it is formatted as “yyyy-MM-dd”, which indicates the date in ISO 8601 format, e.g. “1999-08-02”.

gender: the gender property represents the user’s gender. Here, 0 is used for females, 1 for males, and 2 for unspecified.

Update User First-time Use Initial

The endpoint is designed to handle requests for updating the initial information or settings associated with a user's profile. It allows users to modify their initial profile details or configuration.

NOTE: Initial is called when the user's profile data and the user's vehicle data get completed in first-time use.

patch

Authorizations

Responses

200

Success

application/json

Responseboolean

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/user/initial HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*

200

Success

true

Header Request Parameters

Authentication Bearer Token

Response

If it is true, it means that the procedure of collection of initial information from the user is completed.

Get Current User

The endpoint is designed to handle requests for retrieving or fetching the information of the currently authenticated user. It allows users to access their own profile or account details.

get

Authorizations

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/User/currentUser HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*

200

Success

{
  "userName": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "phoneNumber": "text",
  "profileImagePath": "text",
  "birthDate": "2025-06-11",
  "gender": 0,
  "isInitialized": true
}

Header Request Parameters

Authentication Bearer Token

Response

The provided endpoint response contains several properties, including:

userName: this property represents the user's phone number. It is expected to be a string value, e.g. "+49_1747707607", where the "+49" on the left side of the underscore represents the country code, and "1747707607" on the right side of the underscore is the number.

firstName: this property represents the user's first name. It is expected to be a string value, e.g."David".

lastName: the lastName property represents the user's last name. It is expected to be a string value, e.g. "Smith".

email: this property represents the user's email address. It is expected to be a string value, e.g. "[email protected]".

NOTE: email can be an empty text, if not, it must be sent in the proper format of email.

phoneNumber: the phoneNumber property represents the user's phone number. It is expected to be a string value, e.g. "+49_1747707607", where the "+49" on the left side of the underscore represents the country code, and "1747707607" on the right side of the underscore is the number.

profileImagePath: this property represents the path or location of the user's profile image. It is expected to be a string value that specifies the image file location or URL, e.g. "ProfilePic/93/picture.jpg".

birthDate: the birthdate property represents the user's birth date. In the provided response, it is formatted as "yyyy-MM-dd", which indicates the date in ISO 8601 format, e.g. "1999-08-02".

gender: the gender property represents the user's gender. Here, 0 is used for females, 1 for males, and 2 for unspecified.

isInitialized: the isInitialized property is a Boolean value (true or false). It shows whether the user uses the app for the first time or not, e.g. true.