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

Application Beneficiaries Endpoints

Yapily Application 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 Application 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 4 operations across 2 paths, and defines 12 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.

4 operations 2 paths 12 schemas 1 DELETE2 GET1 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 Application 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 4

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

Application Beneficiaries 4

Application Beneficiaries Endpoints

POST
/applications/{applicationId}/beneficiaries
Create Application Beneficiary
createApplicationBeneficiary 1 param body → 200400401404409429500
GET
/applications/{applicationId}/beneficiaries
Get All Application Beneficiaries
getApplicationBeneficiaries 1 param → 200401500
GET
/applications/{applicationId}/beneficiaries/{beneficiaryId}
Get Application Beneficiary by Id
getApplicationBeneficiaryById 2 params → 200400401404500
DELETE
/applications/{applicationId}/beneficiaries/{beneficiaryId}
Delete Application Beneficiary by Id
deleteApplicationBeneficiaryById 2 params → 204400401404500

Schemas 12

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

Next
object
4 properties
BeneficiaryId
string
Beneficiary Id
FilterAndSort
object
6 properties
ResponseMeta
object
1 property
ResponseListMeta
object
3 properties
Pagination
object
3 properties
ApplicationBeneficiaryData
object
Application beneficiary data response.
2 properties
ApiErrorResponseV2
object
API Error Response
1 property
AccountIdentifier
object
Account's details.
2 properties 2 required
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
ApplicationBeneficiaryResponse
object
Application beneficiary response.
2 properties
AccountIdentifierType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-application-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 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
Yapily User Beneficiaries API