TietoEVRY

TietoEVRY Users service API

Operations for managing users.

GitHub OpenAPI

Operations 5

GET /sandbox/xs2a-vam/v1.3/users List users #
POST /sandbox/xs2a-vam/v1.3/users Create user #
GET /sandbox/xs2a-vam/v1.3/users/{user-id} Get user details #
PUT /sandbox/xs2a-vam/v1.3/users/{user-id} Edit user #
DELETE /sandbox/xs2a-vam/v1.3/users/{user-id} Delete user #

Documentation

📖
GettingStarted
https://openbanking.api.tietoevry.com/getting-started
📖
Documentation
https://openbanking.api.tietoevry.com/documentation
📖
Documentation
https://aggregation.api.tieto.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tietoevry/refs/heads/main/openapi/tietoevry-users-service-api-openapi.yml

Other Resources

🔗
SignUp
https://openbanking.api.tietoevry.com/sign-up
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/tietoevry/refs/heads/main/asyncapi/tietoevry-sepa-direct-debit-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tietoevry-users-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tietoevry-users-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Tietoevry vamapi Application - XS2A like Rest services
  version: '1.3'
  title: VAM API - XS2A like OpenAPI interface Users service API
servers:
- url: https://openbanking.api.tietoevry.com
security:
- APIKeyHeader: []
  APPIDHeader: []
  TokenTypeHeader: []
  TokenHeader: []
tags:
- name: Users service
  description: Operations for managing users.
paths:
  /sandbox/xs2a-vam/v1.3/users:
    parameters:
    - $ref: '#/components/parameters/X-Request-ID'
    - $ref: '#/components/parameters/PSU-ID'
    - $ref: '#/components/parameters/PSU-IP-Address'
    - $ref: '#/components/parameters/PSU-IP-Port'
    - $ref: '#/components/parameters/PSU-User-Agent'
    - $ref: '#/components/parameters/PSU-Accept'
    - $ref: '#/components/parameters/PSU-Accept-Charset'
    - $ref: '#/components/parameters/PSU-Accept-Encoding'
    - $ref: '#/components/parameters/PSU-Accept-Language'
    - $ref: '#/components/parameters/PSU-Device-ID'
    - $ref: '#/components/parameters/PSU-Geo-Location'
    get:
      tags:
      - Users service
      summary: List users
      description: Get list of users defined for the bank
      operationId: listUsers
      parameters:
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Signals that the users list was successfully retrieved.
          headers:
            X-Page-Number:
              description: Returned page number.
              schema:
                type: integer
            X-Page-Size:
              description: Returned page size.
              schema:
                type: integer
            X-Total-Elements:
              description: Total number of elements in list.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersResponse'
        '400':
          description: Format of certain request fields are invalid or not matching the XS2A requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '401':
          description: Authentication is required and has failed or has not yet been provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '403':
          description: The user is not authorized to access the given resource or functionality.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
    post:
      tags:
      - Users service
      summary: Create user
      description: Create user in context of specified bank
      operationId: createUser
      responses:
        '201':
          description: Signals that the users list was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '400':
          description: Format of certain request fields are invalid or not matching the XS2A requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '401':
          description: Authentication is required and has failed or has not yet been provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '403':
          description: The user is not authorized to access the given resource or functionality.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
  /sandbox/xs2a-vam/v1.3/users/{user-id}:
    parameters:
    - $ref: '#/components/parameters/user-id'
    - $ref: '#/components/parameters/X-Request-ID'
    - $ref: '#/components/parameters/PSU-ID'
    - $ref: '#/components/parameters/PSU-IP-Address'
    - $ref: '#/components/parameters/PSU-IP-Port'
    - $ref: '#/components/parameters/PSU-User-Agent'
    - $ref: '#/components/parameters/PSU-Accept'
    - $ref: '#/components/parameters/PSU-Accept-Charset'
    - $ref: '#/components/parameters/PSU-Accept-Encoding'
    - $ref: '#/components/parameters/PSU-Accept-Language'
    - $ref: '#/components/parameters/PSU-Device-ID'
    - $ref: '#/components/parameters/PSU-Geo-Location'
    get:
      tags:
      - Users service
      summary: Get user details
      description: Get details of specified user defined in context of the bank
      operationId: getUser
      responses:
        '200':
          description: Signals that the users list was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '400':
          description: Format of certain request fields are invalid or not matching the XS2A requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '401':
          description: Authentication is required and has failed or has not yet been provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '403':
          description: The user is not authorized to access the given resource or functionality.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
    put:
      tags:
      - Users service
      summary: Edit user
      description: Edit specified user defined in context of the bank
      operationId: editUser
      responses:
        '204':
          description: Signals that the user was successfully deleted.
        '400':
          description: Format of certain request fields are invalid or not matching the XS2A requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '401':
          description: Authentication is required and has failed or has not yet been provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '403':
          description: The user is not authorized to access the given resource or functionality.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
    delete:
      tags:
      - Users service
      summary: Delete user
      description: Delete specified user defined in context of the bank
      operationId: deleteUser
      responses:
        '204':
          description: Signals that the user was successfully deleted.
        '400':
          description: Format of certain request fields are invalid or not matching the XS2A requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '401':
          description: Authentication is required and has failed or has not yet been provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
        '403':
          description: The user is not authorized to access the given resource or functionality.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XS2AErrorResponse'
