Sign in
UserInvites

Gets a user invite detailss by ID.

<b>Authorization</b>: End user token is required.

<b>User permissions required</b>: CanEditRoles

get/api/v1/userinvites/{id}/details

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/userinvites/{id}/details
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

The ID of the user invite to retrieve.

Response

OK

idstring uuid
inviteeEmailAddressstring nullable
inviterFirstNamestring nullable
inviterLastNamestring nullable
inviteeFirstNamestring nullable
inviteeLastNamestring nullable
inviterEmailAddressstring nullable
merchantIDstring uuid
registrationUrlstring nullable
lastInvitedstring date-time
merchantNamestring nullable
messagestring nullable
userIDstring uuid nullable
isInviteeRegisteredboolean

If true, indicates the invitee's email address corresponds to an existing MoneyMoov user.

initialRoleIDstring uuid nullable

The role ID to automatically assign to the merchant’s very first user. Typically set by the compliance team when the first user is invited to a new merchant.

isAuthorisedboolean

Will be set to true once the invite has met the authorisation requirements.

status'Active' | 'Expired' | 'Accepted' | 'AuthorisationRequired'

Changes

No recorded changes to this endpoint across all 2 revisions of this API.