v.0.0.45

Business registration API


New query

  • GraphQL query for retrieving business categories
    • getBusinessCategories: [BusinessCategory]
  • New response types
    • BusinessCategory { businessCategoryId: UUID, categoryName: String, categoryDescription: String, businessSubCategories: [BusinessSubCategory] }
    • BusinessSubCategory { businessSubCategoryId: UUID, subCategoryName: String }

New Mutation

  • GraphQL mutation for programmatic business registration
    • registerBusiness(input: RegisterBusinessInput!): RegisterBusinessResult
  • New input types
    • RegisterBusinessInput { businessName: String!, dbaName: String, businessStructure: BusinessStructure!, businessLegalAddress: BusinessLegalAddressInput!, stateOfIncorporation: String!, taxId: String!, soleProprietorshipDocumentUrl: String, businessCategoryId: UUID!, businessSubCategoryId: UUID!, natureOfBusiness: String, websiteUrl: String, businessAccountUsage: [BusinessAccountUsage], businessAccountUsageOther: String, owners: [BusinessOwnerInput!]! }
    • BusinessLegalAddressInput { streetAddressLine1: String!, streetAddressLine2: String, city: String!, state: String!, postalCode: String!, country: String! }
    • BusinessOwnerInput { firstName: String!, lastName: String!, emailAddress: String!, title: String!, ownershipPercentage: Int!, lastFourSsnDigits: String!, dob: String!, phoneNumber: String!, address: OwnerAddressInput! }
    • OwnerAddressInput { streetAddressLine1: String!, streetAddressLine2: String, city: String!, state: String!, postalCode: String! }
  • New enum types
    • BusinessStructure { LLC, CORPORATION, PARTNERSHIP, SOLE_PROPRIETORSHIP, COOP }
    • BusinessAccountUsage { CORPORATE_GIFTING, CORPORATE_SPENDING_ADMIN, REWARDS_MAXIMIZER, GIFT_CARD_RESELLING, PURCHASE_GOODS_FOR_BUSINESS_USE, ONLINE_SELLER_RETAIL_PURCHASING }
  • New response type
    • RegisterBusinessResult { accountId: UUID, kybStatus: String, success: Boolean, error: RegisterBusinessError }
    • RegisterBusinessError { message: String, code: String }

Authentication

  • Both operations require authentication with the REGISTER_BUSINESS OAuth scope