components:
  parameters:
    pageSize:
      name: pageSize
      in: query
      description: Number of entries per page number
      schema:
        type: integer
        default: 20
    PSU-IP-Port:
      name: PSU-IP-Port
      in: header
      description: IP port of the source application, if available.
      schema:
        type: string
    PSU-Accept-Charset:
      name: PSU-Accept-Charset
      in: header
      description: Accept-Charset header field of the source application, if available.
      schema:
        type: string
    X-Request-ID:
      name: X-Request-ID
      in: header
      description: ID of the request, unique to the call, as determined by the initiating party.
      required: true
      schema:
        type: string
    PSU-User-Agent:
      name: PSU-User-Agent
      in: header
      description: User-Agent header field of the source application, if available.
      schema:
        type: string
    PSU-Accept-Encoding:
      name: PSU-Accept-Encoding
      in: header
      description: Accept-Encoding header field of the source application, if available.
      schema:
        type: string
    PSU-Accept:
      name: PSU-Accept
      in: header
      description: Accept header field of the source application, if available.
      schema:
        type: string
    PSU-Geo-Location:
      name: PSU-Geo-Location
      in: header
      description: Geo Location of the source application, if available.
      schema:
        type: string
    pageNumber:
      name: pageNumber
      in: query
      description: Requested page number
      schema:
        type: integer
        default: 1
    PSU-Accept-Language:
      name: PSU-Accept-Language
      in: header
      description: Accept-Language header field of the source application, if available.
      schema:
        type: string
    PSU-Device-ID:
      name: PSU-Device-ID
      in: header
      description: UUID for a device, which is used by end user, if available.
      schema:
        type: string
    PSU-ID:
      name: PSU-ID
      in: header
      description: User ID of the user initiating the request.
      required: true
      schema:
        type: string
    PSU-IP-Address:
      name: PSU-IP-Address
      in: header
      description: IP address of the source application
      schema:
        type: string
    user-id:
      name: user-id
      in: path
      description: ID of the user as defined in VAM.
      required: true
      schema:
        type: string
  schemas:
    XS2AErrorResponse:
      type: object
      properties:
        tppMessages:
          type: array
          items:
            $ref: '#/components/schemas/XS2ATPPMessage'
    XS2APaginationLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/XS2AHref'
        first:
          $ref: '#/components/schemas/XS2AHref'
        next:
          $ref: '#/components/schemas/XS2AHref'
        previous:
          $ref: '#/components/schemas/XS2AHref'
        last:
          $ref: '#/components/schemas/XS2AHref'
    UsersResponse:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserResponse'
        _links:
          $ref: '#/components/schemas/XS2APaginationLinks'
    UserResponse:
      type: object
      properties:
        userId:
          type: string
          description: User Id of the user.
        userType:
          $ref: '#/components/schemas/UserType'
        customerId:
          type: string
          description: Customer Id of the user.
        numberOfVotes:
          type: integer
          description: Number of votes allowed for this user. Used in approval.
          format: int32
        activeFromDate:
          type: string
          description: The date from which this user is active. This is an ISO 8601 date string (YYYY-MM-DD)
          format: date
        activeToDate:
          type: string
          description: The date up to which this user would be active. This is an  ISO 8601 date string (YYYY-MM-DD)
          format: date
        firstName:
          type: string
          description: First name of the user.
        lastName:
          type: string
          description: Last name of the user.
        email:
          type: string
          description: Email address of the user.
        phone:
          type: string
          description: Phone number of the user.
        roles:
          type: object
          additionalProperties:
            type: integer
            description: Roles assigned to a user per bank Id.
            format: int32
          description: Roles assigned to a user per bank Id.
        isSuspended:
          type: boolean
          description: Set to true if the user is suspended, else set to false.
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/XS2AHref'
    XS2AHref:
      type: object
      properties:
        href:
          type: string
    XS2ATPPMessage:
      type: object
      required:
      - category
      - code
      properties:
        category:
          type: string
          enum:
          - ERROR
          - WARNING
        code:
          type: string
        path:
          type: string
          description: An explicit path to the request field causing error, if applicable.
        text:
          type: string
          maxLength: 512
          description: Additional explanatory text.
    UserType:
      type: string
      description: User type.
      enum:
      - BANK
      - CUST
      - CLNT
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key of pre configured client application.
    APPIDHeader:
      type: apiKey
      in: header
      name: X-APP-ID
      description: Application ID to be used for authentication against Generic SSO.
    TokenHeader:
      type: apiKey
      in: header
      name: X-Token
      description: Token to be used for authentication against Generic SSO
    TokenTypeHeader:
      type: apiKey
      in: header
      name: X-Token-Type
      description: Token type to be used for authentication against Generic SSO. This provides support for different types of token by different issuing systems