Representatives
Create a representative
List representatives
Update a representative
Lookup a representative
Retrieve unmasked representative details
ModelsExpand Collapse
class Representative { data, meta, response_type }
data: { id, account_id, created_at, 15 more}
id: String
Unique identifier for the representative.
account_id: String
The unique identifier of the account this representative is associated with.
created_at: Time
Timestamp of when the representative was created.
dob: Date
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
email: String
The email address of the representative.
first_name: String
The first name of the representative.
last_name: String
The last name of the representative.
mobile_number: String
The mobile phone number of the representative.
relationship: { control, owner, primary, 2 more}
control: bool
Whether the representative has significant responsibility to control, manage, or direct the organization. One representative must be identified under the control prong for each legal entity.
owner: bool
Whether the representative owns any percentage of of the equity interests of the legal entity.
primary: bool
Whether the person is authorized as the primary representative of the account. This is the person chosen by the business to provide information about themselves, general information about the account, and who consented to the services agreement.
There can be only one primary representative for an account at a time.
percent_ownership: Float
The percentage of ownership the representative has. Required if 'Owner' is true.
title: String
The job title of the representative.
ssn_last4: String
The last 4 digits of the representative's Social Security Number.
status: :created | :onboarding | :active | 2 more
The current status of the representative.
status_detail: { code, message, reason, source}
code: String
A machine-readable code for the specific status, useful for programmatic handling.
message: String
A human-readable message describing the current status.
reason: :unverified | :in_review | :pending | 5 more
A machine-readable identifier for the specific status, useful for programmatic handling.
source: :watchtower
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
updated_at: Time
Timestamp of the most recent update to the representative.
external_id: String
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
metadata: Hash[Symbol, String]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.
user_id: String
The unique identifier of the user account associated with this representative, if applicable.
Metadata about the API request, including an identifier and timestamp.
api_request_id: String
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: Time
Timestamp for this API request, useful for troubleshooting.
response_type: :object | :array | :error | :none
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
class RepresentativePaged { data, meta, response_type }
data: Array[{ id, account_id, created_at, 15 more}]
id: String
Unique identifier for the representative.
account_id: String
The unique identifier of the account this representative is associated with.
created_at: Time
Timestamp of when the representative was created.
dob: Date
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
email: String
The email address of the representative.
first_name: String
The first name of the representative.
last_name: String
The last name of the representative.
mobile_number: String
The mobile phone number of the representative.
relationship: { control, owner, primary, 2 more}
control: bool
Whether the representative has significant responsibility to control, manage, or direct the organization. One representative must be identified under the control prong for each legal entity.
owner: bool
Whether the representative owns any percentage of of the equity interests of the legal entity.
primary: bool
Whether the person is authorized as the primary representative of the account. This is the person chosen by the business to provide information about themselves, general information about the account, and who consented to the services agreement.
There can be only one primary representative for an account at a time.
percent_ownership: Float
The percentage of ownership the representative has. Required if 'Owner' is true.
title: String
The job title of the representative.
ssn_last4: String
The last 4 digits of the representative's Social Security Number.
status: :created | :onboarding | :active | 2 more
The current status of the representative.
status_detail: { code, message, reason, source}
code: String
A machine-readable code for the specific status, useful for programmatic handling.
message: String
A human-readable message describing the current status.
reason: :unverified | :in_review | :pending | 5 more
A machine-readable identifier for the specific status, useful for programmatic handling.
source: :watchtower
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
updated_at: Time
Timestamp of the most recent update to the representative.
external_id: String
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
metadata: Hash[Symbol, String]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.
user_id: String
The unique identifier of the user account associated with this representative, if applicable.
Metadata about the API request, including an identifier, timestamp, and pagination details.
api_request_id: String
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: Time
Timestamp for this API request, useful for troubleshooting.
max_page_size: Integer
Maximum allowed page size for this endpoint.
page_number: Integer
Page number for paginated results.
page_size: Integer
Number of items per page in this response.
sort_by: String
The field that the results were sorted by.
sort_order: :asc | :desc
total_items: Integer
Total number of items returned in this response.
total_pages: Integer
The number of pages available.
response_type: :object | :array | :error | :none
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.