Unmask a linked bank account

embed.linked_bank_accounts.unmask(linked_bank_account_id, **kwargs) -> LinkedBankAccountUnmaskV1 { data, meta, response_type }

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: String

request_id: String

ReturnsExpand Collapse

class LinkedBankAccountUnmaskV1 { data, meta, response_type }

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

id: String

Unique identifier for the linked bank account.

formatuuid

account_id: String

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

formatuuid

bank_account: { 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: Time

Timestamp of when the linked bank account was created.

formatdate-time

status: :created | :onboarding | :active | 3 more

The current status of the linked bank account.

Accepts one of the following:

:created

:onboarding

:active

:rejected

:inactive

:canceled

status_detail: { 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 | :in_review | :pending | 5 more

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

Accepts one of the following:

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

Accepts one of the following:

:watchtower

updated_at: Time

Timestamp of when the linked bank account was last updated.

formatdate-time

metadata: Hash[Symbol, String]

meta: ResponseMetadata { 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.

formatuuid

api_request_timestamp: Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: :object | :array | :error | :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.

Accepts one of the following:

:object

:array

:error

:none

Unmask a linked bank account

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

linked_bank_account_unmask_v1 = straddle.embed.linked_bank_accounts.unmask("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(linked_bank_account_unmask_v1)

{
  "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"
}