Bolt Financial Account API

Use the Account endpoint to view and manage customer accounts. Perform actions such as creating an account, updating an address, or adding a payment method. This endpoint is for merchants using the Accounts Package. See our related guide on [Bolt OAuth](https://help.boltapp.com/developers/bolt-oauth/).

Operations 16

GET /v1/account Get Account Details #
POST /v1/account Create Bolt Account #
PATCH /v1/account/profile Update Profile #
POST /v1/account/addresses Add Address #
DELETE /v1/account/addresses/{id} Delete Address #
POST /v1/account/addresses/{id} Replace Address #
PUT /v1/account/addresses/{id} Edit Address #
GET /v1/account/exists Detect Account #
POST /v1/account/payment_methods Add Payment Method #
DELETE /v1/account/payment_methods/{payment_method_id} Delete Payment Method #
GET /account Retrieve account details #
POST /account/addresses Add an address #
PUT /account/addresses/{id} Edit an existing address #
DELETE /account/addresses/{id} Delete an existing address #
POST /account/payment-methods Add a payment method #
DELETE /account/payment-methods/{id} Delete an existing payment method #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/bolt-financial-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bolt-financial-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Bolt Financial Account API
  version: '1.0'
  description: 'Operations tagged Account across 3 of this provider''s published API definitions: bolt-financial-bolt-api-openapi.yml, bolt-financial-embeddable-checkout-v1-openapi.yml, bolt-financial-embeddable-checkout-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.boltapp.com
  description: The Production URL (Live Data).
- url: https://api-sandbox.boltapp.com
  description: The Sandbox URL (Test Data).
- url: https://api-staging.boltapp.com
  description: The Staging URL (Staged Data).
- url: https://{environment}.boltapp.com/v3
  variables:
    environment:
      enum:
      - api
      - api-sandbox
      default: api-sandbox
tags:
- name: Account
  description: 'Use the Account endpoint to view and manage customer accounts. Perform actions such as creating an account, updating an address, or adding a payment method. This endpoint is for merchants using the Accounts Package. See our related guide on [Bolt OAuth](https://help.boltapp.com/developers/bolt-oauth/).

    '
paths:
  /v1/account:
    get:
      description: Fetch a shopper's account details to pre-fill checkout fields. This request must come from your backend for security purposes, as it requires the use of your private key to authenticate. For PCI compliance, only limited information is returned for each credit card available in the shopper’s wallet.
      operationId: getAccount
      parameters:
      - $ref: '#/components/parameters/x-publishable-key'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_details'
          description: Account Details Fetched
      security:
      - OAuth:
        - bolt.account.manage
        - bolt.account.view
        X-API-Key: []
      summary: Get Account Details
      tags:
      - Account
    post:
      description: Create a Bolt shopping account.
      operationId: createAccount
      parameters:
      - $ref: '#/components/parameters/x-publishable-key'
      - $ref: '#/components/parameters/idempotency_key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_account_input'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_details'
          description: Account Created
      security:
      - X-API-Key: []
      summary: Create Bolt Account
      tags:
      - Account
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /v1/account/profile:
    patch:
      description: Update the identifiers for a shopper's profile (first name or last name).
      operationId: updateAccountProfile
      parameters:
      - $ref: '#/components/parameters/x-publishable-key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_profile'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/profile_view'
          description: Profile Updated
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Update Profile
      tags:
      - Account
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /v1/account/addresses:
    post:
      description: Add an address to a shopper's account address book.
      operationId: addAddress
      parameters:
      - $ref: '#/components/parameters/x-publishable-key'
      - $ref: '#/components/parameters/idempotency_key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/address_account'
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/address_view_account'
                - properties:
                    default:
                      type: boolean
                  type: object
          description: Address Added Successfully
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Add Address
      tags:
      - Account
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /v1/account/addresses/{id}:
    delete:
      description: 'Deletes an existing address in a shopper''s address book.

        '
      operationId: deleteAddress
      parameters:
      - $ref: '#/components/parameters/shopper_address_id_path_param'
      - $ref: '#/components/parameters/x-publishable-key'
      responses:
        '200':
          description: Address Successfully Deleted
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Delete Address
      tags:
      - Account
    post:
      description: 'Replace an existing address in a shopper''s address book.

        These changes delete the existing address and create a new one.

        '
      operationId: replaceAddress
      parameters:
      - $ref: '#/components/parameters/shopper_address_id_path_param'
      - $ref: '#/components/parameters/x-publishable-key'
      - $ref: '#/components/parameters/idempotency_key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/address_account'
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/address_view_account'
                - properties:
                    default:
                      type: boolean
                  type: object
          description: Address Updated Successfully
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Replace Address
      tags:
      - Account
    put:
      description: 'Edit an existing address in a shopper''s address book.

        This endpoint fully replaces the information for an existing address while retaining the same address ID.

        '
      operationId: editAddress
      parameters:
      - $ref: '#/components/parameters/shopper_address_id_path_param'
      - $ref: '#/components/parameters/x-publishable-key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/address_account'
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/address_view_account'
                - properties:
                    default:
                      type: boolean
                  type: object
          description: Address Updated Successfully
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Edit Address
      tags:
      - Account
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /v1/account/exists:
    get:
      description: Check whether an account exists using one of `email`, `phone`, or `sha256_email` as the unique identifier.
      operationId: detectAccount
      parameters:
      - $ref: '#/components/parameters/email'
      - $ref: '#/components/parameters/sha256_email'
      - $ref: '#/components/parameters/phone'
      - $ref: '#/components/parameters/x_publishable_key_required'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_accounts_view'
          description: Has Bolt Account
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors_bolt_api_response'
          description: Missing Query Parameter
      summary: Detect Account
      tags:
      - Account
      security: []
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /v1/account/payment_methods:
    post:
      description: 'Add a payment method to a shopper''s Bolt account Wallet. For security purposes, this request must come from your backend because authentication requires the use of your private key.


        **Note**: Before using this API, the credit card details must be tokenized using Bolt''s JavaScript library function, which is documented in [Install the Bolt Tokenizer](https://help.boltapp.com/developers/references/bolt-tokenizer).

        '
      operationId: addPaymentMethod
      parameters:
      - $ref: '#/components/parameters/x-publishable-key'
      - $ref: '#/components/parameters/idempotency_key'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/credit_card_account'
              - properties:
                  currency:
                    description: This can be left empty. A 3-digit ISO code for currency that will be used in the credit card authorization.
                    type: string
                    example: USD
                type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/saved_credit_card_view'
          description: Payment Method Added
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Add Payment Method
      tags:
      - Account
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /v1/account/payment_methods/{payment_method_id}:
    delete:
      description: Delete a saved payment method from a shopper's Bolt account Wallet.
      operationId: deletePaymentMethod
      parameters:
      - $ref: '#/components/parameters/shopper_payment_method_id_path_param'
      - $ref: '#/components/parameters/x-publishable-key'
      responses:
        '200':
          description: Success
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors_bolt_api_response'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors_bolt_api_response'
          description: Not Found
      security:
      - OAuth:
        - bolt.account.manage
        X-API-Key: []
      summary: Delete Payment Method
      tags:
      - Account
    servers:
    - url: https://api.boltapp.com
      description: The Production URL (Live Data).
    - url: https://api-sandbox.boltapp.com
      description: The Sandbox URL (Test Data).
    - url: https://api-staging.boltapp.com
      description: The Staging URL (Staged Data).
  /account:
    get:
      summary: Retrieve account details
      operationId: accountGet
      x-speakeasy-name-override: GetDetails
      description: Retrieve a shopper's account details, such as addresses and payment information. The account's details are filtered to be relevant to your merchant account, and some fields may be missing for some accounts. See the schema for details.
      tags:
      - Account
      security:
      - oauth:
        - bolt.account.manage
        - bolt.account.view
        api-key: []
      parameters:
      - $ref: '#/components/parameters/x-publishable-key_2'
      - $ref: '#/components/parameters/x-merchant-client-id'
      responses:
        '200':
          description: The account details were successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account'
        4XX:
          $ref: '#/components/responses/response-4xx'
        default:
          $ref: '#/components/responses/response-default'
    servers:
    - url: https://{environment}.boltapp.com/v3
      variables:
        environment:
          enum:
          - api
          - api-sandbox
          default: api-sandbox
  /account/addresses:
    post:
      summary: Add an address
      operationId: accountAddressCreate
      x-speakeasy-name-override: AddAddress
      description: Add an address to the shopper's account
      tags:
      - Account
      security:
      - oauth:
        - bolt.account.manage
        api-key: []
      parameters:
      - $ref: '#/components/parameters/x-publishable-key_2'
      - $ref: '#/components/parameters/x-merchant-client-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/address-listing'
            examples:
              address-all-fields:
                $ref: '#/components/examples/address-all-fields'
              address-some-fields:
                $ref: '#/components/examples/address-some-fields'
      responses:
        '200':
          description: The address was successfully added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/address-listing'
        4XX:
          $ref: '#/components/responses/response-address-error'
        default:
          $ref: '#/components/responses/response-default'
    servers:
    - url: https://{environment}.boltapp.com/v3
      variables:
        environment:
          enum:
          - api
          - api-sandbox
          default: api-sandbox
  /account/addresses/{id}:
    put:
      summary: Edit an existing address
      operationId: accountAddressEdit
      x-speakeasy-name-override: UpdateAddress
      description: Edit an existing address on the shopper's account. This does not edit addresses that are already associated with other resources, such as transactions or shipments.
      tags:
      - Account
      security:
      - oauth:
        - bolt.account.manage
        api-key: []
      parameters:
      - $ref: '#/components/parameters/x-publishable-key_2'
      - $ref: '#/components/parameters/x-merchant-client-id'
      - in: path
        name: id
        schema:
          type: string
          example: D4g3h5tBuVYK9
        required: true
        description: The ID of the address to edit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/address-listing'
            examples:
              address-all-fields:
                $ref: '#/components/examples/address-all-fields'
              address-some-fields:
                $ref: '#/components/examples/address-some-fields'
      responses:
        '200':
          description: The address was successfully edited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/address-listing'
        4XX:
          $ref: '#/components/responses/response-address-error'
        default:
          $ref: '#/components/responses/response-default'
    delete:
      summary: Delete an existing address
      operationId: accountAddressDelete
      x-speakeasy-name-override: DeleteAddress
      description: Delete an existing address. Deleting an address does not invalidate or remove the address from transactions or shipments that are associated with it.
      tags:
      - Account
      security:
      - oauth:
        - bolt.account.manage
        api-key: []
      parameters:
      - $ref: '#/components/parameters/x-publishable-key_2'
      - $ref: '#/components/parameters/x-merchant-client-id'
      - in: path
        name: id
        schema:
          type: string
          example: D4g3h5tBuVYK9
        required: true
        description: The ID of the address to delete
      responses:
        '200':
          description: The address was successfully deleted
        4XX:
          $ref: '#/components/responses/response-4xx'
        default:
          $ref: '#/components/responses/response-default'
    servers:
    - url: https://{environment}.boltapp.com/v3
      variables:
        environment:
          enum:
          - api
          - api-sandbox
          default: api-sandbox
  /account/payment-methods:
    post:
      summary: Add a payment method
      operationId: accountAddPaymentMethod
      x-speakeasy-name-override: AddPaymentMethod
      description: 'Add a payment method to a shopper''s Bolt Account Wallet. For security purposes, this request must come from your backend. <br/> **Note**: Before using this API, the credit card details must be tokenized by Bolt''s credit card tokenization service. Please review our [Bolt Payment Field Component](https://help.boltapp.com/products/ignite/api-implementation/#enhance-payments) or [Install the Bolt Tokenizer](https://help.boltapp.com/developers/references/bolt-tokenizer) documentation.'
      tags:
      - Account
      security:
      - oauth:
        - bolt.account.manage
        api-key: []
      parameters:
      - $ref: '#/components/parameters/x-publishable-key_2'
      - $ref: '#/components/parameters/x-merchant-client-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/payment-method'
            examples:
              credit-card-address-reference-id:
                $ref: '#/components/examples/credit-card-with-address-id'
              credit-card-address-reference-explicit:
                $ref: '#/components/examples/credit-card-with-address-explicit'
      responses:
        '200':
          description: The payment method was successfully added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment-method'
        4XX:
          $ref: '#/components/responses/response-payment-method-error'
        default:
          $ref: '#/components/responses/response-default'
    servers:
    - url: https://{environment}.boltapp.com/v3
      variables:
        environment:
          enum:
          - api
          - api-sandbox
          default: api-sandbox
  /account/payment-methods/{id}:
    delete:
      summary: Delete an existing payment method
      operationId: accountPaymentMethodDelete
      x-speakeasy-name-override: DeletePaymentMethod
      description: Delete an existing payment method. Deleting a payment method does not invalidate or remove it from transactions or orders that are associated with it.
      tags:
      - Account
      security:
      - oauth:
        - bolt.account.manage
        api-key: []
      parameters:
      - $ref: '#/components/parameters/x-publishable-key_2'
      - $ref: '#/components/parameters/x-merchant-client-id'
      - in: path
        name: id
        schema:
          type: string
          example: D4g3h5tBuVYK9
        required: true
        description: The ID of the payment method to delete
      responses:
        '200':
          description: The payment method was successfully deleted
        4XX:
          $ref: '#/components/responses/response-4xx'
        default:
          $ref: '#/components/responses/response-default'
    servers:
    - url: https://{environment}.boltapp.com/v3
      variables:
        environment:
          enum:
          - api
          - api-sandbox
          default: api-sandbox
components:
  schemas:
    phone:
      description: A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
      example: '+12125550199'
      maxLength: 16
      type: string
    card_network:
      description: 'The card''s network code. **Nullable** for Transactions Details. Note: LEGACY diners_club_us_ca now tagged as mastercard

        '
      enum:
      - visa
      - mastercard
      - amex
      - discover
      - dinersclub
      - jcb
      - unionpay
      - alliancedata
      - citiplcc
      - unknown
      example: visa
      type: string
    address_view_account:
      description: The address object returned in the response.
      allOf:
      - $ref: '#/components/schemas/address_view'
      - properties:
          metadata:
            $ref: '#/components/schemas/shopper_metadata'
      type: object
    payment_method_account:
      allOf:
      - $ref: '#/components/schemas/credit_card_account'
      - properties:
          default:
            description: Set this to true to make this the default payment method. There can be only one payment method with default set to true.
            type: boolean
        type: object
      type: object
    request_failed:
      example: false
      type: boolean
      description: Indicates that the request failed. This value is always false.
    saved_credit_card_view:
      properties:
        billing_address:
          $ref: '#/components/schemas/address_view'
        id:
          description: The ID of the payment method associated with the Shopper's account.
          type: string
        last4:
          $ref: '#/components/schemas/card_last4'
        exp_month:
          description: The expiration month of the credit card.
          example: 11
          maxLength: 2
          minLength: 1
          type: integer
        exp_year:
          description: The expiration year of the credit card.
          example: 2024
          maxLength: 4
          minLength: 4
          type: integer
        network:
          $ref: '#/components/schemas/card_network'
        default:
          description: The default card payment method chosen by the shopper.
          type: boolean
        type:
          description: The payment method type. If empty, the property defaults to `card`.
          enum:
          - card
          - paypal
          type: string
        description:
          description: The APM account identifier; usually the email address.
          type: string
        metadata:
          $ref: '#/components/schemas/shopper_metadata'
      type: object
      description: Saved Credit Card Detail
    shopper_metadata:
      description: 'A key-value pair object that allows users to store arbitrary information associated with an object. For any individual account object, we allow up to 50 keys. Keys can be up to 40 characters long and values can be up to 500 characters long. Metadata should not contain any sensitive customer information, like PII (Personally Identifiable Information). For more information about metadata, see our [documentation](https://help.boltapp.com/developers/references/embedded-metadata/).

        '
      example:
        customer_id: 234
      properties:
        additionalProperties:
          type: string
      type:
      - object
      - 'null'
    door_code:
      description: The building door code or community gate code.
      example: '123456'
      maxLength: 1024
      type:
      - string
      - 'null'
    profile_view:
      description: The shopper's account profile.
      properties:
        email:
          $ref: '#/components/schemas/email'
        first_name:
          description: The given name of the person associated with this record.
          example: Alan
          type: string
        last_name:
          description: The surname of the person associated with this record.
          example: Watts
          type: string
        metadata:
          $ref: '#/components/schemas/shopper_metadata'
        name:
          description: The given and surname of the person associated with this address.
          example: Alan Watts
          type: string
        phone:
          $ref: '#/components/schemas/phone'
      type: object
    message:
      description: Human-readable description of the error for developers. Should not be shown to users and is not localized.
      example: The input is missing a required parameter.
      type: string
    saved_paypal_account_view:
      properties:
        id:
          description: The ID of the payment method associated with the Shopper's account.
          type: string
        type:
          description: Type field indicates this is a saved PayPal to differentiate it from a saved card.
          enum:
          - paypal
          type: string
        description:
          description: The email associated with a shopper's saved PayPal account.
          type: string
        metadata:
          $ref: '#/components/schemas/shopper_metadata'
      type: object
      description: Saved PayPal account details.
    v1_accounts_view:
      properties:
        has_bolt_account:
          type: boolean
      type: object
    profile:
      description: The first name, last name, email address, and phone number of a shopper.
      properties:
        email:
          description: The email of the person associated with this profile.
          $ref: '#/components/schemas/email'
        first_name:
          description: The given name of the person associated with this record.
          example: Alan
          type: string
        last_name:
          description: The surname of the person associated with this record.
          example: Watts
          type: string
        metadata:
          $ref: '#/components/schemas/shopper_metadata'
        phone:
          description: The phone number of the person associated with this profile.
          $ref: '#/components/schemas/phone'
      required:
      - first_name
      - last_name
      - email
      type: object
    code:
      description: Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
      example: 2001005
      format: int64
      type: integer
    address_view:
      description: The address object returned in the response.
      properties:
        company:
          description: The company name associated with this address.
          example: Bolt
          type: string
        country:
          description: The name of the country associated with this address.
          example: United States
          type: string
        country_code:
          description: The ISO 3166-1 alpha-2 country code associated with this address.
          example: US
          type: string
        door_code:
          $ref: '#/components/schemas/door_code'
        email_address:
          description: The email address associated with this address.
          $ref: '#/components/schemas/email'
        first_name:
          description: The given name of the person associated with this address.
          example: Alan
          type: string
        id:
          description: The unique Bolt ID associated with this address.
          type: string
        last_name:
          description: The surname of the person associated with this address.
          example: Watts
          type: string
        locality:
          description: The city name details associated with this address.
          example: Brooklyn
          type: string
        name:
          description: The given and surname of the person associated with this address.
          example: Alan Watts
          type: string
        phone_number:
          description: The phone number associated with this address.
          $ref: '#/components/schemas/phone'
        postal_code:
          description: The postal or zip code associated with this address.
          example: '10044'
          maxLength: 32
          type: string
        priority:
          description: The shopper-indicated priority of this address compared to other addresses on their account.
          example: primary
          type:
          - string
          - 'null'
          enum:
          - primary
          - listed
        region:
          description: The region details such as state or province associated with this address.
          example: NY
          type: string
        region_code:
          description: The the ISO 3166-2 region code associated with this address.
          example: NY
          type:
          - string
          - 'null'
        street_address1:
          description: The street number and street name of the address.
          example: 888 main street
          type: string
        street_address2:
          description: Any apartment, floor, or unit details.
          example: apt 3021
          type: string
        street_address3:
          description: Any additional street address details.
          example: c/o Alicia Watts
          type:
          - string
          - 'null'
        street_address4:
          description: Any additional street address details.
          example: Bridge Street Apartment Building B
          type:
          - string
          - 'null'
      type: object
    address:
      description: The Address object is used for billing, shipping, and physical store address use cases.
      properties:
        company:
          description: The company name associated with this address.
          example: Bolt
          maxLength: 1024
          type: string
        country:
          description: The name of the country associated with this address.
          example: United States
          maxLength: 1024
          type: string
        country_code:
          description: The ISO 3166-1 alpha-2 country code associated with this address.
          example: US
          maxLength: 2
          minLength: 2
          type: string
        default:
          description: Whether the added address is now the default address.
          example: true
          type: boolean
        door_code:
          $ref: '#/components/schemas/door_code'
        email:
          description: The email address associated with this address.
          $ref: '#/components/schemas/email'
        first_name:
          description: The given name of the person associated with this address.
          example: Alan
          maxLength: 1024
          type: string
        last_name:
          description: The surname of the person associated with this address.
          example: Watts
          maxLength: 1024
          type: string
        locality:
          description: The city name details associated with this address.
          example: Brooklyn
          maxLength: 1024
          type: string
        name:
          description: The given and surname of the person associated with this address.
          example: Alan Watts
          maxLength: 1024
          type: string
        phone:
          description: The phone number associated with this address.
          $ref: '#/components/schemas/phone'
        postal_code:
          description: The the postal or zip code associated with this address.
          example: '10044'
          maxLength: 32
          type: string
        region:
          description: '**Not Required for NON US addresses**. The region details such as state or province associated with this address.'
          example: NY
          maxLength: 1024
          type: string
        region_code:
          description: "The ISO 3166-2 region code associated with this address.\n  - * If specified, value must be valid for the `country`.\n  - * If null, value is inferred from the `region`.\n"
          example: NY
          maxLength: 1024
          type:
          - string
          - 'null'
        street_address1:
          description: The street number and street name of the address.
          example: 888 main street
          maxLength: 1024
        

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bolt-financial/refs/heads/main/openapi/bolt-financial-account-api-openapi.yml