momo-api-sdk/io.rekast.sdk.model/BasicUserInfo

BasicUserInfo

data class BasicUserInfo(var sub: String? = null, var name: String? = null, var givenName: String? = null, var familyName: String? = null, var birthDate: String? = null, var locale: String? = null, var gender: String? = null, var status: String? = null, var updatedAt: Int? = null, var displayUpdatedAt: String = "")

Data class representing basic user information (KYC payload) returned by the MTN MOMO API.

This is a superset covering both response shapes the SDK encounters:

The Collection/Disbursement basicuserinfo response, which is OIDC-style and includes sub, name, gender, and updatedAt.
The Remittance .../accountholder/msisdn/{accountHolderMSISDN}/basicuserinfo response, which is the KYC payload of givenName, familyName, birthDate, locale, and status and omits sub/name.

Every server-supplied field is therefore nullable, so a payload that omits any of them deserializes without failure.

Constructors

BasicUserInfo

constructor(sub: String? = null, name: String? = null, givenName: String? = null, familyName: String? = null, birthDate: String? = null, locale: String? = null, gender: String? = null, status: String? = null, updatedAt: Int? = null, displayUpdatedAt: String = "")

Properties

birthDate

var birthDate: String?

The account holder's birth date.

displayUpdatedAt

var displayUpdatedAt: String

A human-readable formatted version of updatedAt; computed locally, not present in the API response.

familyName

var familyName: String?

Surname(s) or last name(s) of the End-User. Some cultures allow multiple family names or none; all present names are separated by space characters.

gender

var gender: String?

The gender of the user.

givenName

var givenName: String?

Given name(s) or first name(s) of the End-User. Some cultures allow multiple given names; all can be present, separated by space characters.

locale

var locale: String?

The End-User's locale as a BCP47 RFC5646 language tag — typically an ISO 639-1 Alpha-2 language code in lowercase and an ISO 3166-1 Alpha-2 country code in uppercase, separated by a dash (e.g. en-US or fr-CA). Some implementations use an underscore instead (e.g. en_US).

name

var name: String?

The full name of the user. Absent in the Remittance KYC response.

status

var status: String?

The account holder status.

sub

var sub: String?

The subject identifier for the user. Absent in the Remittance KYC response.

updatedAt

var updatedAt: Int?

The last updated timestamp as a Unix epoch integer (seconds).