Name Records

openapi: 3.0.0 info: version: "1.0.0" title: Name Records description: | A Name record describes a user who has an access to an account in Symitar, and it includes details such as name record type or member number. An account may have multiple name records, with possible name record types being 'primary' (main, immutable association between a user and an account) and joint (additional users with an account access appart from the primary one). tags: - name: Name Record Operations servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname paths: "/users/{userId}/name-records": parameters: - $ref: '#/components/parameters/UserId' get: tags: - Name Record Operations description: Get the list of name records for a user. Name records only exist on the Symitar core for credit unions. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.profile.readonly' responses: "200": description: The user's name records, or empty list if no name records are found for a user content: application/json: schema: $ref: "#/components/schemas/ConsumerNameRecords" "400": description: No JWT found, or else another kind of bad data denoted by the error message content: application/json: schema: nullable: true type: string "404": description: A user is not found, or a user exists but it is not a Symitar credit union user components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration parameters: UserId: in: path name: userId description: ID of the desired user required: true schema: type: string format: uuid schemas: NameRecordReport: type: object required: - nameRecordType - locator - locatorType - memberNumber properties: nameRecordType: type: string description: Name record type, which describes the relationship between the user and an account enum: - primary - joint locator: type: number description: Name record identifier. This is a positive number greater than zero and up to two billion locatorType: type: string description: Type of an access to an account. This differentiates between a membership (regular account), share account (savings, checking, IRA, club, or certificate shares), loan, and third-party loan tracked in the member's Symitar account (external loan) enum: - membership - share - loan - externalloan memberNumber: type: string description: A unique identified of user's Member record. This is a ten digit number, padded with zeroes on the left (e.g., 0000382783) ConsumerNameRecords: type: object required: - nameRecords properties: nameRecords: type: array items: $ref: "#/components/schemas/NameRecordReport"