Skip to main content
POST
/
payout
/
rails
/
customers
Create a Bridge KYC customer for the calling integrator
curl --request POST \
  --url http://localhost:4000/v1/payout/rails/customers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_name": "Jane Doe",
  "email": "jane.doe@example.com",
  "type": "individual",
  "persona_inquiry_type": "kyc"
}
'

Authorizations

​
Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Body

application/json
​
full_name
string
required

Full legal name of the customer

Example:

"Jane Doe"

​
email
string
required

Customer email address (used as the idempotency fingerprint)

Example:

"jane.doe@example.com"

​
type
enum<string>
required

Customer type: 'individual' for natural persons, 'business' for entities

Available options:
individual,
business
Example:

"individual"

​
persona_inquiry_type
string

Persona inquiry type for KYC flow (optional, Bridge-specific)

Example:

"kyc"

Response

Customer created or returned from cache