stellar-sdk/com.soneso.stellar.sdk.sep.sep09/OrganizationKYCFields

OrganizationKYCFields

data class OrganizationKYCFields(val name: String? = null, val VATNumber: String? = null, val registrationNumber: String? = null, val registrationDate: String? = null, val registeredAddress: String? = null, val numberOfShareholders: Int? = null, val shareholderName: String? = null, val addressCountryCode: String? = null, val stateOrProvince: String? = null, val city: String? = null, val postalCode: String? = null, val directorName: String? = null, val website: String? = null, val email: String? = null, val phone: String? = null, val photoIncorporationDoc: ByteArray? = null, val photoProofAddress: ByteArray? = null, val financialAccountKYCFields: FinancialAccountKYCFields? = null, val cardKYCFields: CardKYCFields? = null)

KYC fields for organizations (businesses).

Contains business entity identification information for corporate customers. All field keys are automatically prefixed with "organization." when serialized.

This class supports 17 total fields:

15 text fields
2 binary fields (document images)

Field categories:

Business identity: name, registration details, VAT number
Registered address: country, state, city, postal code
Contact information: email, phone, website
Corporate structure: directors, shareholders
Documents: incorporation papers, proof of address
Financial accounts: bank accounts (via nested fields)

Example - Basic organization:

val org = OrganizationKYCFields(
    name = "Example Corp",
    VATNumber = "123456789",
    registrationNumber = "987654321",
    registrationDate = "2020-01-01",
    addressCountryCode = "USA",
    directorName = "Jane Smith",
    email = "contact@example.com"
)

// Extract fields for submission (automatically adds "organization." prefix)
val fields = org.fields()
// Result: {"organization.name": "Example Corp", "organization.VAT_number": "123456789", ...}

Example - With documents:

val org = OrganizationKYCFields(
    name = "Example Corp",
    photoIncorporationDoc = loadImageBytes("articles_of_incorporation.pdf"),
    photoProofAddress = loadImageBytes("utility_bill.jpg")
)

val files = org.files()
// Result: {"organization.photo_incorporation_doc": ByteArray(...), ...}

Example - With nested financial account:

val org = OrganizationKYCFields(
    name = "Example Corp",
    financialAccountKYCFields = FinancialAccountKYCFields(
        bankName = "Corporate Bank",
        bankAccountNumber = "9876543210"
    )
)

val fields = org.fields()
// Result: {
//   "organization.name": "Example Corp",
//   "organization.bank_name": "Corporate Bank",
//   "organization.bank_account_number": "9876543210"
// }

Constructors

OrganizationKYCFields

constructor(name: String? = null, VATNumber: String? = null, registrationNumber: String? = null, registrationDate: String? = null, registeredAddress: String? = null, numberOfShareholders: Int? = null, shareholderName: String? = null, addressCountryCode: String? = null, stateOrProvince: String? = null, city: String? = null, postalCode: String? = null, directorName: String? = null, website: String? = null, email: String? = null, phone: String? = null, photoIncorporationDoc: ByteArray? = null, photoProofAddress: ByteArray? = null, financialAccountKYCFields: FinancialAccountKYCFields? = null, cardKYCFields: CardKYCFields? = null)