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 User Beneficiaries API

User Beneficiaries Endpoints

Yapily User Beneficiaries 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 User Beneficiaries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 7 operations across 4 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.

7 operations 4 paths 16 schemas 1 DELETE2 GET1 PATCH3 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 User Beneficiaries 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 7

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

User Beneficiaries 7

User Beneficiaries Endpoints

POST
/users/{userId}/beneficiaries
Create Beneficiary
createUserBeneficiary 2 params body → 200400401404409429500
GET
/users/{userId}/beneficiaries
Get All Users Beneficiaries
getUserBeneficiaries 1 param → 200400401404500
PATCH
/users/{userId}/beneficiaries/{beneficiaryId}
Patch User Beneficiary
patchUserBeneficiary 3 params body → 200400401404409429500
GET
/users/{userId}/beneficiaries/{beneficiaryId}
Get Beneficiary by Id
getUserBeneficiary 3 params → 200400401429500
DELETE
/users/{userId}/beneficiaries/{beneficiaryId}
Delete User Beneficiary by Id.
deleteUserBeneficiary 3 params → 204400401429500
POST
/users/{userId}/beneficiaries/{beneficiaryId}/approve
Approve Beneficiary
approveBeneficiary 3 params body → 200400401404429500
POST
/users/{userId}/beneficiaries/{beneficiaryId}/reject
Reject Beneficiary
rejectBeneficiary 3 params body → 200400401404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are FilterAndSort (6 properties), Next (4 properties), Pagination (3 properties), UserBeneficiaryValidationRequest (3 properties). Each schema is shown below with its type and property counts.

SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
Next
object
4 properties
FilterAndSort
object
6 properties
ResponseMeta
object
1 property
ResponseListMeta
object
3 properties
Pagination
object
3 properties
BeneficiaryMatchStatus
string
ApiErrorResponseV2
object
API Error Response
1 property
PatchOperation
string
The operation to be performed
AccountIdentifier
object
Account's details.
2 properties 2 required
UserBeneficiaryMatch
object
Details of the match given by the institution.
2 properties
UserBeneficiaryValidationRequest
object
Beneficiary request with the details of the VoP result.
3 properties 2 required
UserBeneficiaryData
object
Beneficiary data response.
3 properties
UserBeneficiaryResponse
object
The user beneficiary response.
2 properties
BeneficiaryStatus
string
Status of the beneficiary check.
AccountIdentifierType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-user-beneficiaries-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