List representatives

embed.representatives.list(**kwargs) -> PageNumberSchema<{ id, account_id, created_at, 15 more}>

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

account_id: String

The unique identifier of the account to list representatives for.

formatuuid

level: :account | :platform

One of the following:

:account

:platform

organization_id: String

page_number: Integer

Results page number. Starts at page 1.

formatint32

page_size: Integer

Page size. Max value: 1000

formatint32

platform_id: String

sort_by: String

Sort By.

sort_order: :asc | :desc

Sort Order.

One of the following:

:asc

:desc

correlation_id: String

request_id: String

ReturnsExpand Collapse

{ id, account_id, created_at, 15 more}

id: String

Unique identifier for the representative.

formatuuid

account_id: String

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

formatuuid

created_at: Time

Timestamp of when the representative was created.

formatdate-time

dob: Date

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

formatdate

email: String

The email address of the representative.

formatemail

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.

name: String

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.

formatdouble

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.

One of the following:

:created

:onboarding

:active

:rejected

:inactive

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.

One of the following:

:unverified

:in_review

:pending

:stuck

:verified

:failed_verification

:disabled

:new

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.

formatdate-time

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.

phone: String

user_id: String

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

formatuuid

List representatives

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

page = straddle.embed.representatives.list

puts(page)

{
  "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"
}