UserInfoWithConsent

data class UserInfoWithConsent(var sub: String, var name: String, var givenName: String? = null, var familyName: String? = null, var birthDate: String? = null, var locale: String? = null, var gender: String? = null, var updatedAt: Int? = null, var status: String? = null, var middleName: String? = null, var email: String? = null, var emailVerified: Boolean? = null, var phonenumber: String? = null, var phoneNumberVerified: Boolean? = null, var address: String? = null, var creditScore: String? = null, var active: String? = null, var countryOfBirth: String? = null, var regionOfBirth: String? = null, var cityOfBirth: String? = null, var occupation: String? = null, var employerName: String? = null, var identificationType: String? = null, var identificationValue: String? = null)

Represents extended user information returned by the MTN MOMO GET /oauth2/{version}/userinfo endpoint after the user grants consent.

The API response is a flat JSON object — all fields are at the top level. Fields not guaranteed by the API are nullable with a null default so that a missing field does not cause a deserialization failure.

Constructors

Link copied to clipboard
constructor(sub: String, name: String, givenName: String? = null, familyName: String? = null, birthDate: String? = null, locale: String? = null, gender: String? = null, updatedAt: Int? = null, status: String? = null, middleName: String? = null, email: String? = null, emailVerified: Boolean? = null, phonenumber: String? = null, phoneNumberVerified: Boolean? = null, address: String? = null, creditScore: String? = null, active: String? = null, countryOfBirth: String? = null, regionOfBirth: String? = null, cityOfBirth: String? = null, occupation: String? = null, employerName: String? = null, identificationType: String? = null, identificationValue: String? = null)

Properties

Link copied to clipboard

Indicates whether the user's account is active.

Link copied to clipboard

The user's physical address.

Link copied to clipboard

The user's date of birth.

Link copied to clipboard

The city where the user was born.

Link copied to clipboard

The country where the user was born.

Link copied to clipboard

The user's credit score as reported by the MTN MOMO system.

Link copied to clipboard

The user's email address.

Link copied to clipboard

Whether the user's email address has been verified.

Link copied to clipboard

The name of the user's employer.

Link copied to clipboard

The user's family (last) name.

Link copied to clipboard

The user's gender.

Link copied to clipboard

The user's given (first) name.

Link copied to clipboard

The type of identification document provided.

Link copied to clipboard

The value/number of the identification document.

Link copied to clipboard

The user's locale string.

Link copied to clipboard

The user's middle name.

Link copied to clipboard

The full name of the user.

Link copied to clipboard

The user's occupation.

Link copied to clipboard

The user's phone number.

Link copied to clipboard

Whether the user's phone number has been verified.

Link copied to clipboard

The region where the user was born.

Link copied to clipboard

The current status of the user account.

Link copied to clipboard
var sub: String

The subject identifier for the user.

Link copied to clipboard

The last profile update as a Unix epoch integer (seconds).