> ## Documentation Index
> Fetch the complete documentation index at: https://developer.bron.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Address Book record

> Save a crypto address in an workspace's address book

<sup>API Key permissions: Transaction Operator, Full Access</sup>



## OpenAPI

````yaml /bron-open-api-public.json post /workspaces/{workspaceId}/address-book-records
openapi: 3.1.1
info:
  description: >-
    Bron API is based on the RESTish interface provided for data exchange
    between a client and a server with the use of HTTPS requests and responses.
  title: Bron API
  version: latest
  x-bron-formats:
    bigint: Arbitrary-precision integer encoded as a JSON string.
    date-time-millis: >-
      Epoch milliseconds (UTC) encoded as a JSON string. Convert with `new
      Date(parseInt(value))` or equivalent.
    decimal: Arbitrary-precision decimal encoded as a JSON string.
    int32: 32-bit integer encoded as a JSON string.
    int64: >-
      Long integer encoded as a JSON string to preserve precision (e.g. account
      IDs).
servers:
  - description: app.bron.org
    url: https://api.bron.org
security: []
tags:
  - name: stake
  - name: balances
  - name: addresses
  - name: intents
  - name: assets
  - name: transaction-limits
  - name: canton
  - name: address-book
  - name: workspaces
  - name: accounts
  - name: transactions
paths:
  /workspaces/{workspaceId}/address-book-records:
    post:
      tags:
        - address-book
      summary: Create Address Book record
      description: |-
        Save a crypto address in an workspace's address book

        <sup>API Key permissions: Transaction Operator, Full Access</sup>
      parameters:
        - in: path
          name: workspaceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAddressBookRecord'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressBookRecord'
          description: OK
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: The machine-readable error code
                    examples:
                      - bad-request
                    type: string
                  message:
                    description: >-
                      A human-readable message providing more details about the
                      error
                    type: string
                type: object
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: The machine-readable error code
                    examples:
                      - forbidden
                    type: string
                  message:
                    description: >-
                      A human-readable message providing more details about the
                      error
                    type: string
                type: object
          description: Forbidden
        '409':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: The machine-readable error code
                    examples:
                      - conflict
                    type: string
                  message:
                    description: >-
                      A human-readable message providing more details about the
                      error
                    type: string
                type: object
          description: Conflict
