User Details
Admin API
>
API Reference
>
v0
>
Consumers
>
User Details
openapi: 3.0.0
info:
version: '0.0'
title: User Details
tags:
- name: Retrieve user details
servers:
- url: 'https://banno.com'
paths:
'/a/mobile/api/v0/institutions/{institutionId}/users/{userId}/details':
get:
tags:
- Retrieve user details
description: |
Retrieve user details.
Requires the "View" permission for People
parameters:
- in: path
name: institutionId
description: ID of the Institution
required: true
schema:
type: string
format: uuid
- in: path
name: userId
description: ID of the user
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/userDetails'
'500':
description: Server error
components:
securitySchemes:
clientCredentials:
type: oauth2
description: OAuth2 using the client credentials flow
flows:
clientCredentials:
tokenUrl: https://banno.com/a/oidc-provider/api/v0/token
scopes: {}
schemas:
userDetails:
type: object
description: Basic object containing user details.
required:
- userId
- firstName
- middleInitial
- lastName
- primaryInstitutionId
- primaryInstitutionUsername
- userType
- businessName
- abilities
- userAdded
- userImage
properties:
userId:
type: string
format: uuid
description: Id of the user.
firstName:
type: string
middleInitial:
type: string
lastName:
type: string
email:
type: string
format: email
primaryInstitutionId:
type: string
format: uuid
primaryInstitutionUsername:
type: string
userType:
type: string
enum:
- Individual
- Business
businessName:
type: string
address:
type: object
required:
- addressLineOne
- addressLineTwo
- city
- state
- zip
- zipPlusFour
properties:
addressLineOne:
type: string
addressLineTwo:
type: string
addressLineThree:
type: string
addressLineFour:
type: string
city:
type: string
state:
type: string
description: Two-letter state abbreviation
zip:
type: string
zipPlusFour:
type: string
abilities:
type: object
description: Indicates whether feature is enabled for user. This is not an indication of enrollment (if applicable).
properties:
rdc:
type: boolean
billPay:
type: boolean
accountToAccount:
type: boolean
schedulableTransfers:
type: boolean
separateBillPayAccounts:
type: boolean
externalAccounts:
type: boolean
payeeCreation:
type: boolean
p2pEnabled:
type: boolean
rdcOnboarddingEnabled:
type: boolean
paymentCardManagement:
type: boolean
rdcOnboardingByAccountsEnabled:
type: boolean
externalTransferInbound:
type: boolean
externalTransferOutbound:
type: boolean
memberToMemberTransfers:
type: boolean
billPayEnrollment:
type: boolean
zelle:
type: boolean
zelleReadyContact:
type: boolean
lastSeen:
type: string
format: date-time
userAdded:
type: string
format: date-time
phone:
type: string
userImage:
type: string
description: deprecated
deprecated: true
demographic:
type: object
required:
- lastUpdated
properties:
customerCode:
type: string
description: (Banks only)
customerImportance:
type: string
description: (Banks only) Indicates whether the customer has been flagged as a VIP.
enum:
- Yes
- No
customerDescription:
type: string
description: (Banks only) Description of customer.
gender:
type: string
enum:
- Male
- Female
- Other
birthday:
type: string
format: date
example: '2000-01-01'
homeBranchId:
type: string
description: (Banks only) Home Branch of customer.
educationLevel:
type: string
enum:
- AssocDegree
- BachelorDegree
- Doctorate
- Elementary
- HighSchool
- MastersDegree
employerName:
type: string
employeeTitle:
type: string
netWorth:
type: string
description: decimal string
employeeData:
type: string
enum:
- E
- NE
lastUpdated:
type: string
format: date-time
maskedSsn:
type: string
description: Masked Tax Identification Number.
lockedOutOfRSA:
type: boolean
netTellerId:
type: string
customerId:
type: string
description: CIF for customer, this can be Tax Identification Number for Core Director FI's.
memberNumber:
type: string
description: (CUs only) Number with 10 or less digits, can have leading zeros.
example: '0000070000'
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.
Last updated Mon Jan 1 0001