---
title: "Retrieve an account"
method: GET
path: "/v2/users/{userId}/accounts/{accountId}"
tags: ["Account"]
---

# Retrieve an account

`GET /v2/users/{userId}/accounts/{accountId}`

Get an existing onramp or offramp account detail.

## Path parameters

- `userId` string, required
- `accountId` string, required

## Response `200`

Success

- union
  - AccountObject
    - `accountId` string
    - `userId` string
    - `createdAt` string, date-time
    - `accountType` string
    - `accountNumber` string
    - `routingNumber` string
    - `bankName` string
    - `isValid` boolean
    - `reason` string
    - `rail` object
      - `currency` string
      - `railType` string
      - `paymentRail` string
  - UsAccountObject
    - `id` string — Account ID
    - `userId` string — User ID
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `accountHolder` UsAccountHolder
      - `type` 'individual' | 'business', required
      - `name` string, required — The name of the account holder. `individual`: first name and last name seperated by space. `business`: legal name of the business.
      - `address` Address, required
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
    - `isValid` boolean — Indicates if the account is valid
    - `reason` string — Reason for invalidity, if applicable
    - `us` object
      - `accountType` 'Checking' | 'Savings' — The type of account.
      - `accountNumber` string — The account number of the account.
      - `routingNumber` string — The routing number of the account.
      - `iban` string — Only one of `accountNumber` or `iban` can be provided.
      - `swiftCode` string — The SWIFT code of the bank where the account is held. Required if `transferType` is `swift`.
      - `bankName` string — The name of the bank where the account is held.
      - `bankAddress` Address
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `currency` 'usd' — The currency of the account.
    - `rail` object
      - `currency` 'usd' — The currency of the account.
      - `railType` 'offramp'
      - `paymentRail` string

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/hifibridge/apis/hifi-api.md) · [All operations](https://skmtc.net/hifibridge/apis/hifi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hifibridge/hifi-api/revisions/74d9e530fbea/schema)
