Representatives

Representatives are individuals who have legal authority or significant responsibility within a business entity associated with a Straddle account. Each representative undergoes automated verification as part of KYC/KYB compliance. Use representatives to collect and verify beneficial owners, control persons, and authorized signers required for account onboarding. Representatives also determine who can legally operate the account and make important changes.

Create a representative

client.Embed.Representatives.New(ctx, params) (*Representative, error)

POST/v1/representatives

List representatives

client.Embed.Representatives.List(ctx, params) (*PageNumberSchema[RepresentativePagedData], error)

GET/v1/representatives

Update a representative

client.Embed.Representatives.Update(ctx, representativeID, params) (*Representative, error)

PUT/v1/representatives/{representative_id}

Lookup a representative

client.Embed.Representatives.Get(ctx, representativeID, query) (*Representative, error)

GET/v1/representatives/{representative_id}

Retrieve unmasked representative details

client.Embed.Representatives.Unmask(ctx, representativeID, query) (*Representative, error)

GET/v1/representatives/{representative_id}/unmask

ModelsExpand Collapse

type Representative struct{…}

Data RepresentativeData

ID string

Unique identifier for the representative.

formatuuid

AccountID string

The unique identifier of the account this representative is associated with.

formatuuid

CreatedAt Time

Timestamp of when the representative was created.

formatdate-time

Dob Time

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

formatdate

Email string

The email address of the representative.

formatemail

FirstName string

The first name of the representative.

LastName string

The last name of the representative.

MobileNumber string

The mobile phone number of the representative.

Name string

Relationship RepresentativeDataRelationship

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.

PercentOwnership float64optional

The percentage of ownership the representative has. Required if 'Owner' is true.

formatdouble

Title stringoptional

The job title of the representative.

SsnLast4 string

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

Status string

The current status of the representative.

One of the following:

const RepresentativeDataStatusCreated RepresentativeDataStatus = "created"

const RepresentativeDataStatusOnboarding RepresentativeDataStatus = "onboarding"

const RepresentativeDataStatusActive RepresentativeDataStatus = "active"

const RepresentativeDataStatusRejected RepresentativeDataStatus = "rejected"

const RepresentativeDataStatusInactive RepresentativeDataStatus = "inactive"

StatusDetail RepresentativeDataStatusDetail

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 string

A machine-readable identifier for the specific status, useful for programmatic handling.

One of the following:

const RepresentativeDataStatusDetailReasonUnverified RepresentativeDataStatusDetailReason = "unverified"

const RepresentativeDataStatusDetailReasonInReview RepresentativeDataStatusDetailReason = "in_review"

const RepresentativeDataStatusDetailReasonPending RepresentativeDataStatusDetailReason = "pending"

const RepresentativeDataStatusDetailReasonStuck RepresentativeDataStatusDetailReason = "stuck"

const RepresentativeDataStatusDetailReasonVerified RepresentativeDataStatusDetailReason = "verified"

const RepresentativeDataStatusDetailReasonFailedVerification RepresentativeDataStatusDetailReason = "failed_verification"

const RepresentativeDataStatusDetailReasonDisabled RepresentativeDataStatusDetailReason = "disabled"

const RepresentativeDataStatusDetailReasonNew RepresentativeDataStatusDetailReason = "new"

Source string

Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.

UpdatedAt Time

Timestamp of the most recent update to the representative.

formatdate-time

ExternalID stringoptional

Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

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

Phone stringoptional

UserID stringoptional

The unique identifier of the user account associated with this representative, if applicable.

formatuuid

Meta ResponseMetadata

Metadata about the API request, including an identifier and timestamp.

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

ResponseType RepresentativeResponseType

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.

One of the following:

const RepresentativeResponseTypeObject RepresentativeResponseType = "object"

const RepresentativeResponseTypeArray RepresentativeResponseType = "array"

const RepresentativeResponseTypeError RepresentativeResponseType = "error"

