openapi: 3.2.0
info:
  title: Business Beneficial owners address API
  description: Businesses
  version: '0'
servers:
- url: https://sandbox.bond.tech/api/v0
security:
- identity: []
  authorization: []
tags:
- name: Beneficial owners address
paths:
  /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses:
    get:
      tags:
      - Beneficial owners address
      summary: Retrieve all beneficial owner addresses
      description: Retrieves all addresses associated with a beneficial owner
      operationId: get_beneficial_owner_addresses
      parameters:
      - name: business_id
        in: path
        required: true
        schema:
          type: string
      - name: beneficial_owner_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              examples:
                example:
                  value:
                    page_info:
                      page_size: 2
                      page: 1
                      pages: 1
                    data:
                    - date_created: '2019-08-24T14:15:22.000Z'
                      date_updated: '2020-06-24T14:15:22.000Z'
                      address_id: 12348579-5d05-4e3e-a5e3-e61e3a5b1234
                      address_type: MAILING
                      street: 345 California Ave.
                      street2: Suit 600
                      city: San Francisco
                      state: CA
                      zip_code: 12345-1234
                      country: US
                      is_primary: true
                    - date_created: '2019-08-24T14:15:22.000Z'
                      date_updated: '2021-04-24T14:15:22.000Z'
                      address_id: 12348579-5d05-4e3e-a5e3-e61e3a5b1234
                      address_type: MAILING
                      street: 123 Oregon Ave.
                      street2: Suit 100
                      city: San Portier
                      state: AL
                      zip_code: 12345-1234
                      country: US
                      is_primary: false
    post:
      tags:
      - Beneficial owners address
      summary: Create a beneficial owner address
      description: Creates an address associated with a beneficial owner
      operationId: post_beneficial_owner_addresses
      parameters:
      - name: business_id
        in: path
        required: true
        schema:
          type: string
      - name: beneficial_owner_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
        required: true
      responses:
        '201':
          $ref: '#/components/responses/Business-address'
  /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses/{address_id}:
    get:
      tags:
      - Beneficial owners address
      summary: Retrieve a beneficial owner address
      description: Retrieves an address associated with a beneficial owner
      operationId: get_beneficial_owner_address
      parameters:
      - name: business_id
        in: path
        required: true
        schema:
          type: string
      - name: beneficial_owner_id
        in: path
        required: true
        schema:
          type: string
      - name: address_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/Business-address'
    delete:
      tags:
      - Beneficial owners address
      summary: Delete a beneficial owner address
      description: Delete an address associated with a beneficial owner
      operationId: delete_beneficial_owner_address
      parameters:
      - name: business_id
        in: path
        required: true
        schema:
          type: string
      - name: beneficial_owner_id
        in: path
        required: true
        schema:
          type: string
      - name: address_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
          content: {}
    patch:
      tags:
      - Beneficial owners address
      summary: Update a beneficial owner address
      description: Update an address associated with a beneficial owner
      operationId: patch_beneficial_owner_address
      parameters:
      - name: business_id
        in: path
        required: true
        schema:
          type: string
      - name: beneficial_owner_id
        in: path
        required: true
        schema:
          type: string
      - name: address_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficialOwnerAddressPatchSerializer'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/Business-address-write'
      x-codegen-request-body-name: payload
