How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yapily

Yapily User Beneficiaries API

User Beneficiaries Endpoints

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, 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.2.0
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Contact
Yapily Support
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), ResponseListMeta (3 properties), UserBeneficiaryData (3 properties). Each schema is shown below with its type and property counts.

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

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
AE Profile APIs.io
Yapily Consents and Authorisations API
AE Profile APIs.io
Yapily Payments API (PIS)
AE Profile APIs.io
Yapily Data Plus API
AE Profile APIs.io
Yapily Application Beneficiaries API
AE Profile APIs.io
Yapily Application Management API
AE Profile APIs.io
Yapily Authorisations API
AE Profile APIs.io
Yapily Constraints API
AE Profile APIs.io
Yapily Financial Data API
AE Profile APIs.io
Yapily Hosted Consent Pages API
AE Profile APIs.io
Yapily Hosted Payment Pages API
AE Profile APIs.io
Yapily Notifications API
AE Profile APIs.io
#User Beneficiaries
← Back to Y APIs
API Details
ID
yapily:yapily-user-beneficiaries-api
Base URL
https://api.yapily.com
Docs
https://docs.yapily.com/api/reference/
Provider
Yapily
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yapily-user-beneficiaries-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yapily-user-beneficiaries-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Yapily User Beneficiaries API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.