Skip to main content
GET
/
payout
/
rails
/
customers
/
{customer_id}
Get single customer details
curl --request GET \
  --url http://localhost:4000/v1/payout/rails/customers/{customer_id} \
  --header 'Authorization: <api-key>'
{
  "id": "e3b0c442-98fc-1c14-b39f-92d1282e8b7a",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "status": "active",
  "type": "individual",
  "capabilities": {
    "payin_crypto": "pending",
    "payout_crypto": "pending",
    "payin_fiat": "pending",
    "payout_fiat": "pending"
  },
  "requirements_due": [],
  "future_requirements_due": [],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "rejection_reasons": [
    {
      "developer_reason": "Insufficient documentation provided",
      "reason": "We were unable to verify your identity",
      "created_at": "2026-01-15T12:00:00.000Z"
    }
  ],
  "has_accepted_terms_of_service": true,
  "endorsements": [
    {
      "name": "base",
      "status": "incomplete",
      "requirements": {
        "complete": [
          "<string>"
        ],
        "pending": [
          "<string>"
        ],
        "issues": [
          "<string>"
        ],
        "missing": {}
      },
      "additional_requirements": [
        "<string>"
      ]
    }
  ],
  "persona_inquiry_type": "gov_id_db",
  "tos_link": "https://compliance.bridge.xyz/accept-terms-of-service?customer_id=...",
  "associated_persons": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "residential_address": {
        "street_line_1": "123 Main St",
        "city": "San Francisco",
        "country": "USA",
        "street_line_2": "Suite 200",
        "subdivision": "CA",
        "postal_code": "94102"
      },
      "birth_date": "1990-01-15",
      "has_ownership": true,
      "has_control": true,
      "is_signer": true,
      "identifying_information": [
        {
          "type": "ssn",
          "issuing_country": "USA",
          "number": "123-45-6789",
          "description": "<string>",
          "expiration": "2030-12-31",
          "image_front": "<string>",
          "image_back": "<string>"
        }
      ],
      "middle_name": "Michael",
      "transliterated_first_name": "<string>",
      "transliterated_middle_name": "<string>",
      "transliterated_last_name": "<string>",
      "phone": "+12223334444",
      "transliterated_residential_address": {
        "street_line_1": "123 Main St",
        "city": "San Francisco",
        "country": "USA",
        "street_line_2": "Suite 200",
        "subdivision": "CA",
        "postal_code": "94102"
      },
      "is_director": false,
      "title": "CEO",
      "ownership_percentage": 75,
      "attested_ownership_structure_at": "2024-06-15",
      "relationship_established_at": "2020-01-01",
      "verified_govid_at": "<string>",
      "verified_selfie_at": "<string>",
      "completed_customer_safety_check_at": "<string>",
      "documents": [
        {
          "purpose": "proof_of_address",
          "image_front": "<string>",
          "image_back": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Path Parameters

​
customer_id
string
required

Bridge customer ID (UUID)

Example:

"e3b0c442-98fc-1c14-b39f-92d1282e8b7a"

Response

Customer details retrieved successfully

​
id
string
required
Example:

"e3b0c442-98fc-1c14-b39f-92d1282e8b7a"

​
first_name
string
required
Example:

"John"

​
last_name
object
required
Example:

"Doe"

​
email
string
required
Example:

"[email protected]"

​
status
enum<string>
required
Available options:
active,
awaiting_questionnaire,
awaiting_ubo,
incomplete,
not_started,
offboarded,
paused,
rejected,
under_review
Example:

"active"

​
type
enum<string>
required
Available options:
individual,
business
Example:

"individual"

​
capabilities
object
required
​
requirements_due
enum<string>[]
required
Available options:
external_account,
id_verification
Example:
[]
​
future_requirements_due
enum<string>[]
required
Available options:
id_verification
Example:
[]
​
created_at
string
required
Example:

"2024-01-01T00:00:00Z"

​
updated_at
string
required
Example:

"2024-01-01T00:00:00Z"

​
rejection_reasons
object[]
required
​
has_accepted_terms_of_service
boolean
required
Example:

true

​
endorsements
object[]
required
​
persona_inquiry_type
string

Type of Persona inquiry used for verification (e.g. gov_id_db, business)

Example:

"gov_id_db"

​
tos_link
string

Bridge-hosted URL for the customer to accept Terms of Service.

Example:

"https://compliance.bridge.xyz/accept-terms-of-service?customer_id=..."

​
associated_persons
object[]

Associated persons for business customers (UBOs, controllers, etc.)