Fundamentals
Customers
Charges
Payouts
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Lookup a representative
Retrieves the details of an existing representative. Supply the unique representative ID, and Straddle will return the corresponding representative information.
curl --request GET \
--url https://{environment}.straddle.io/v1/representatives/{representative_id} \
--header 'Authorization: <api-key>'
{
"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": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"ssn_last4": "<string>",
"email": "<string>",
"mobile_number": "<string>",
"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
JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.
Headers
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Path Parameters
Response
Indicates the type of data returned.
object
, array
, error
, none
Unique identifier for the representative.
The unique identifier of the account this representative is associated with.
The current status of the representative.
created
, onboarding
, active
, rejected
, inactive
unverified
, in_review
, pending
, stuck
, verified
, failed_verification
, disabled
watchtower
The first name of the representative.
The last name of the representative.
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
The last 4 digits of the representative's Social Security Number.
The email address of the representative.
The mobile phone number of the representative.
Timestamp of when the representative was created.
Timestamp of the most recent update to the representative.
The unique identifier of the user account associated with this representative, if applicable.
Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.
Was this page helpful?
curl --request GET \
--url https://{environment}.straddle.io/v1/representatives/{representative_id} \
--header 'Authorization: <api-key>'
{
"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": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"ssn_last4": "<string>",
"email": "<string>",
"mobile_number": "<string>",
"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"
}
}