Unmask a linked bank account

$ straddle embed:linked-bank-accounts unmask

GET/v1/linked_bank_accounts/{linked_bank_account_id}/unmask

Retrieves the unmasked details of a linked bank account that has previously been created. Supply the unique linked bank account id, and Straddle will return the corresponding information, including sensitive details. This endpoint needs to be enabled by Straddle for your account and should only be used when absolutely necessary.

ParametersExpand Collapse

--linked-bank-account-id: string

--correlation-id: optional string

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

--request-id: optional string

Optional client generated identifier to trace and debug a request.

ReturnsExpand Collapse

linkedBankAccountUnmaskV1: object { data, meta, response_type }

data: object { id, account_id, bank_account, 5 more }

id: string

Unique identifier for the linked bank account.

account_id: string

Unique identifier for the Straddle account related to this bank account.

bank_account: object { account_holder, account_number, institution_name, routing_number }

The bank account details associated with the linked bank account.

account_holder: string

account_number: string

institution_name: string

routing_number: string

created_at: string

Timestamp of when the linked bank account was created.

status: "created" or "onboarding" or "active" or 3 more

The current status of the linked bank account.

"created"

"onboarding"

"active"

"rejected"

"inactive"

"canceled"

status_detail: object { code, message, reason, source }

Additional details about the current status of the linked bank account.

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" or "in_review" or "pending" or 5 more

A machine-readable identifier for the specific status, useful for programmatic handling.

"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.

"watchtower"

updated_at: string

Timestamp of when the linked bank account was last updated.

metadata: optional map[string]

meta: object { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

response_type: "object" or "array" or "error" or "none"

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.

"object"

"array"

"error"

"none"

Unmask a linked bank account

straddle embed:linked-bank-accounts unmask \
  --api-key 'My API Key' \
  --linked-bank-account-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_number": "account_number",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_number": "account_number",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}