Skip to main content
GET
/
payout
/
rails
/
bridge-customers
Get Bridge customers
curl --request GET \
  --url http://localhost:4000/v1/payout/rails/bridge-customers \
  --header 'Authorization: <api-key>'
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "customer_id": "cust_123abc",
    "full_name": "John Doe",
    "email": "[email protected]",
    "type": "individual",
    "kyc_link": "https://bridge.withpersona.com/verify?token=...",
    "kyc_status": "not_started",
    "tos_link": "https://dashboard.bridge.xyz/accept-terms-of-service?token=...",
    "tos_status": "pending",
    "persona_inquiry_type": "gov_id_db",
    "rejection_reasons": [],
    "created_at": "2025-01-31T12:00:00.000Z",
    "updated_at": "2025-01-31T12:00:00.000Z"
  }
]

Authorizations

​
Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Response

Bridge customers retrieved successfully

​
id
string
required

Internal database ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
customer_id
string
required

Bridge customer ID

Example:

"cust_123abc"

​
full_name
string
required

Full name of the customer

Example:

"John Doe"

​
email
string
required

Email address of the customer

Example:

"[email protected]"

​
type
enum<string>
required

Type of customer

Available options:
individual,
business
Example:

"individual"

​
kyc_link
object
required

KYC verification link

Example:

"https://bridge.withpersona.com/verify?token=..."

​
kyc_status
enum<string>
required

KYC verification status

Available options:
not_started,
under_review,
incomplete,
approved,
rejected,
awaiting_ubo
Example:

"not_started"

​
tos_link
object
required

Terms of Service acceptance link

Example:

"https://dashboard.bridge.xyz/accept-terms-of-service?token=..."

​
tos_status
enum<string>
required

Terms of Service acceptance status

Available options:
pending,
approved
Example:

"pending"

​
persona_inquiry_type
object
required

Persona inquiry type

Example:

"gov_id_db"

​
rejection_reasons
string[] | null
required

List of rejection reasons if KYC was rejected

Example:
[]
​
created_at
object
required

Creation timestamp

Example:

"2025-01-31T12:00:00.000Z"

​
updated_at
object
required

Last update timestamp

Example:

"2025-01-31T12:00:00.000Z"