AccountRequests

Namespace for account request body types.

Types

Link copied to clipboard

Request body for confirming a phone verification.

Link copied to clipboard
data class CreateAccountProfile(val business: AccountObjects.BusinessAccount? = null, val individual: AccountRequests.CreateIndividualAccount? = null)

Profile container used when creating an account; holds business or individual data.

Link copied to clipboard
data class CreateAccountRequest(val type: AccountObjects.AccountType, val externalId: String? = null, val termsOfService: AccountObjects.AccountTermsOfService? = null, val metadata: Map<String, String>? = null, val profile: AccountRequests.CreateAccountProfile, val capabilities: List<String> = emptyList())

Request body for creating a new account.

Link copied to clipboard
data class CreateIndividualAccount(val name: AccountObjects.IndividualAccountName? = null, val email: String? = null, val phone: AccountObjects.AccountPhoneNumber? = null, val address: FrameObjects.BillingAddress? = null, val birthdate: String? = null, val ssn: String? = null, val ssnLast4: String? = null, val profileURL: String? = null)

Profile data for creating an individual account holder.

Link copied to clipboard
data class UpdateAccountInfo(val firstName: String? = null, val middleName: String? = null, val lastName: String? = null, val suffix: String? = null)

Name update fields for an individual account holder.

Link copied to clipboard

Profile container used when updating an account.

Link copied to clipboard
data class UpdateAccountRequest(val type: AccountObjects.AccountType? = null, val externalId: String? = null, val termsOfService: AccountObjects.AccountTermsOfService? = null, val metadata: Map<String, String>? = null, val profile: AccountRequests.UpdateAccountProfile? = null)

Request body for updating an existing account.

Link copied to clipboard
data class UpdateBusinessAccount(val legalBusinessName: String? = null, val doingBusinessAs: String? = null, val businessType: String? = null, val email: String? = null, val website: String? = null, val description: String? = null, val einLastFour: String? = null, val mcc: String? = null, val naics: String? = null, val address: FrameObjects.BillingAddress? = null, val phone: AccountObjects.AccountPhoneNumber? = null)

Updated profile data for a business account.

Link copied to clipboard
data class UpdateIndividualAccount(val name: AccountRequests.UpdateAccountInfo? = null, val email: String? = null, val phoneNumber: String? = null, val phoneCountryCode: String? = null, val address: FrameObjects.BillingAddress? = null, val birthdate: String? = null, val ssn: String? = null, val ssnLast4: String? = null, val profileURL: String? = null)

Updated profile data for an individual account holder.