Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AccountInformationModel(val consumerInformation: ConsumerInformationDetailsModel?, val businessInformation: BusinessInformationDetailsModel?, val stakeholders: List<StakeholderDetailsModel>?, val businessAccountUuid: String?, val stakeholderInformation: StakeholderInformationDetailsModel?, val parentAccountUuid: String?, val cardholderInformation: CardholderInformationDetailsModel?)

User account information according to account type AccountTypeModel.

Link copied to clipboard
Link copied to clipboard

The current stage in the verification process.

Link copied to clipboard

The user account current status.

Link copied to clipboard

The reason why an account might be in a particular status.

Link copied to clipboard

The type of account.

Link copied to clipboard
@Serializable
data class BusinessInformationDetailsModel(val businessTypeString: String, val businessType: BusinessTypeModel? = businessTypeString.getEnum<BusinessTypeModel>(), val businessName: String, val doingBusinessAs: String?, val countryOfIncorporationString: String, val countryOfIncorporation: CountryModel? = countryOfIncorporationString.getEnum<CountryModel>(), val phoneNumber: String?, val website: String?, val emailAddress: String?, val natureOfBusiness: String?, val accountPurposeString: String?, val accountPurpose: AccountPurposeTypeModel? = accountPurposeString?.getEnum<AccountPurposeTypeModel>(), val accountPurposeDetails: String?, val tradingVolume: String?, val transactionVolume: String?, val sourceOfFundsString: String?, val sourceOfFunds: AccountStatusModel? = sourceOfFundsString?.getEnum<AccountStatusModel>(), val stateOfIncorporation: String?, val ein: String?, val companyId: String?, val vatNumber: String?, val incorporationDate: String?)

Account business information.

Link copied to clipboard

Business types.

Link copied to clipboard
@Serializable
data class CardholderInformationDetailsModel(val firstName: String?, val middleName: String?, val lastName: String?, val dateOfBirth: String?, val emailAddress: String?)

Account Cardholder information.

Link copied to clipboard
@Serializable
data class ConsumerInformationDetailsModel(val firstName: String?, val middleName: String?, val lastName: String?, val dateOfBirth: String?, val ssnLast4: String?, val idInformation: IdInformationDetailsModel?, val phoneNumber: String?, val emailAddress: String?)

Account consumer information.

Link copied to clipboard
@Serializable
data class DocumentDetailsModel(val documentTypeString: String, val documentType: DocumentTypeModel? = documentTypeString.getEnum<DocumentTypeModel>(), var countryOfIssuance: CountryModel? = null, var file: String?, val barcodeData: String?, val failReasons: List<String>?, val extractedData: DocumentExtractedDataModel?)

Document details.

Link copied to clipboard
@Serializable
data class DocumentExtractedAddressModel(val lineOne: String?, val lineTwo: String?, val city: String?, val state: String?, val postalCode: String?, val country: String?)

Document extracted address via OCR.

Link copied to clipboard
@Serializable
data class DocumentExtractedDataModel(var givenName: String?, var lastName: String?, var dateOfBirth: String?, var address: DocumentExtractedAddressModel?)

Document extracted data via OCR.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Serializable
data class IdInformationDetailsModel(val idTypeString: String?, val idType: IdTypeModel? = idTypeString?.getEnum<IdTypeModel>(), val idNumberLast4: String?, val idCountryString: String?, val idCountry: CountryModel? = idCountryString?.getEnum<CountryModel>(), val idExpireDate: String?)

User identity document information. Only present for EU consumers.

Link copied to clipboard

User identity document types.

Link copied to clipboard
Link copied to clipboard

Source of funds types.

Link copied to clipboard
@Serializable
data class StakeholderDetailsModel(val stakeholderUuid: String, val externalId: String, val statusString: String, val status: AccountStatusModel? = statusString.getEnum<AccountStatusModel>(), val statusReasonString: String?, val statusReason: AccountStatusReasonModel? = statusReasonString?.getEnum<AccountStatusReasonModel>(), val stageString: String?, val stage: AccountStageModel? = stageString?.getEnum<AccountStageModel>(), val stakeholderTypesString: List<String>, val stakeholderTypes: List<StakeholderTypeModel?> = stakeholderTypesString.map { it.getEnum<StakeholderTypeModel>() }, val officerTitles: List<String>?, val percentOwnership: Float?, val firstName: String, val middleName: String?, val lastName: String, val dateOfBirth: String?)

Stakeholders of a business account.

Link copied to clipboard
@Serializable
data class StakeholderInformationDetailsModel(val stakeholderTypesString: List<String>, val stakeholderTypes: List<StakeholderTypeModel?> = stakeholderTypesString.map { it.getEnum<StakeholderTypeModel>() }, val officerTitles: List<String>?, val percentOwnership: Float?, val firstName: String, val middleName: String?, val lastName: String, val dateOfBirth: String?)

Account stakeholder information.

Link copied to clipboard