YOUNiQ Core services

API for YOUNiQ Core services.

Version: 1.0.0

/api/v1.0/users

GET

Summary

Get a list of users.

Description

Get a list of users. Constraints

• The list of credentials will only be populated with metadata, not the actual data. These are accessed via the credentials interface
• Credentials metadata will only be shown if the user has the right to see the metadata.

Parameters

Name	Located in	Description	Required	Schema
state	query	selects only users with the given states.	No	string

Responses

Code	Description
200	Ok.
401	Authorization information is missing or invalid access token.
403	Forbidden
5XX	Unexpected error.

POST

Summary

Create a new user.

Description

Create a new user. Id is set by YOUNiQ

Responses

Code	Description
201	Created Ok.
401	Authorization information is missing or invalid access token.
403	Forbidden.
409	Conflict.

/api/v1.0/users/{id}

GET

Summary

Get the data for a user.

Description

Get a user. Constraints

• The list of credentials will only be populated with metadata, not the actual data. These are accessed via the credentials interface
• Credentials metadata will only be shown if the user has the right to see the metadata.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of User	Yes	string (uuid)

Responses

Code	Description
200	Ok.
401	Authorization information is missing or invalid access token.
403	Forbidden
404	User with given id not found.

PATCH

Summary

Update data of the user.

Description

Update data of the user. Id and credentials are not patchable.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of User.	Yes	string (uuid)

Responses

Code	Description
200	OK.
400	Bad request.
401	Authorization information is missing or invalid access token.
403	Forbidden.
404	A user with the specified id was not found.
5XX	Unexpected error.

DELETE

Summary

Delete the user.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of User.	Yes	string (uuid)

Responses

Code	Description
204	Deleted ok.
400	Bad request.
401	Authorization information is missing or invalid access token.
403	Forbidden.
404	A user with the specified ID was not found.
5XX	Unexpected error.

/api/v1.0/users/{id}/invite

POST

Summary

Invite a user

Description

If the user is in the created state, it will be moved to the invited state and an invitation e-mail will be sent.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of User	Yes	string (uuid)

Responses

Code	Description
200	Ok.
400	Bad request. If the user is in the wrong state, not created.
401	Authorization information is missing or invalid access token.
403	Forbidden
404	User with given id not found.

/api/v1.0/users/{id}/credentials

GET

Summary

Get all the credentials data for specific user.

Description

Get all the credentials data for specific user, the binary data is only shown if the caller has the right to see the data.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of User.	Yes	string (uuid)

Responses

Code	Description
200	Ok.
401	Authorization information is missing or invalid access token.
403	Forbidden.
404	Credentials for user with given id not found.
5XX	Unexpected error.

POST

Summary

Store a credential for a specific user.

Description

Store a credential for a specific user. Currently type 'Face' is supported.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of user	Yes	string (uuid)

Responses

Code	Description
201	Successfully created a credential.
400	Bad request.
401	Authorization information is missing or invalid access token.
403	Forbidden.
404	User with given id not found.
5XX	Unexpected error.

/api/v1.0/users/{id}/credentials/{cid}

GET

Summary

Get a specific credential data for this user.

Description

Get a specific credentials data for this user, the binary data is only shown if the caller has the right to see the data.

Parameters

Name	Located in	Description	Required	Schema
id	path	Id of User.	Yes	string (uuid)
cid	path	Id of credential.	Yes	string (uuid)

Responses

Code	Description
200	Ok.
401	Authorization information is missing or invalid access token.
403	Forbidden.
404	User or credentials with given id not found.
5XX	Unexpected error.

Models

User

User is an actual identifiable person.

Name	Type	Description	Required
id	string (uuid)	Identification for user, given by YOUNiQ. Example: "c2f041fc-3c74-4757-bc40-f5947ff54ba3"	No
organizationId	string (uuid)	Id of the organization the user belongs to. Example: "c2f041fc-3c74-4757-bc40-f5947ff54ba3"	No
name	string	Full name of the user. Example: "James Brown"	No
email	string	Email for the user. Example: "firstname.lastname@example.com"	No
state	string	Defines the state of the user. 'created' - The user is added to the system. 'invited' - The user added to the system and an invitation is sent. * 'enrolled' - The user has been added to the system with a selfie. Enum: "created", "invited", "enrolled"	No
invitationCode	string	invitation code used for registration.	No
dataSource	string	The original source for the user. Example: "MemberSystem ABC"	Yes
credentials	[ object ]	Biometric data or passwords belonging to an user.	No
linkedUserData	[ object ]	Data about the user used by integrations.	No

LinkedUserData

User data used by an integration to handle a user.

Name	Type	Description	Required
systemName	string	Name of external system. Example: "Themesong Player V1.0"	No
externalId	string	External id. Example: "c2f041fc-3c74-4757-bc40-f5947ff54ba3"	No
externalData	undefined (byte)	External data. The contents depends on the external system. And is used by the external system when the user is identified. If the data is secret it should be end to end encrypted. Example: "base64-encoded file contents"	No

CreateCredentialResponse

Name	Type	Description	Required
id	string (uuid)	Example: "c2f041fc-3c74-4757-bc40-f5947ff54ba3"	No

Credentials

Name	Type	Description	Required
id	string (uuid)	Identification for the credential object. Example: "c2f041fc-3c74-4757-bc40-f5947ff54ba3"	No
type	string	Defines different credential types. 'face' - Data is an image with a face. 'qr' - Quick Response code data. Enum: "face", "qr"	No
mimeType	undefined (string)	The mimetype of the credential. Example: "image/jpeg"	No
data	undefined (byte)	Biometric data or credential. Example: "base64-encoded file contents."	No
createdDate	dateTime	Date and time the credential object was created. Example: "2020-07-21T20:35:45Z"	No

UnauthorizedError

Authorization information is missing or invalid access token.

Name	Type	Description	Required
UnauthorizedError		Authorization information is missing or invalid access token.

UserStates

Defines the state of the user.

• 'created' - The user is added to the system.
• 'invited' - The user added to the system and an invitation is sent.
• 'enrolled' - The user has been added to the system with a selfie.

Name	Type	Description	Required
UserStates	string	Defines the state of the user. 'created' - The user is added to the system. 'invited' - The user added to the system and an invitation is sent. * 'enrolled' - The user has been added to the system with a selfie.

CredentialType

Defines different credential types.

• 'face' - Data is an image with a face.
• 'qr' - Quick Response code data.

Name	Type	Description	Required
CredentialType	string	Defines different credential types. 'face' - Data is an image with a face. 'qr' - Quick Response code data.