PUT
/
v1
/
representatives
/
{representative_id}

Authorizations

Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer <token> 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.

Path Parameters

representative_id
string
required

Body

dob
string
required

The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).

email
string
required

The email address of the representative.

first_name
string
required

The first name of the representative.

last_name
string
required

The last name of the representative.

mobile_number
string
required

The mobile phone number of the representative.

relationship
object
required
ssn_last4
string
required

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

external_id
string | null

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

Response

200 - text/plain
data
object
required
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