---
title: "Retrieve Instance"
method: GET
path: "/v1/instances/{id}"
tags: ["Instances"]
---

# Retrieve Instance

`GET /v1/instances/{id}`

## Request

- Base URL: `https://blindpay.com` (the document declares no server; this is the origin it was published from)
- URL: `https://blindpay.com/v1/instances/{id}`
- Auth: HTTP bearer

Returns the instance your API key or connection is bound to. Check `type` before moving money: `development` simulates settlement and moves no real funds, `production` moves real funds. `onboarding_step` is `completed` once the instance can transact.

## Path parameters

- `id` string, required

## Response `200`

Retrieve instance

- RetrieveInstanceOut
  - `id` string, required
  - `name` string, required
  - `type` 'production' | 'development', required: development instances simulate settlement with test tokens (USDB) and move no real money; production instances move real funds
  - `onboarding_step` 'initial' | 'business_details' | 'business_profile' | 'documents' | 'applicant' | 'completed' | 'blocked', required: completed once the instance can move money; anything else means onboarding is still open in the dashboard

## Other responses

- `400`: Possible error codes: `VALIDATION_FAILED`. See the Error responses section for retry semantics.
- `401`: Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.
- `403`: Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.
- `429`: Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.
- `500`: Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.

## Changes

- **2026-10-22** `417cbe3c8a6a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/blindpay/apis/blindpay-api/changes/v1/instances/:id/get.md)

---

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