RegisterOrganizationUser

🔒

Authorization

Requires Organization scoped authorization. See the Enablement Services Authorization guide.

The registerOrganizationUser mutation is used to create a new user in the database. Upon successful creation, the mutation will return the user's unique ID. You should store this ID in your database and associate it with your consumer record, as it will be required for accessing authenticated queries and mutations.

Below is an example of the registerOrganizationUser mutation, detailing all available input fields and the fields included in the output. The connections and tradelines fields in the output require additional inputs, as shown in the example.

mutation RegisterOrganizationUser  {
  registerOrganizationUser(
    input: {
      organizationSlug: String!
      email: String!
      phoneNumber: string!
      name: NameInput!
      address: AddressInput!
      dateOfBirth: DateInput!
      nationalId: String
      visitorID: String
    }
  ){
    user {
            id
            email
            phoneNumber
            status
            createdAt
            updatedAt
            syncedAt
            closedAt
      
      			connection(input: ConnectionsInput!): ConnectionsConnection!
      			tradelines(input: TradelinesInput!): TradelinesConnection!
        }
  }
}

Input Attributes

AttributeDescription
organizationSlugURL friendly name of organization
emailUser's email address
phoneNumberUser's phone number
nameUser's name.
addressUser's address.
dateOfBirthUser's date of birth.
nationalIDUser's SSN or TIN. (not required for Enablement Services)
visitorID[Description]

Output Attributes - User

AttributeDescription
idGlobal identifier for the user.
emailUser's email address
phoneNumberUser's phone number
nameUser's name.
addressUser's address.
statusUser's status
notificationPreferencesNotifications are currently not sent for Enablement Services
legalAgreementVersionsThe Legal agreement versions the user has accepted. LegalAgreementVersions
createdAtThe time the user was created in the database.
updatedAtThe last time the user was updated.
syncedAtThe last time this user's connections were synced.
closedAtThe time this user profile was closed.
connectionsThe financial institution connections the user has created.
**Requires the ConnectionsInput
tradelinesThe tradelines associated with the connected financial institution(s) this user has connected. **Requires the TradelinesInput