UserField

public enum UserField : String

Representation of the user field type.

  • The user’s street address.

    Declaration

    Swift

    case addressLine1

  • The user’s address, second line.

    Declaration

    Swift

    case addressLine2

  • The business contact’s street address.

    Declaration

    Swift

    case businessContactAddressLine1

  • The business contact’s address, second line.

    Declaration

    Swift

    case businessContactAddressLine2

  • The business contact’s city.

    Declaration

    Swift

    case businessContactCity

  • The business contact’s country.

    Declaration

    Swift

    case businessContactCountry

  • The business contact’s postal code.

    Declaration

    Swift

    case businessContactPostalCode

  • The user’s role in the organization.

    Declaration

    Swift

    case businessContactRole

  • The business contact’s state, province or region.

    Declaration

    Swift

    case businessContactStateProvince

  • The business name.

    Declaration

    Swift

    case businessName

  • The business’ operating name.

    Declaration

    Swift

    case businessOperatingName

  • The country where the business is registered.

    Declaration

    Swift

    case businessRegistrationCountry

  • The business registration number or identifier assigned by a government body.

    Declaration

    Swift

    case businessRegistrationId

  • The state, province or region where the business is registered.

    Declaration

    Swift

    case businessRegistrationStateProvince

  • The business type.

    Declaration

    Swift

    case businessType

  • The user’s city.

    Declaration

    Swift

    case city

  • A client-defined identifier for the user. This is the unique ID assigned to the user on your system.

    Declaration

    Swift

    case clientUserId

  • The user’s country.

    Declaration

    Swift

    case country

  • The user’s birth country.

    Declaration

    Swift

    case countryOfBirth

  • The user’s country of citizenship or nationality.

    Declaration

    Swift

    case countryOfNationality

  • The datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone used is UTC, therefore no time offset is returned.

    Declaration

    Swift

    case createdOn

  • The user’s date of birth (All users must be at least 13 years old).

    Declaration

    Swift

    case dateOfBirth

  • The user’s driver’s license number.

    Declaration

    Swift

    case driversLicenseId

  • The contact email address for the user account. This must be unique for your program, so you cannot have two users belonging to the same program with the same email address.

    Declaration

    Swift

    case email

  • The user’s employer identifier, generally used for tax purposes.

    Declaration

    Swift

    case employerId

  • The user’s first name.

    Declaration

    Swift

    case firstName

  • The user’s gender.

    Declaration

    Swift

    case gender

  • The user’s government ID number, such as a Social Security Number.

    Declaration

    Swift

    case governmentId

  • The user’s government ID type.

    Declaration

    Swift

    case governmentIdType

  • The preferred language for the user’s account. Defaults to English if not provided.

    Declaration

    Swift

    case language

  • The user’s last name.

    Declaration

    Swift

    case lastName

  • The user’s middle name.

    Declaration

    Swift

    case middleName

  • The user’s cell phone number.

    Declaration

    Swift

    case mobileNumber

  • The user’s passport number.

    Declaration

    Swift

    case passportId

  • The user’s phone number.

    Declaration

    Swift

    case phoneNumber

  • The user’s postal code.

    Declaration

    Swift

    case postalCode

  • The user’s postal code.

    Declaration

    Swift

    case profileType

  • The unique identifier for the program to which the user will belong.

    Declaration

    Swift

    case programToken

  • The user’s state, province or region.

    Declaration

    Swift

    case stateProvince

  • The user account status.

    Declaration

    Swift

    case status

  • The local time of a region or a country. e.g. GMT, PST, …

    Declaration

    Swift

    case timeZone

  • The unique, auto-generated user identifier. Max 64 characters, prefixed with “usr-”.

    Declaration

    Swift

    case token

  • The user’s verification status. A user may be required to verify their identity after a certain threshold of payments is reached.

    Declaration

    Swift

    case verificationStatus