components:
  schemas:
    CreateAddressBookRecord:
      properties:
        accountIds:
          description: Comma-separated account ids, if address set for particular accounts
          items:
            type: string
          type: array
        address:
          description: Address
          type: string
        bankDetails:
          $ref: '#/components/schemas/BankDetails'
          description: Bank details (for bank type records)
        externalId:
          description: Address book entry external ID
          type: string
        imageId:
          description: Workspace image ID (for tag type records)
          type: string
        memo:
          description: Address memo (destination tag for XRP)
          type: string
        name:
          description: Name of the address
          type: string
        networkId:
          description: Blockchain Network Id of an address
          type: string
        recordType:
          $ref: '#/components/schemas/RecordType'
          description: 'Record type: address, tag, or bank. [See details](/enums/RecordType)'
        tag:
          description: Workspace tag (for tag type records)
          type: string
      required:
        - externalId
        - name
      type: object
    AddressBookRecord:
      properties:
        accountIds:
          description: Comma-separated account ids, if address set for particular accounts
          items:
            type: string
          type: array
        address:
          description: Blockchain address string
          examples:
            - TKAduQVqNaTLyBzVvRrcctY6FFraowJ3Uc
          type: string
        createdAt:
          description: Created at timestamp
          examples:
            - '1749646207296'
          format: date-time-millis
          type: string
        createdBy:
          description: Created by user id
          examples:
            - e191u51yxnykins6fahdizxy
          type: string
        externalId:
          description: Address book entry external ID
          examples:
            - ki50iq4iotxmuv1ihgw9q6u3
          type: string
        imageId:
          description: Workspace image ID (for tag type records)
          type: string
        lastUsedAt:
          description: Last used at
          examples:
            - '1749646207296'
          format: date-time-millis
          type: string
        memo:
          description: Address memo (destination tag for XRP)
          type: string
        name:
          description: Name of the address
          examples:
            - My address
          type: string
        networkId:
          description: Currency of an address
          examples:
            - BTC
          type: string
        recordId:
          description: Address book record ID
          examples:
            - gx8df95a09h319dbu79rfora
          type: string
        recordType:
          $ref: '#/components/schemas/RecordType'
          description: 'Record type: address, tag, or bank. [See details](/enums/RecordType)'
        status:
          $ref: '#/components/schemas/RecordStatus'
          description: '[See details](/enums/RecordStatus)'
        tag:
          description: Workspace tag (for tag type records)
          examples:
            - $myworkspace
          type: string
        updatedAt:
          description: Last updated Updated at timestamp
          examples:
            - '1749646207296'
          format: date-time-millis
          type: string
        updatedBy:
          description: Updated by user id
          examples:
            - e191u51yxnykins6fahdizxy
          type: string
        workspaceId:
          description: Workspace ID
          examples:
            - e191u51yxnykins6fahd
          type: string
      required:
        - recordId
        - externalId
        - workspaceId
        - recordType
        - name
        - status
        - createdAt
      type: object
    BankDetails:
      properties:
        accountHolderType:
          $ref: '#/components/schemas/AccountHolderType'
          description: Account holder type. [See details](/enums/AccountHolderType)
          examples:
            - individual
        accountNumber:
          description: Account number / IBAN
          examples:
            - DE89370400440532013000
          type: string
        accountType:
          $ref: '#/components/schemas/BankAccountType'
          description: >-
            Account type — required by Noah for ACH and international SWIFT
            (USD-style). [See details](/enums/BankAccountType)
          examples:
            - checking
        bankAddress:
          $ref: '#/components/schemas/BankAddress'
          description: >-
            Structured bank address — required by Noah for ACH/Wire/SWIFT
            channels, omit for SEPA
        bankCode:
          description: >-
            Bank code: BIC (SWIFT) / 9-digit routing number (US ACH) / sort code
            (UK)
          examples:
            - DEUTDEFF
          type: string
        businessName:
          description: Business name (for Business holder)
          examples:
            - Acme LLC
          type: string
        businessRegistrationNumber:
          description: Company registration number (for Business holder)
          examples:
            - '12019991'
          type: string
        channelType:
          $ref: '#/components/schemas/BankChannelType'
          description: Payment channel type. [See details](/enums/BankChannelType)
          examples:
            - sepa
        correspondentBankCode:
          description: Correspondent bank SWIFT/BIC code for international SWIFT payments
          examples:
            - IRVTUS3N
          type: string
        country:
          description: >-
            ISO-3166-1 alpha-2 country code, or 'XX' for global SWIFT-like
            fallback
          examples:
            - DE
          type: string
        fiatCurrency:
          description: Fiat currency code (ISO-4217)
          examples:
            - EUR
          type: string
        firstName:
          description: First name (for Individual holder)
          examples:
            - Dmitry
          type: string
        issuer:
          description: >-
            Bank name and address — free-form text shown to the user as a single
            block
          examples:
            - Acme Bank. 1 Example Street, London, UK
          type: string
        lastName:
          description: Last name (for Individual holder)
          examples:
            - Tokarev
          type: string
        paymentPurpose:
          description: Payment purpose — required by Noah for ACH/Fedwire/SWIFT-EUR
          examples:
            - Vendor / Contractor Payouts
          type: string
        reference:
          description: Reference shown on the beneficiary's bank statement
          examples:
            - Invoice 1234
          type: string
        registeredAddress:
          description: Registered address (for Business holder)
          examples:
            - 123 Business Street, London, UK
          type: string
      required:
        - country
        - fiatCurrency
        - channelType
        - accountHolderType
        - accountNumber
        - issuer
      type: object
    RecordType:
      enum:
        - address
        - tag
        - bank
      type: string
    RecordStatus:
      enum:
        - new
        - active
        - rejected
        - deleted
      type: string
    AccountHolderType:
      enum:
        - individual
        - business
      type: string
    BankAccountType:
      enum:
        - checking
        - savings
      type: string
    BankAddress:
      properties:
        address:
          description: Street address, line 1
          examples:
            - 1 Main St
          type: string
        city:
          description: City
          examples:
            - New York
          type: string
        country:
          description: >-
            ISO-3166-1 alpha-2 country code; defaults to BankDetails.country
            when omitted
          examples:
            - US
          type: string
        postalCode:
          description: Postal / ZIP code
          examples:
            - '10001'
          type: string
        state:
          description: State / province
          examples:
            - NY
          type: string
      type: object
    BankChannelType:
      enum:
        - sepa
        - ach
        - swift
        - fedwire
        - local
      type: string

````