API Docs

__METHOD= GET . __PATH= /almaws/v1/users/{user_id}/personal-data .

Get user - data portability

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-data

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

Querystring Parameters

ParameterTypeRequiredDescription
user_id_typexs:stringOptional. Default: all_uniqueThe 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

CodeMessage
401890User with identifier X of type Y was not found.
401861User with identifier X was not found.
4019990User with source identifier X of institution Y was not found.
4019998User with linking ID not found.
60101General Error: An error has occurred while processing the request.
401861The user ID is not valid.
401890The user can not be found using this identifier.
60349The user data could not be added.