Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add UMAD-10: Configuration Document. #31

Merged
merged 2 commits into from
Sep 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions umad-10-configuration-document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# UMAD-10: Configuration Document

UMA VASPs may provide a JSON configuration document similar to the
[OIDC Discovery Document](https://openid.net/specs/openid-connect-discovery-1_0.html) to allow client applications and
VASP counterparties to discover information about the VASP's UMA implementation.

This document should be made available
at `/.well-known/uma-configuration` on the VASP's domain. For example, for a VASP which provides UMA addresses at
`<username>@coolvasp.net`, the configuration document would be available at
`https://coolvasp.net/.well-known/uma-configuration`.

The configuration document should be served with the `application/json` content type, should be publicly accessible, and
should set [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) such that it is accessible from any
web origin, ie. `Access-Control-Allow-Origin: *`.

If present, the configuration document MUST contain the following fields:

- `name`: The human-readable name of the VASP.
- `uma_major_versions`: The major versions of the UMA protocol that the VASP supports. This should be an array of integers.

The configuration document MAY contain the following fields:

- `uma_request_endpoint`: The URL to which UMA requests can be sent. This should be a URL that the receiving VASP can use
to send UMA requests to the sending VASP. See [UMAD-11](/umad-11-request.md) for more details.
Loading