Representatives
Create a representative
List representatives
Update a representative
Lookup a representative
Retrieve unmasked representative details
ModelsExpand Collapse
Representative { data, meta, response_type }
data: 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: string
Timestamp of when the representative was created.
dob: string
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
email: string | null
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: Relationship { control, owner, primary, 2 more }
control: boolean
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: boolean
Whether the representative owns any percentage of of the equity interests of the legal entity.
primary: boolean
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?: number | null
The percentage of ownership the representative has. Required if 'Owner' is true.
title?: string | null
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: StatusDetail { 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: string
Timestamp of the most recent update to the representative.
external_id?: string | null
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
metadata?: Record<string, string> | null
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.
user_id?: string | null
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: string
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.
RepresentativePaged { data, meta, response_type }
data: Array<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: string
Timestamp of when the representative was created.
dob: string
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
email: string | null
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: Relationship { control, owner, primary, 2 more }
control: boolean
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: boolean
Whether the representative owns any percentage of of the equity interests of the legal entity.
primary: boolean
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?: number | null
The percentage of ownership the representative has. Required if 'Owner' is true.
title?: string | null
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: StatusDetail { 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: string
Timestamp of the most recent update to the representative.
external_id?: string | null
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
metadata?: Record<string, string> | null
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.
user_id?: string | null
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: string
Timestamp for this API request, useful for troubleshooting.
max_page_size: number
Maximum allowed page size for this endpoint.
page_number: number
Page number for paginated results.
page_size: number
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: number
Total number of items returned in this response.
total_pages: number
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.