Create a customer

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.

Headers

Straddle-Account-Id

string

For use by platforms to specify an account id and set scope of a request.

Request-Id

string

Optional client generated identifier to trace and debug a request.

Correlation-Id

string

Optional client generated identifier to trace and debug a series of requests.

Body

name

string

required

Full name of the individual or business name.

type

enum<string>

required

Available options:

individual,

business

device

object

required

string | null

The customer's email address.

address

object

phone

string | null

The customer's phone number in E.164 format. Mobile number is preferred.

compliance_profile

object

external_id

string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

metadata

object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

Response

201

text/plain

Created

meta

object

required

response_type

enum<string>

required

Available options:

object,

array,

error,

none

data

object

required

data.id

string

required

Unique identifier for the customer.

data.label

string

required

A human-readable label for the customer.

data.name

string

required

Full name of the individual or business name.

data.type

enum<string>

required

Available options:

individual,

business

data.email

string

required

The customer's email address.

data.phone

string

required

The customer's phone number in E.164 format.

data.status

enum<string>

required

Available options:

pending,

review,

verified,

inactive,

rejected

data.created_at

string

required

Timestamp of when the customer record was created.

data.updated_at

string

required

Timestamp of the most recent update to the customer record.

data.external_id

string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

data.address

object

data.compliance_profile

object

data.device

object

data.metadata

object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Embed

Authorizations

Headers

Body

Response