const RepresentativeResponseTypeNone RepresentativeResponseType = "none"

type RepresentativePaged struct{…}

Data []RepresentativePagedData

ID string

Unique identifier for the representative.

formatuuid

AccountID string

The unique identifier of the account this representative is associated with.

formatuuid

CreatedAt Time

Timestamp of when the representative was created.

formatdate-time

Dob Time

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

formatdate

Email string

The email address of the representative.

formatemail

FirstName string

The first name of the representative.

LastName string

The last name of the representative.

MobileNumber string

The mobile phone number of the representative.

Name string

Relationship RepresentativePagedDataRelationship

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

There can be only one primary representative for an account at a time.

PercentOwnership float64optional

The percentage of ownership the representative has. Required if 'Owner' is true.

formatdouble

Title stringoptional

The job title of the representative.

SsnLast4 string

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

Status string

The current status of the representative.

One of the following:

const RepresentativePagedDataStatusCreated RepresentativePagedDataStatus = "created"

const RepresentativePagedDataStatusOnboarding RepresentativePagedDataStatus = "onboarding"

const RepresentativePagedDataStatusActive RepresentativePagedDataStatus = "active"

const RepresentativePagedDataStatusRejected RepresentativePagedDataStatus = "rejected"

const RepresentativePagedDataStatusInactive RepresentativePagedDataStatus = "inactive"

StatusDetail RepresentativePagedDataStatusDetail

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 string

A machine-readable identifier for the specific status, useful for programmatic handling.

One of the following:

const RepresentativePagedDataStatusDetailReasonUnverified RepresentativePagedDataStatusDetailReason = "unverified"

const RepresentativePagedDataStatusDetailReasonInReview RepresentativePagedDataStatusDetailReason = "in_review"

const RepresentativePagedDataStatusDetailReasonPending RepresentativePagedDataStatusDetailReason = "pending"

const RepresentativePagedDataStatusDetailReasonStuck RepresentativePagedDataStatusDetailReason = "stuck"

const RepresentativePagedDataStatusDetailReasonVerified RepresentativePagedDataStatusDetailReason = "verified"

const RepresentativePagedDataStatusDetailReasonFailedVerification RepresentativePagedDataStatusDetailReason = "failed_verification"

const RepresentativePagedDataStatusDetailReasonDisabled RepresentativePagedDataStatusDetailReason = "disabled"

const RepresentativePagedDataStatusDetailReasonNew RepresentativePagedDataStatusDetailReason = "new"

Source string

Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.

UpdatedAt Time

Timestamp of the most recent update to the representative.

formatdate-time

ExternalID stringoptional

Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

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

Phone stringoptional

UserID stringoptional

The unique identifier of the user account associated with this representative, if applicable.

formatuuid

Meta PagedResponseMetadata

Metadata about the API request, including an identifier, timestamp, and pagination details.

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

MaxPageSize int64

Maximum allowed page size for this endpoint.

formatint32

PageNumber int64

Page number for paginated results.

formatint32

PageSize int64

Number of items per page in this response.

formatint32

SortBy string

The field that the results were sorted by.

SortOrder PagedResponseMetadataSortOrder

One of the following:

const PagedResponseMetadataSortOrderAsc PagedResponseMetadataSortOrder = "asc"

const PagedResponseMetadataSortOrderDesc PagedResponseMetadataSortOrder = "desc"

TotalItems int64

Total number of items returned in this response.

formatint32

TotalPages int64

The number of pages available.

formatint32

ResponseType RepresentativePagedResponseType

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.

One of the following:

const RepresentativePagedResponseTypeObject RepresentativePagedResponseType = "object"

const RepresentativePagedResponseTypeArray RepresentativePagedResponseType = "array"

const RepresentativePagedResponseTypeError RepresentativePagedResponseType = "error"

const RepresentativePagedResponseTypeNone RepresentativePagedResponseType = "none"