Account

Owned by Admoll Adefemi
Dec 03, 2024
1 min read

Welcome to the "Account" section of Originate's GraphQL API Documentation. In the "Account" section of Originate's GraphQL API, you'll find a collection of queries and mutations designed to manage user accounts, authentication and authorization within Originate.

Let's explore the queries and mutations of the account category:

Account Section Queries:

Below is a list of all queries related to user accounts and authentication within Originate.

Customer-Related Queries

  • customer(input: CustomerByParamsInput!): Account!

  • customerById(id: ID!): Account!

  • customerBvnStatus(input: CustomerBvnStatusInput!): CustomerBvnStatus!

  • customerRemitaStatus(input: CustomerRemitaStatusInput): CustomerRemitaStatus

  • customerSummary: CustomerSummary!

  • views: Views!

  • customerAmountEligibility(input: CustomerAmountEligibilityInput): [AmountEligibilityPayload!]

Client Related Queries

  • clientInfo(input: ClientInfoInput!): ClientInfo

  • clientAccountUsers(input: ClientAccountUsersInput!): ClientAccountUsersPayload

  • clientAccountUsersXn( after: ConnectionCursor before: ConnectionCursor first: ConnectionLimitInt = 15 last: ConnectionLimitInt = 15 orderBy: ClientAccountUsersOrderByInput where: ClientAccountUsersWhereInput! ): ClientAccountUsersConnection

  • availableRoles(where: RoleWhereInput): [Role!]

  • availablePermissions(where: PermissionWhereInput): [Permission!]

  • applicableTenors(input: ApplicableTenorsInput!): [ApplicableTenorsResponse]

  • getAllAttributes: GetAllAttributesResponse!

Account Section Mutations

Below is a list of all queries related to user accounts and authentication within Originate.

Neutral Mutations

  • login(input: AccountLoginInput!): AuthPayload

  • logout: String!

  • changePassword(input: ChangePasswordInput!): AuthPayload

  • triggerPasswordReset(input: TriggerPasswordResetInput!): AccountUserActionPayload

  • resetPassword(input: ResetPasswordInput!): AccountUserActionPayload

Customer-Related Mutations

  • createCustomer(input: CustomerCreateInput!): AuthPayload

Client-Related Mutations

  • createClientAccount(input: ClientAccountCreateInput!): Account

  • sendClientUserInvitation(input: SendClientUserInvitationInput!): AccountUserActionPayload

  • completeInvitation(input: CompleteInvitationInput!): AuthPayload

  • updateClientAccountUserDetails(input: UpdateClientAccountUserDetailsInput!): AuthPayload

  • deleteClientUser(userId: ID!): AccountUserActionPayload

  • customRoleCreate(input: CreateCustomRoleInput!): Role

  • customRoleDelete(input: DeleteCustomRoleInput!): Role

  • customRoleUpdate(input: UpdateCustomRoleInput!): Role

  • changeClientUserRole(input: ChangeClientUserRoleInput!): AccountUserActionPayload

  • createContextState(input: CreateContextStateInput!): ContextState

  • updateContextState(input: UpdateContextStateInput!): ContextState

By utilizing the queries and mutations in the "Account" section, you can seamlessly manage user accounts, retrieve user information, and handle account-related tasks. Each operation is documented with input parameters, return types, and usage examples to ensure a smooth experience.

As you explore the "Account" section, you'll gain insight into how Originate's GraphQL API empowers you to efficiently handle user account management and authentication processes.