Skip to main content
Get Bridge Integration Status

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Response

Bridge integration status retrieved successfully

Complete Bridge integration information including status and related data

status
enum<string>
required

Current status of the Bridge integration

Available options:
NOT_ENABLED,
NOT_OPTED_IN,
OPTED_IN,
READY_FOR_DEPOSIT,
ERROR
Example:

"OPTED_IN"

customer_id
string

Bridge customer ID

Example:

"cust_123abc"

kyc_status
object

KYC verification link information

virtual_account
object

Virtual account information for USD deposits

opted_in_by
string

User ID who opted the organization into Bridge

Example:

"user_789"

opted_in_at
string<date-time>

Timestamp when organization opted into Bridge

Example:

"2025-01-01T00:00:00Z"

virtual_account_created_by
string

User ID who created the virtual account

Example:

"user_789"

virtual_account_created_at
string<date-time>

Timestamp when virtual account was created

Example:

"2025-01-01T00:00:00Z"