POST
/
v1
/
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() {
  const representative = await client.embed.representatives.create({
    account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    dob: '1980-01-01',
    email: 'ron.swanson@pawnee.com',
    first_name: 'first_name',
    last_name: 'last_name',
    mobile_number: '+12128675309',
    relationship: { control: true, owner: true, primary: true },
    ssn_last4: '1234',
  });

  console.log(representative.data);
}

main();
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "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.

Body

​
account_id
string
required

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

​
first_name
string
required

The first name of the representative.

​
last_name
string
required

The last name of the representative.

​
dob
string
required

Date of birth for the representative in ISO 8601 format (YYYY-MM-DD).

Example:

"1980-01-01"

​
ssn_last4
string
required

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

Example:

"1234"

​
email
string
required

The company email address of the representative.

Example:

"ron.swanson@pawnee.com"

​
mobile_number
string
required

The mobile phone number of the representative.

Example:

"+12128675309"

​
relationship
object
required
​
external_id
string | null

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

Response

201
text/plain
Created
​
meta
object
required

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

​
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
Suggest editsRaise issue