---
title: "Look up a UMA address for payment"
method: GET
path: "/receiver/{receiverUmaAddress}"
tags: ["Sending Payments"]
---

# Look up a UMA address for payment

`GET /receiver/{receiverUmaAddress}`

Lookup a receiving UMA address to determine supported currencies and exchange rates.
This endpoint helps platforms determine what currencies they can send to a given UMA address.

## Path parameters

- `receiverUmaAddress` string, required

## Query parameters

- `senderUmaAddress` string
- `userId` string

## Response `200`

Successful lookup

- object
  - `receiverUmaAddress` string, required — The UMA address that was looked up
  - `supportedCurrencies` CurrencyPreference[], required — List of currencies supported by the receiving UMA address
    - `currency` Currency, required
      - `code` string — Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "SAT" for satoshis, "USDC" for USDCoin, etc.)
      - `name` string — Full name of the currency
      - `symbol` string — Symbol of the currency
      - `decimals` integer — Number of decimal places for the currency
    - `estimatedExchangeRate` number, required — An estimated exchange rate from the sender's currency to this currency. This is not a locked rate and is subject to change when calling the quotes endpoint.
    - `min` integer, required — The minimum amount that can be received in this currency.
    - `max` integer, required — The maximum amount that can be received in this currency.
  - `requiredPayerDataFields` CounterpartyFieldDefinition[] — Fields required by the receiving institution about the payer before payment can be completed
    - `name` 'FULL_NAME' | 'BIRTH_DATE' | 'NATIONALITY' | 'PHONE_NUMBER' | 'EMAIL' | 'POSTAL_ADDRESS' | 'TAX_ID' | 'REGISTRATION_NUMBER' | 'USER_TYPE' | 'COUNTRY_OF_RESIDENCE' | 'ACCOUNT_IDENTIFIER' | 'FI_LEGAL_ENTITY_NAME' | 'FI_ADDRESS' | 'PURPOSE_OF_PAYMENT' | 'ULTIMATE_INSTITUTION_COUNTRY' | 'IDENTIFIER' | 'BUSINESS_TYPE', required — Name of a type of field containing info about a platform's user or counterparty user.
    - `mandatory` boolean, required — Whether the field is mandatory
  - `lookupId` string, required — Unique identifier for the lookup. Needed in the subsequent create quote request.
  - `kycStatus` 'UNKNOWN' | 'NOT_VERIFIED' | 'PENDING' | 'VERIFIED', required — KYC status of the customer. This field describes whether the UMA provider is doing a full KYC check on the customer. Note that in cases where the UMA provider is proxying to an underlying bank account, the bank will still have KYC'd the customer. See `bankAccountNameMatchingStatus` for cases where there's a backing bank account, but the UMA provider is able to verify the account holder's name.
  - `bankAccountNameMatchingStatus` 'UNKNOWN' | 'NOT_MATCHED' | 'MATCHED' — Status of the bank account name matching. This field describes whether the UMA provider is able to verify that a backing bank account holder's name matches the name provided as payee data in the payreq response if applicable. It ensures that the ultimate landing destination of the payment is the intended payee. Note that this field is only applicable if the UMA provider is proxying to an underlying bank account.

## Other responses

- `400` — Bad request - Missing or invalid parameters
- `401` — Unauthorized
- `404` — UMA address not found
- `412` — Counterparty doesn't support UMA version
- `424` — Counterparty issue
- `500` — Internal service error

---

[API](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api.md) · [All operations](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightsparkdev/uma-as-a-service-umaaas-api/versions/2e2b5ba6d69b/schema)