v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-017364211.0 KB

Bridge Integration

Get Bridge Integration Status

Retrieves the current Bridge integration status and information for the organization. Returns live data from the Bridge API including KYC status and virtual account details.

get/bridge-integration

Response

Bridge integration status retrieved successfully

status'NOT_ENABLED' | 'NOT_OPTED_IN' | 'OPTED_IN' | 'READY_FOR_DEPOSIT' | 'ERROR' required

Current status of the Bridge integration

customer_idstring

Bridge customer ID

opted_in_bystring

User ID who opted the organization into Bridge

opted_in_atstring date-time

Timestamp when organization opted into Bridge

virtual_account_created_bystring

User ID who created the virtual account

virtual_account_created_atstring date-time

Timestamp when virtual account was created

Example response

{
  "status": "OPTED_IN",
  "customer_id": "cust_123abc",
  "kyc_status": {
    "id": "kyc_456def",
    "full_name": "John Doe",
    "email": "john@example.com",
    "type": "business",
    "kyc_link": "https://bridge.stellar.org/kyc/456def",
    "tos_link": "https://bridge.stellar.org/tos/456def",
    "kyc_status": "under_review",
    "tos_status": "approved",
    "rejection_reasons": [
      "Incomplete documentation",
      "Address verification failed"
    ],
    "created_at": "2025-01-01T00:00:00Z",
    "customer_id": "cust_123abc"
  },
  "virtual_account": {
    "id": "va_789xyz",
    "status": "activated",
    "developer_fee_percent": "0.5",
    "customer_id": "cust_123abc",
    "source_deposit_instructions": {
      "bank_beneficiary_name": "Stellar Bridge",
      "currency": "usd",
      "bank_name": "Wells Fargo",
      "bank_address": "123 Main St, San Francisco, CA",
      "bank_account_number": "1234567890",
      "bank_routing_number": "121000248",
      "payment_rails": [
        "ach",
        "wire"
      ]
    },
    "destination": {
      "payment_rail": "stellar",
      "currency": "usdc",
      "address": "GDQP2KPQGKIHYJGXNUIYOMHARUARCA7DJT5FO2FFOOKY3B2WSQHG4W37",
      "blockchain_memo": "12345"
    }
  },
  "opted_in_by": "user_789",
  "opted_in_at": "2025-01-01T00:00:00Z",
  "virtual_account_created_by": "user_789",
  "virtual_account_created_at": "2025-01-01T00:00:00Z"
}