Skip to main content
This page groups all fields related to personal data, corporate data, contact details, addresses, and identity management.

1. Personal and business information


FieldDescriptionUsed in
nameFull name or legal entity nameMidaz, CRM, PIX, Flowker, Identity
documentTax ID (CPF/CNPJ)CRM, PIX
typePerson type or resource typeCRM, PIX, Flowker
favoriteNamePreferred or nicknameCRM
socialNameSocial nameCRM
tradeNameTrade nameCRM, PIX
motherNameMother’s nameCRM, PIX
fatherNameFather’s nameCRM
genderGenderCRM, Identity
civilStatusCivil statusCRM
nationalityNationalityCRM
activityBusiness activityCRM
sizeCompany sizeCRM
statusStatus (active, inactive, etc)Midaz, CRM, PIX, Fee, Flowker, Identity

2. Contact information


FieldDescriptionUsed in
emailPrimary emailAuth, CRM, Identity
primaryEmailPrimary emailCRM, Identity
secondaryEmailSecondary emailCRM, Identity
emailVerifiedEmail verification flagAuth, Identity
mobilePhoneMobile phoneCRM, Identity
otherPhoneAdditional phoneCRM
phoneMain phoneMidaz, Identity

3. Addresses


FieldDescriptionUsed in
addressFull address or nested objectMidaz, Identity
line1Address line 1CRM
line2Address line 2CRM
zipCodeZIP codeCRM
cityCityCRM
stateStateCRM
countryISO 3166-1 alpha-2 country codeCRM
countryCodeCountry bank codeCRM
descriptionAddress descriptionCRM

4. Organizational structures (Midaz)


FieldDescriptionUsed in
legalNameLegal company nameMidaz
doingBusinessAsTrade nameMidaz
legalDocumentOfficial legal documentMidaz
addressOrganization addressMidaz
phoneMain phoneMidaz
websiteWebsiteMidaz
parentOrganizationIdParent organization identifierMidaz
metadataFlexible key-value metadataMidaz
scaleScale factor for calculationsMidaz
precisionDecimal precisionMidaz
symbolCurrency or asset symbolMidaz
balanceAccount balanceMidaz
availableAvailable balanceMidaz
onHoldHeld balanceMidaz

5. User profile


FieldDescriptionUsed in
profileUser profile URLAuth, Identity
preferredUsernamePreferred usernameAuth, Identity
pictureProfile picture URLAuth, Identity
avatarAvatar image URLIdentity
bioUser biographyIdentity
localePreferred localeIdentity
timezoneUser timezoneIdentity
representativeLegal representativeCRM
roleUser roleCRM, Identity

6. Identity — users and groups


FieldDescriptionUsed in
userIdUnique user identifierIdentity
user_idUser ID (admin context)Identity
usernameUnique usernameIdentity
emailPrimary emailIdentity
emailVerifiedEmail verified flagIdentity
phoneUser phoneIdentity
phoneVerifiedPhone verified flagIdentity
passwordHashed passwordIdentity
passwordHashbcrypt hashIdentity
passwordChangedAtLast password changeIdentity
passwordResetTokenReset tokenIdentity
passwordResetExpiresReset expirationIdentity
firstNameFirst nameIdentity
lastNameLast nameIdentity
fullNameFull nameIdentity
displayNameDisplay nameIdentity
avatarAvatarIdentity
bioUser biographyIdentity
localeUser localeIdentity
timezoneTimezoneIdentity
isActiveUser active flagIdentity
isEmailVerifiedEmail verified flagIdentity
isMfaEnabledMFA enabledIdentity
mfaSecretMFA secretIdentity
lastLoginAtLast loginIdentity
lastActivityAtLast activityIdentity
loginCountLogin counterIdentity
failedLoginAttemptsFailed login attemptsIdentity
lockedUntilLock expirationIdentity
groupIdGroup IDIdentity
groupNameGroup nameIdentity
groupDescriptionGroup descriptionIdentity
permissionsArray of permissionsIdentity
rolesArray of rolesIdentity
metadataCustom metadataIdentity
createdByCreated by userIdentity
updatedByUpdated by userIdentity
deletedByDeleted by userIdentity
createdAtCreation timestampIdentity
updatedAtUpdate timestampIdentity
deletedAtDeletion timestampIdentity