List representatives

GET

representatives

import Straddle from '@straddleio/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const representative of client.embed.representatives.list()) {
    console.log(representative.id);
  }
}

main();

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "created",
      "status_detail": {
        "reason": "unverified",
        "source": "watchtower",
        "code": "<string>",
        "message": "<string>"
      },
      "first_name": "Ron",
      "last_name": "Swanson",
      "dob": "1980-01-01",
      "ssn_last4": "1234",
      "email": "ron.swanson@pawnee.com",
      "mobile_number": "+12128675309",
      "relationship": {
        "primary": true,
        "control": true,
        "owner": true,
        "percent_ownership": 123,
        "title": "<string>"
      },
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

Headers

request-id

string

Optional client generated identifier to trace and debug a request.

correlation-id

string

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

Query Parameters

account_id

string

The unique identifier of the account to list representatives for.

page_number

integer

default:1

Results page number. Starts at page 1.

page_size

integer

default:100

Page size. Max value: 1000

sort_by

string

default:id

Sort By.

sort_order

enum<string>

default:asc

Sort Order.

Available options:

asc,

desc

platform_id

string

organization_id

string

level

enum<string>

Available options:

account,

platform

Response

200

text/plain

meta

object

required

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

response_type

enum<string>

required

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.

Available options:

object,

array,

error,

none

data

object[]

required

data.id

string

required

Unique identifier for the representative.

data.account_id

string

required

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

data.status

enum<string>

required

The current status of the representative.

Available options:

created,

onboarding,

active,

rejected,

inactive

data.status_detail

object

required

data.first_name

string

required

The first name of the representative.

Example:

"Ron"

data.last_name

string

required

The last name of the representative.

Example:

"Swanson"

data.dob

string

required

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

Example:

"1980-01-01"

data.ssn_last4

string

required

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

Example:

"1234"

data.email

string

required

The email address of the representative.

Example:

"ron.swanson@pawnee.com"

data.mobile_number

string

required

The mobile phone number of the representative.

Example:

"+12128675309"

data.relationship

object

required

data.created_at

string

required

Timestamp of when the representative was created.

data.updated_at

string

required

Timestamp of the most recent update to the representative.

data.user_id

string | null

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

data.external_id

string | null

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

Suggest edits Raise issue

Unmask representative data

Create a linked bank account

import Straddle from '@straddleio/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const representative of client.embed.representatives.list()) {
    console.log(representative.id);
  }
}

main();

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "created",
      "status_detail": {
        "reason": "unverified",
        "source": "watchtower",
        "code": "<string>",
        "message": "<string>"
      },
      "first_name": "Ron",
      "last_name": "Swanson",
      "dob": "1980-01-01",
      "ssn_last4": "1234",
      "email": "ron.swanson@pawnee.com",
      "mobile_number": "+12128675309",
      "relationship": {
        "primary": true,
        "control": true,
        "owner": true,
        "percent_ownership": 123,
        "title": "<string>"
      },
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Authorizations

Headers

Query Parameters

Response