API Docs
Get user - data portability
Contents
This Web service returns a specific user's full details, including all loans, requets etc.
This API is intended do be used to comply with GDPR data portability.
Resource URL
GET /almaws/v1/users/{user_id}/personal-dataAPI Description
URL Parameters
| Parameter | Type | Description |
|---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. The value may also be linking_id. To search for users which have linked accounts in other institutions according to the linking_id use user_id_type=linking_id. |
Body Parameters
None
Output
This method returns a User Personal object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401890 | User with identifier X of type Y was not found. |
| 401861 | User with identifier X was not found. |
| 4019990 | User with source identifier X of institution Y was not found. |
| 4019998 | User with linking ID not found. |
| 60101 | General Error: An error has occurred while processing the request. |
| 401861 | The user ID is not valid. |
| 401890 | The user can not be found using this identifier. |
| 60349 | The user data could not be added. |