PUT
/
v1
/
representatives
/
{representative_id}
curl --request PUT \
  --url https://{environment}.straddle.io/v1/representatives/{representative_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "2023-12-25",
  "ssn_last4": "<string>",
  "email": "<string>",
  "mobile_number": "<string>",
  "relationship": {
    "primary": true,
    "control": true,
    "owner": true,
    "percent_ownership": 123,
    "title": "<string>"
  },
  "external_id": "<string>"
}'
{
  "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",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "created",
    "status_detail": {
      "reason": "unverified",
      "source": "watchtower",
      "code": "<string>",
      "message": "<string>"
    },
    "first_name": "<string>",
    "last_name": "<string>",
    "dob": "2023-12-25",
    "ssn_last4": "<string>",
    "email": "<string>",
    "mobile_number": "<string>",
    "relationship": {
      "primary": true,
      "control": true,
      "owner": true,
      "percent_ownership": 123,
      "title": "<string>"
    },
    "external_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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

​
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

​
first_name
string
required

The first name of the representative.

​
last_name
string
required

The last name of the representative.

​
dob
string
required

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

​
ssn_last4
string
required

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

​
email
string
required

The email address of the representative.

​
mobile_number
string
required

The mobile phone number of the representative.

​
relationship
object
required
​
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
OK
​
meta
object
required
​
response_type
enum<string>
required

Indicates the type of data returned.

Available options:
object,
array,
error,
none
​
data
object
required

Was this page helpful?

Suggest editsRaise issue
Create a representativeLookup a representative