Consumer

public enum Consumer : Codable

The consumer details need to be one of the structures.

  • Structure for the consumer information.

    Declaration

    Swift

    case consumer(firstName: String? = nil,
                  middleName: String? = nil,
                  lastName: String? = nil,
                  dateOfBirth: String? = nil,
                  ssn: String? = nil,
                  phoneNumber: String? = nil,
                  emailAddress: String? = nil)

    Parameters

    firstName

    The consumer’s first name.

    middleName

    The consumer’s middle name.

    lastName

    The consumer’s last name.

    dateOfBirth

    The consumer’s date of birth.

    ssn

    The consumer’s Social Security Number. This property will accept both the last 4 digits or the full 9 digits of the SSN.

    phoneNumber

    The consumer’s phone number in E.164 international standard.

    emailAddress

    The consumer’s email address.

  • Structure for the business information.

    Declaration

    Swift

    case business(businessType: String,
                  name: String,
                  stateOfIncorporation: String,
                  ein: String,
                  dba: String? = nil,
                  stakeholderUuids: [String]? = nil)

    Parameters

    businessType

    The type of company. Can be mapped from and to BusinessType.

    name

    The name of the company.

    stateOfIncorporation

    The state of incorporation.

    ein

    The EIN of the company.

    dba

    Doing business as.

    stakeholderUuids

    All the stakeholders of the company.

  • Structure for the stakeholder information.

    Declaration

    Swift

    case stakeholder(stakeholderType: String,
                     firstName: String,
                     lastName: String,
                     emailAddress: String,
                     officerTitle: String? = nil,
                     percentOwnership: String? = nil,
                     middleName: String? = nil,
                     dateOfBirth: String? = nil,
                     ssn: String? = nil,
                     phoneNumber: String? = nil)

    Parameters

    stakeholderType

    The type of stakeholder. Can be mapped from StakeholderType.

    firstName

    The stakeholder’s first name.

    lastName

    The stakeholder’s last name.

    emailAddress

    The consumer’s date of birth.

    officerTitle

    The job title. Only available if the stakeholderType is .officer.

    percentOwnership

    The percentage ownership in the company. Only available if the stakeholderType is .beneficialOwner.

    middleName

    The stakeholder’s middle name.

    dateOfBirth

    The stakeholder’s date of birth.

    ssn

    The stakeholder’s Social Security Number. This property will accept both the last 4 digits or the full 9 digits of the SSN. Optional if the stakeholderType is .administrator.

    phoneNumber

    The stakeholder’s phone number.

  • Uknown case.

    Declaration

    Swift

    case unknown
  • Creates a new instance by decoding from the given decoder.

    Declaration

    Swift

    public init(from decoder: Decoder) throws

    Parameters

    decoder

    The decoder to read data from.

  • Encodes the instance by encoding to the given decoder.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    The encoder to write data to.