CompanyUpdate

Company fields accepted when creating or updating an account.

  • address
    nullable

    The customer's address.

    • city
      Type: string | null
      max length:  
      100

      City, district, suburb, town, or village.

    • country
      Type: string | null
      max length:  
      2

      Two-letter country code (ISO 3166-1 alpha-2).

    • line1
      Type: string | null
      max length:  
      100

      Address line 1 (e.g., street, PO Box, or company name).

    • line2
      Type: string | null
      max length:  
      100

      Address line 2 (e.g., apartment, suite, unit, or building).

    • postal_code
      Type: string | null
      max length:  
      100

      ZIP or postal code.

    • state
      Type: string | null
      max length:  
      100

      State, county, province, or region.

  • directors_provided
    Type: boolean

    Whether the company's directors have been provided.

  • executives_provided
    Type: boolean

    Whether the company's executives have been provided.

  • name
    Type: string | null

    The legal name of the company.

  • owners_provided
    Type: boolean

    Whether the company's owners have been provided.

  • phone
    Type: string | null

    The official business phone for verification and compliance.

  • registration_date
    Type: object · RegistrationDatenullable

    The date on which the company was incorporated or registered.

    Date on which a company was incorporated or registered.

    • day
      Type: integer Format: int32
      min:  
      1
      max:  
      31
      required

      Signed 32-bit integers (commonly used integer type).

    • month
      Type: integer Format: int32
      min:  
      1
      max:  
      12
      required

      Signed 32-bit integers (commonly used integer type).

    • year
      Type: integer Format: int32
      min:  
      1000
      max:  
      9999
      required

      Signed 32-bit integers (commonly used integer type).

  • registration_number
    Type: string | null

    The company's registration number.

  • structure
    Type: string · CompanyStructureenumnullable

    The structure of the company.

    values
    • multi_member_llc
    • private_corporation
    • private_partnership
    • public_corporation
    • public_partnership
  • tax_id
    Type: string | null

    The company's tax identifier, as appropriate for its country.

  • tax_id_registrar
    Type: string | null

    The jurisdiction in which the tax ID is registered.

  • vat_id
    Type: string | null

    The company's VAT number.