> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/products/spar/features/spar-self-service.md).

# SPAR Beneficiary Portal

Providing self-update features for beneficiaries via the Beneficiary Portal API

The SPAR Beneficiary Portal lets beneficiaries view and update their own financial address in the registry. From v2.0 it is delivered as a single **API-only** component — `openg2p-spar-bene-portal-api` — that replaces the earlier Self-Service API + ReactJS UI. Implementing organizations build (or integrate) their own front-end on top of these APIs.

The **Beneficiary Portal API** offers the following features:

* Integration with an OIDC-OAuth2.0 Login Provider (the beneficiary logs in with their National ID).
* A directory of all the financial institutions and their branches - to facilitate a beneficiary to define his/her full financial address.
* Strategy definitions (Construct & De-Construct) to construct a Financial Address using the various attributes -
  * Bank Name, Bank Code, Branch Code, Branch Name and Account Number in case of Bank Accounts
  * Wallet Provider Code, Wallet Provider Name, Email Address and Phone Number in case of Wallets
* Search APIs for Banks & their Branches and Wallet Providers, so a beneficiary can construct their complete financial address.
* APIs that allow a beneficiary to log in and change their destination account (or wallet) any number of times.

The simplified DFSP model behind these APIs uses three entity types: **BANK**, **BRANCH** and **WALLET-PROVIDER**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openg2p.org/products/spar/features/spar-self-service.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
