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

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

Attribute Description
organizationSlug URL friendly name of organization
email User's email address
phoneNumber User's phone number
name User's name.
address User's address.
dateOfBirth User's date of birth.
nationalID User's SSN or TIN. (not required for Enablement Services)
visitorID [Description]

Output Attributes - User

Attribute Description
id Global identifier for the user.
email User's email address
phoneNumber User's phone number
name User's name.
address User's address.
status User's status
notificationPreferences Notifications are currently not sent for Enablement Services
legalAgreementVersions The Legal agreement versions the user has accepted. LegalAgreementVersions
createdAt The time the user was created in the database.
updatedAt The last time the user was updated.
syncedAt The last time this user's connections were synced.
closedAt The time this user profile was closed.
connections The financial institution connections the user has created. - *Requires the ConnectionsInput
tradelines The tradelines associated with the connected financial institution(s) this user has connected. **Requires the TradelinesInput