Instances

Retrieve Instance

Changed on

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.

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

Path parameters

idstring required
Example:in_000000000000

Response

Retrieve instance

idstring required
namestring 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

Example response

{
  "id": "in_000000000000",
  "name": "My Instance",
  "type": "development",
  "onboarding_step": "initial"
}

Changes