Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yapily Users API

The Users endpoints are used to manage each user (otherwise known as the PSU) in Yapily. Each user belongs to an Application and as a consequence, so do each `Consent` created for a particular `User`.

Yapily Users API is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.1, at version 12.4.0.

Requests are made against a single base URL, https://api.yapily.com.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Yapily Users API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the [Yapily Console](https://conso…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Users 5

The Users endpoints are used to manage each user (otherwise known as the PSU) in Yapily. Each user belongs to an Application and as a consequence, so do each Consent created for a…

GET
/users
Get Users
getUsers 1 param → 200default
POST
/users
Create User
addUser body → 201default
PATCH
/users/{userUuid}
Update User
patchUser 1 param body → 201default
DELETE
/users/{userUuid}
Delete User
deleteUser 1 param → 200default
GET
/users/{userUuid}
Get User
getUser 1 param → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are RawRequest (8 properties), ApplicationUser (7 properties), ApiError (6 properties), ApiResponseOfUserDeleteResponse (6 properties). Each schema is shown below with its type and property counts.

ApiResponseOfUserDeleteResponse
object
6 properties
ConsentDeleteResponse
object
5 properties
DeleteStatusEnum
string
Indicates the outcome of the delete request.
ResponseMeta
object
1 property
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
UserDeleteResponse
object
Deletion of the user. Includes the user profile and all associate consents.
4 properties
NewApplicationUser
object
Details of a new user to be created for the application.
3 properties
PatchOperation
string
The operation to be performed
ApiResponseError
object
Used to return errors from the bank from each request - 400 - Returned by any POST endpoint when the body does not conform to the contract - 401 - Returned by…
2 properties
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
ApplicationUserPatchRequest
object
3 properties 3 required
RawRequest
object
8 properties
InstitutionConsent
object
Institution authorised consents which are currently in place for the Application User.
1 property
ResponseForwardedData
object
2 properties
ApplicationUser
object
Information about a user of an application.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-users-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
Yapily Consents and Authorisations API
Yapily Payments API (PIS)
Yapily Data Plus API
Yapily Application Beneficiaries API
Yapily Application Management API
Yapily Authorisations API
Yapily Constraints API
Yapily Financial Data API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API