POST

https://{environment}.straddle.io

/
v1
/
customers

Authorizations

Authorization
string
headerrequired

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

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
email
string
required

The customer's email address.

phone
string
required

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

device
object
required
address
object
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
meta
object
required
response_type
enum<string>
required
Available options:
object,
array,
error,
none
data
object
required