Skip to main content
PUT
/
v1
/
representatives
/
{representative_id}
cURL
curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/representatives/<uuid> \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "Ron",
  "last_name": "Swanson",
  "dob": "2019-12-27",
  "ssn_last4": "1234",
  "email": "[email protected]",
  "mobile_number": "+12128675309",
  "relationship": {
    "primary": true,
    "control": true,
    "owner": true
  }
}'
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "created",
    "status_detail": {
      "reason": "unverified",
      "source": "watchtower",
      "code": "<string>",
      "message": "<string>"
    },
    "first_name": "Ron",
    "last_name": "Swanson",
    "dob": "1980-01-01",
    "ssn_last4": "1234",
    "email": "[email protected]",
    "mobile_number": "+12128675309",
    "relationship": {
      "primary": true,
      "control": true,
      "owner": true,
      "percent_ownership": 123,
      "title": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "phone": "<string>",
    "metadata": {}
  }
}

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

Path Parameters

​
representative_id
string<uuid>
required

Body

​
first_name
string
required

The first name of the representative.

Example:

"Ron"

​
last_name
string
required

The last name of the representative.

Example:

"Swanson"

​
dob
string<date>
required

The date of birth of 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.

Example:

"1234"

​
email
string<email>
required

The email address of the representative.

Example:

"[email protected]"

​
mobile_number
string
required

The mobile phone number of the representative.

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

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

Response

OK

​
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