List representatives

RepresentativePaged Embed.Representatives.List(, )

GET/v1/representatives

Returns a list of representatives associated with a specific account or organization. The representatives are returned sorted by creation date, with the most recently created representatives appearing first. This endpoint supports advanced sorting and filtering options.

ParametersExpand Collapse

RepresentativeListParams parameters

string accountID

Query param: The unique identifier of the account to list representatives for.

formatuuid

Level level

Query param

string organizationID

Query param

formatuuid

Int pageNumber

Query param: Results page number. Starts at page 1.

formatint32

Int pageSize

Query param: Page size. Max value: 1000

formatint32

string platformID

Query param

formatuuid

string sortBy

Query param: Sort By.

SortOrder sortOrder

Query param: Sort Order.

string correlationID

Header param: Optional client generated identifier to trace and debug a series of requests.

string requestID

Header param: Optional client generated identifier to trace and debug a request.

ReturnsExpand Collapse

class RepresentativePaged:

required IReadOnlyList<Data> Data

required string ID

Unique identifier for the representative.

formatuuid

required string AccountID

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

formatuuid

required DateTimeOffset CreatedAt

Timestamp of when the representative was created.

formatdate-time

required DateOnly Dob

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

formatdate

required string? Email

The email address of the representative.

formatemail

required string FirstName

The first name of the representative.

required string LastName

The last name of the representative.

required string MobileNumber

The mobile phone number of the representative.

required string Name

required Relationship Relationship

required Boolean Control

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.

required Boolean Owner

Whether the representative owns any percentage of of the equity interests of the legal entity.

required Boolean Primary

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.

Double? PercentOwnership

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

formatdouble

string? Title

The job title of the representative.

required string SsnLast4

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

required Status Status

The current status of the representative.

One of the following:

required StatusDetail StatusDetail

required string Code

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

required string Message

A human-readable message describing the current status.

required Reason Reason

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

One of the following:

required Source Source

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

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the representative.

formatdate-time

string? ExternalID

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

IReadOnlyDictionary<string, string>? Metadata

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

string? Phone

string? UserID

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

formatuuid

required PagedResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid

required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time

required Int MaxPageSize

Maximum allowed page size for this endpoint.

formatint32

required Int PageNumber

Page number for paginated results.

formatint32

required Int PageSize

Number of items per page in this response.

formatint32

required string SortBy

The field that the results were sorted by.

required SortOrder SortOrder

One of the following:

required Int TotalItems

Total number of items returned in this response.

formatint32

required Int TotalPages

The number of pages available.

formatint32

required ResponseType ResponseType

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:

List representatives

RepresentativeListParams parameters = new();

var page = await client.Embed.Representatives.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "dob": "1980-01-01",
      "email": "ron.swanson@pawnee.com",
      "first_name": "Ron",
      "last_name": "Swanson",
      "mobile_number": "+12128675309",
      "name": "name",
      "relationship": {
        "control": true,
        "owner": true,
        "primary": true,
        "percent_ownership": 0,
        "title": "title"
      },
      "ssn_last4": "1234",
      "status": "created",
      "status_detail": {
        "code": "code",
        "message": "message",
        "reason": "unverified",
        "source": "watchtower"
      },
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      },
      "phone": "phone",
      "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "dob": "1980-01-01",
      "email": "ron.swanson@pawnee.com",
      "first_name": "Ron",
      "last_name": "Swanson",
      "mobile_number": "+12128675309",
      "name": "name",
      "relationship": {
        "control": true,
        "owner": true,
        "primary": true,
        "percent_ownership": 0,
        "title": "title"
      },
      "ssn_last4": "1234",
      "status": "created",
      "status_detail": {
        "code": "code",
        "message": "message",
        "reason": "unverified",
        "source": "watchtower"
      },
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      },
      "phone": "phone",
      "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}