Representatives
Create a representative
List representatives
Update a representative
Lookup a representative
Retrieve unmasked representative details
ModelsExpand Collapse
class Representative: …
data: Data
id: str
Unique identifier for the representative.
account_id: str
The unique identifier of the account this representative is associated with.
created_at: datetime
Timestamp of when the representative was created.
dob: date
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
email: Optional[str]
The email address of the representative.
first_name: str
The first name of the representative.
last_name: str
The last name of the representative.
mobile_number: str
The mobile phone number of the representative.
relationship: DataRelationship
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: Optional[float]
The percentage of ownership the representative has. Required if 'Owner' is true.
title: Optional[str]
The job title of the representative.
ssn_last4: str
The last 4 digits of the representative's Social Security Number.
status: Literal["created", "onboarding", "active", 2 more]
The current status of the representative.
status_detail: DataStatusDetail
code: str
A machine-readable code for the specific status, useful for programmatic handling.
message: str
A human-readable message describing the current status.
reason: Literal["unverified", "in_review", "pending", 5 more]
A machine-readable identifier for the specific status, useful for programmatic handling.
source: Literal["watchtower"]
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
updated_at: datetime
Timestamp of the most recent update to the representative.
external_id: Optional[str]
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, str]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.
user_id: Optional[str]
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: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
response_type: Literal["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: List[Data]
id: str
Unique identifier for the representative.
account_id: str
The unique identifier of the account this representative is associated with.
created_at: datetime
Timestamp of when the representative was created.
dob: date
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
email: Optional[str]
The email address of the representative.
first_name: str
The first name of the representative.
last_name: str
The last name of the representative.
mobile_number: str
The mobile phone number of the representative.
relationship: DataRelationship
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: Optional[float]
The percentage of ownership the representative has. Required if 'Owner' is true.
title: Optional[str]
The job title of the representative.
ssn_last4: str
The last 4 digits of the representative's Social Security Number.
status: Literal["created", "onboarding", "active", 2 more]
The current status of the representative.
status_detail: DataStatusDetail
code: str
A machine-readable code for the specific status, useful for programmatic handling.
message: str
A human-readable message describing the current status.
reason: Literal["unverified", "in_review", "pending", 5 more]
A machine-readable identifier for the specific status, useful for programmatic handling.
source: Literal["watchtower"]
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
updated_at: datetime
Timestamp of the most recent update to the representative.
external_id: Optional[str]
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, str]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.
user_id: Optional[str]
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: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
max_page_size: int
Maximum allowed page size for this endpoint.
page_number: int
Page number for paginated results.
page_size: int
Number of items per page in this response.
sort_by: str
The field that the results were sorted by.
sort_order: Literal["asc", "desc"]
total_items: int
Total number of items returned in this response.
total_pages: int
The number of pages available.
response_type: Literal["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.