Fundamentals
Customers
Charges
Payouts
Payments
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Unmask representative data
Use this endpoint to unmask a representative’s sensitive PII data.
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.unmask('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
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
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
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 structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is 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 A machine-readable identifier for the specific status, useful for programmatic handling.
unverified, in_review, pending, stuck, verified, failed_verification, disabled, new Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
watchtower A machine-readable code for the specific status, useful for programmatic handling.
A human-readable message describing the current status.
The first name of the representative.
"Ron"
The last name of the representative.
"Swanson"
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
"1980-01-01"
The last 4 digits of the representative's Social Security Number.
"1234"
The email address of the representative.
"ron.swanson@pawnee.com"
The mobile phone number of the representative.
"+12128675309"
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.
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.
Whether the representative owns any percentage of of the equity interests of the legal entity.
The percentage of ownership the representative has. Required if 'Owner' is true.
The job title 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.
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.unmask('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
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"
}
}