Skip to main content
The USClient provides methods to manage US bank accounts. Get Terms of Service acceptance link.
await bloque.accounts.us.getTosLink(
  params: GetTosLinkParams
): Promise<TosLinkResult>

Parameters

params
GetTosLinkParams
TOS link parameters

Returns

Example

const tosLink = await bloque.accounts.us.getTosLink({
  redirectUri: 'https://myapp.com/callback'
});

// Redirect user to tosLink.url
// After acceptance, extract signed_agreement_id from callback

create()

Create a new US bank account.
await bloque.accounts.us.create(
  params: CreateUsAccountParams,
  options?: CreateAccountOptions
): Promise<UsAccount>

Parameters

params
CreateUsAccountParams
US account creation parameters
options
CreateAccountOptions
Creation options

Returns

UsAccount
object

Example

// First, get TOS link and have user accept
const tosLink = await bloque.accounts.us.getTosLink({
  redirectUri: 'https://myapp.com/callback'
});

// After user accepts, create account with signed_agreement_id
const account = await bloque.accounts.us.create({
  type: 'individual',
  firstName: 'Robert',
  middleName: 'James',
  lastName: 'Johnson',
  email: 'robert.johnson@example.com',
  phone: '+12125551234',
  address: {
    streetLine1: '456 Wall Street',
    streetLine2: 'Suite 789',
    city: 'New York',
    state: 'NY',
    postalCode: '10005',
    country: 'US'
  },
  birthDate: '1985-03-15',
  taxIdentificationNumber: '123-45-6789',
  govIdCountry: 'US',
  govIdImageFront: 'base64_encoded_image',
  signedAgreementId: '0d139f8e-14b0-4540-92ba-4e66c619b533'
});

list()

List US bank accounts.
await bloque.accounts.us.list(
  params?: ListUsAccountsParams
): Promise<ListUsAccountsResult>

Parameters

params
ListUsAccountsParams
List parameters

Returns

ListUsAccountsResult
object

Example

// List all US accounts
const result = await bloque.accounts.us.list();

// Get a specific US account
const result = await bloque.accounts.us.list({
  urn: 'did:bloque:account:us-account:usr-123:us-456'
});

updateMetadata()

Update US account metadata.
await bloque.accounts.us.updateMetadata(
  params: UpdateUsMetadataParams
): Promise<UsAccount>

Parameters

params
UpdateUsMetadataParams
Metadata update parameters

Returns

UsAccount
object
Updated US account

Example

const account = await bloque.accounts.us.updateMetadata({
  urn: 'did:bloque:mediums:us-account:account:123',
  metadata: {
    updated_by: 'admin',
    update_reason: 'customer_request'
  }
});

activate()

Activate a US account.
await bloque.accounts.us.activate(
  urn: string
): Promise<UsAccount>

Parameters

urn
string
required
US account URN

Returns

UsAccount
object
Updated US account

Example

const account = await bloque.accounts.us.activate(
  'did:bloque:mediums:us-account:account:123'
);

freeze()

Freeze a US account.
await bloque.accounts.us.freeze(
  urn: string
): Promise<UsAccount>

Parameters

urn
string
required
US account URN

Returns

UsAccount
object
Updated US account

Example

const account = await bloque.accounts.us.freeze(
  'did:bloque:mediums:us-account:account:123'
);

disable()

Disable a US account.
await bloque.accounts.us.disable(
  urn: string
): Promise<UsAccount>

Parameters

urn
string
required
US account URN

Returns

UsAccount
object
Updated US account

Example

const account = await bloque.accounts.us.disable(
  'did:bloque:mediums:us-account:account:123'
);

Build docs developers (and LLMs) love