components:
  schemas:
    Address:
      title: ''
      type: object
      properties:
        address_type:
          type: string
          description: 'Address type is one of the following : MAILING, PHYSICAL, REGISTERED'
          enum:
          - MAILING
          - PHYSICAL
          - REGISTERED
        street:
          type: string
          description: 'Has a 1 to 40-character limit. May only contain alphanumerics and the special characters `. , _ - #`'
          example: 345 California Ave.
        street2:
          type: string
          description: 'Has a 40-character limit. May only contain alphanumerics and the special characters `. , _ - #`'
          example: Suit 600
        city:
          type: string
          description: Has a 2 to 40-character limit. May contain only alphanumerics, `-`, `_`,`.`, and spaces
          example: San Francisco
          minLength: 2
          maxLength: 40
        state:
          type: string
          description: Has a 2-character limit for US address.<br />Has a 20-character limit for non US address.
          example: CA
        zip_code:
          type: string
          description: zip code in 5-digit (12345) or 9-digit (12345-1234) format for US address.<br />Has a 2 to 20-character limit for non US address.
          example: 12345-1234
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code.<br />Has a 2-character limit.
          example: US
        is_primary:
          type: boolean
          description: Is Primary Address?
          example: true
      required:
      - address_type
      - street
      - city
      - state
      - zip_code
      - country
      - is_primary
    BeneficialOwnerAddressPatchSerializer:
      type: object
      properties:
        address_type:
          type: string
          description: 'Address type is one of the following : MAILING, PHYSICAL'
          enum:
          - MAILING
          - PHYSICAL
        street:
          type: string
          description: 'Has a 1 to 40-character limit. May only contain alphanumerics and the special characters `. , _ - #`'
          example: 345 California Ave.
        street2:
          type: string
          description: 'Has a 40-character limit. May only contain alphanumerics and the special characters `. , _ - #`'
          example: Suit 600
        city:
          type: string
          description: Has a 2 to 40-character limit. May contain only alphanumerics, `-`, `_`,`.`, and spaces
          example: San Francisco
          minLength: 2
          maxLength: 40
        state:
          type: string
          description: Has a 2-character limit for US address.<br />Has a 20-character limit for non US address.
          example: CA
        zip_code:
          type: string
          description: zip code in 5-digit (12345) or 9-digit (12345-1234) format for US address.<br />Has a 2 to 20-character limit for non US address.
          example: 12345-1234
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code.<br />Has a 2-character limit.
          example: US
        is_primary:
          type: boolean
          description: Is Primary Address?
          example: true
  responses:
    Business-address:
      description: Example response
      content:
        application/json:
          schema:
            description: ''
            type: object
            properties:
              date_created:
                type: string
                minLength: 1
              address_id:
                type: string
                minLength: 1
              address_type:
                type: string
                minLength: 1
              street:
                type: string
                minLength: 1
                maxLength: 40
              street2:
                type: string
                maxLength: 40
              city:
                type: string
                minLength: 1
                description: Has a 2 to 40-character limit. May contain only alphanumerics, `-`, `_`,`.`, and spaces
              state:
                type: string
                minLength: 1
              zip_code:
                type: string
                minLength: 1
              country:
                type: string
                minLength: 1
              is_primary:
                type: boolean
            required:
            - date_created
            - address_id
            - address_type
            - street
            - street2
            - city
            - state
            - zip_code
            - country
            - is_primary
          examples:
            example:
              value:
                date_created: '2019-08-24T14:15:22Z'
                address_id: 12348579-5d05-4e3e-a5e3-e61e3a5b1234
                address_type: MAILING
                street: 345 California Ave.
                street2: Suit 600
                city: San Francisco
                state: CA
                zip_code: 12345-1234
                country: US
                is_primary: true
    Business-address-write:
      description: Example response
      content:
        application/json:
          schema:
            description: ''
            type: object
            properties:
              address_type:
                type: string
                minLength: 1
              street:
                type: string
                minLength: 1
                maxLength: 40
              street2:
                type: string
                maxLength: 40
              city:
                type: string
                minLength: 2
                maxLength: 40
                description: Has a 2 to 40-character limit. May contain only alphanumerics, `-`, `_`,`.`, and spaces
              state:
                type: string
                minLength: 1
              zip_code:
                type: string
                minLength: 1
              country:
                type: string
                minLength: 1
              is_primary:
                type: boolean
            required:
            - address_type
            - street
            - street2
            - city
            - state
            - zip_code
            - country
            - is_primary
          examples:
            example:
              value:
                address_type: MAILING
                street: 345 California Ave.
                street2: Suit 600
                city: San Francisco
                state: CA
                zip_code: 12345-1234
                country: US
                is_primary: true
  securitySchemes:
    identity:
      type: apiKey
      name: Identity
      in: header
    authorization:
      type: apiKey
      name: Authorization
      in: header
x-samples-languages:
- curl
- node
- ruby
- javascript
- python
- csharp
- java
x-provenance:
  method: searched
  source: https://docs.bond.tech/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.bond.tech/reference/delete_beneficial_owner.md
  - https://docs.bond.tech/reference/delete_beneficial_owner_address.md
  - https://docs.bond.tech/reference/delete_business.md
  - https://docs.bond.tech/reference/delete_business_address.md
  - https://docs.bond.tech/reference/get_beneficial_owner.md
  - https://docs.bond.tech/reference/get_beneficial_owner_address.md
  - https://docs.bond.tech/reference/get_beneficial_owner_addresses.md
  - https://docs.bond.tech/reference/get_beneficial_owner_kyc.md
  - https://docs.bond.tech/reference/get_beneficial_owners.md
  - https://docs.bond.tech/reference/get_business.md
  - https://docs.bond.tech/reference/get_business_address.md
  - https://docs.bond.tech/reference/get_business_addresses.md
  - https://docs.bond.tech/reference/get_businesses.md
  - https://docs.bond.tech/reference/get_kyb.md
  - https://docs.bond.tech/reference/patch_beneficial_owner.md
  - https://docs.bond.tech/reference/patch_beneficial_owner_address.md
  - https://docs.bond.tech/reference/patch_business.md
  - https://docs.bond.tech/reference/patch_business_address.md
  - https://docs.bond.tech/reference/post_beneficial_owner_addresses.md
  - https://docs.bond.tech/reference/post_beneficial_owner_kyc.md
  - https://docs.bond.tech/reference/post_beneficial_owners.md
  - https://docs.bond.tech/reference/post_business_addresses.md
  - https://docs.bond.tech/reference/post_businesses.md
  - https://docs.bond.tech/reference/post_kyb.md
  - https://docs.bond.tech/reference/post_kyb_2.md
  - https://docs.bond.tech/reference/post_kyb_resume.md
  merge:
    pages: 26
    deduped: 64
    conflicts_kept_first: 0