Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Headers

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.

idempotency-key
string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Body

account_id
string<uuid>
required

The unique identifier of the account this representative is associated with.

first_name
string
required

The first name of the representative.

last_name
string
required

The last name of the representative.

dob
string<date>
required

Date of birth for the representative in ISO 8601 format (YYYY-MM-DD).

Example:

"1980-01-01"

ssn_last4
string
required

The last 4 digits of the representative's Social Security Number.

Pattern: ^[0-9]{4}$
Example:

"1234"

email
string<email>
required

The company email address of the representative.

mobile_number
string
required

The mobile phone number of the representative.

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+12128675309"

relationship
object
required
external_id
string | null

Unique identifier for the representative 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 represetative in a structured format.

Response

Created

meta
object
required

Metadata about the API request, including an identifier and timestamp.

response_type
enum<string>
required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.
Available options:
object,
array,
error,
none
data
object
required