---
title: "Create a reference account"
method: POST
path: "/payments/reference_accounts"
tags: ["Reference Accounts"]
---

# Create a reference account

`POST /payments/reference_accounts`

## Request

- Base URL: `https://sandbox.upvest.co`
- URL: `https://sandbox.upvest.co/payments/reference_accounts`
- Auth: OAuth 2 (client credentials, token URL `https://sandbox.upvest.co/auth/token`, scopes: `reference_accounts:admin`)

Creates a new reference account for a user or business specified by ID.

## Headers

- `idempotency-key` string, uuid, required

## Request body

- object: Request body for registering a reference bank account. Exactly one of `user_id` or `business_id` must be provided.
  - `user_id` string, uuid: Unique identifier of the user, as a UUID.
  - `business_id` string, uuid: Unique identifier for the business.
  - `account_owner` string, required: Name of the reference account holder
  - `name` string: Human-readable name of the reference bank account
  - `iban` string, required: International Bank Account Number [IBAN](https://en.wikipedia.org/wiki/International_Bank_Account_Number).
  - `bic` string, required: Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362).
  - `confirmed_at` string, date-time, required: Timestamp of when user validated the reference account

## Response `200`

Reference account created.

- object: A verified reference bank account belonging to a user, used as the destination for cash withdrawals.
  - `id` string, uuid, required: Reference account unique identifier.
  - `created_at` string, date-time, required: Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `updated_at` string, date-time, required: Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `user_id` string, uuid: Unique identifier of the user, as a UUID.
  - `business_id` string, uuid: Unique identifier for the business.
  - `account_owner` string, required: Name of the reference account holder
  - `name` string, required: Human-readable name of the reference bank account
  - `iban` string, required: Obfuscated International Bank Account Number [IBAN](https://en.wikipedia.org/wiki/International_Bank_Account_Number).
  - `bic` string, required: Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362).
  - `confirmed_at` string, date-time, required: Timestamp of when user validated the reference account

## Other responses

- `400`: Bad Request. The incoming request had a malformed parameter/object.
- `401`: Unauthorized. The caller has not been authenticated.
- `403`: Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404`: Not Found. The requested resource could not be found.
- `406`: Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429`: Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500`: Internal Server Error. The service encountered an unexpected error.
- `503`: Service Unavailable. The service handling for this request cannot be reached at this time.
- `504`: Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.dev/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.dev/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc.dev/upvest/apis/upvest-investment-api/revisions/ca69534b631d?raw)