Kard

Kard users API

The users API from Kard — 5 operation(s) for users.

GitHub OpenAPI

Operations 8

POST /v2/issuers/{organizationId}/users Create Users #
PUT /v2/issuers/{organizationId}/users/{userId} Update User #
DELETE /v2/issuers/{organizationId}/users/{userId} Delete User #
GET /v2/issuers/{organizationId}/users/{userId} Get User By ID #
POST /users/users Create User #
POST /users/users/{id}/cards Create User Card #
PUT /users/users/{id} Update User #
DELETE /users/users/{id} Delete User #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/authentication/kard-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/openapi/kard-users-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/asyncapi/kard-notifications-webhooks.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/scopes/kard-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/errors/kard-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/conventions/kard-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/data-model/kard-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/conformance/kard-conformance.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/asyncapi/kard-notifications-webhooks.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/agentic-access/kard-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kard-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kard-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Kard Users API
  version: 1.0.0
  description: 'Operations tagged users across 2 of this provider''s published API definitions: kard-api-reference-openapi.yaml, kard-legacy-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rewards-api.getkard.com
  description: Production
- url: https://test-rewards-api.getkard.com
  description: Sandbox
tags:
- name: users
paths:
  /v2/issuers/{organizationId}/users:
    post:
      operationId: create
      summary: Create Users
      description: 'Call this endpoint to enroll a specified user into your rewards program.<br/>


        <b>Required scopes:</b>&nbsp;&nbsp;`user:write`<br/>

        <b>Note:</b> `Maximum of 100 users can be created per request`.'
      tags:
      - users
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Response with status 201
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_CreateUsersObject'
        '207':
          description: Error response with status 207
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_CreateUsersMultiStatusResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '409':
          description: Error response with status 409
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_users_CreateUsersObject'
    servers:
    - url: https://rewards-api.getkard.com
      description: Production
    - url: https://test-rewards-api.getkard.com
      description: Sandbox
  /v2/issuers/{organizationId}/users/{userId}:
    put:
      operationId: update
      summary: Update User
      description: 'Call this endpoint to update the details on a specified user.<br/>


        <b>Required scopes:</b> `user:update`'
      tags:
      - users
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: userId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_UserResponseObject'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_users_UpdateUserObject'
    delete:
      operationId: delete
      summary: Delete User
      description: 'Call this endpoint to delete a specified enrolled user from the rewards program and Kard''s system. Users can be re-enrolled into rewards by calling the [Create User](/2024-10-01/api/users/create) endpoint using the same `id` from before.<br/>


        <b>Required scopes:</b> `user:delete`'
      tags:
      - users
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: userId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_DeleteUserResponseObject'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
    get:
      operationId: get
      summary: Get User By ID
      description: 'Call this endpoint to fetch the details on a specified user.<br/>

        <br/>

        <b>Required scopes:</b>&nbsp;&nbsp;`user:read`'
      tags:
      - users
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: userId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_UserResponseObject'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
    servers:
    - url: https://rewards-api.getkard.com
      description: Production
    - url: https://test-rewards-api.getkard.com
      description: Sandbox
  /users/users:
    post:
      operationId: create-user
      summary: Create User
      description: 'Call this endpoint to enroll a specified user into your rewards program. Learn more about the [Enrolling Users](https://github.com/kard-financial/kard-postman#a-cardholders) flow based on your use case here.<br/>

        <b>Required scopes:</b> `user:write`'
      tags:
      - users
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Response with status 201
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_InvalidRequestUnion'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_UnauthorizedErrorBody'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: string
        '409':
          description: Error response with status 409
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_users_CreateUserRequestBody'
    servers:
    - url: https://rewards-api.getkard.com
      description: Production
    - url: https://test-rewards-api.getkard.com
      description: Sandbox
  /users/users/{id}/cards:
    post:
      operationId: create-user-card
      summary: Create User Card
      description: 'Call this endpoint to create a card that a specified user enrolled in rewards will use to make purchases and earn rewards.<br/>

        <b>Required scopes:</b> `user:write`'
      tags:
      - users
      parameters:
      - name: id
        in: path
        description: Referring partner user ID from issuer that specifies user
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Response with status 201
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_CreateUserCardResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_InvalidRequestUnion'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_UnauthorizedErrorBody'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: string
        '409':
          description: Error response with status 409
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_users_CreateUserCardRequestBody'
    servers:
    - url: https://rewards-api.getkard.com
      description: Production
    - url: https://test-rewards-api.getkard.com
      description: Sandbox
  /users/users/{id}:
    put:
      operationId: update-user
      summary: Update User
      description: 'Call this endpoint to update the details on a specified user. If you would like to add a card to a specified user, please refer to the [Create User Card endpoint](/legacy/api/users/create-user-card).<br/>

        <b>Required scopes:</b> `user:update`'
      tags:
      - users
      parameters:
      - name: id
        in: path
        description: Referring partner user ID from issuer that specifies user
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users_UpdateUserResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_InvalidRequestUnion'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_UnauthorizedErrorBody'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_users_UserRequestBody'
    delete:
      operationId: delete-user-by-id
      summary: Delete User
      description: 'Call this endpoint to delete a specified enrolled user from the rewards program and Kard''s system. Users can be re-enrolled into rewards by calling the [Create User](/legacy/api/users/create-user) endpoint using the same `referringPartnerUserId` from before. Deleting a user will remove all the user fields for that specific user from Kard’s system.<br/>

        <b>Required scopes:</b> `user:delete`'
      tags:
      - users
      parameters:
      - name: id
        in: path
        description: Referring partner user ID from issuer that specifies user
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_InvalidRequestUnion'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_UnauthorizedErrorBody'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                type: string
    servers:
    - url: https://rewards-api.getkard.com
      description: Production
    - url: https://test-rewards-api.getkard.com
      description: Sandbox
components:
  schemas:
    type_users_UserResponseUnionNoData:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - user
            description: 'Discriminator value: user'
          id:
            $ref: '#/components/schemas/type_commons_UserId'
          attributes:
            $ref: '#/components/schemas/type_commons_EmptyObject'
        required:
        - type
        - id
        - attributes
      discriminator:
        propertyName: type
      title: UserResponseUnionNoData
    type_commons_EmptyObject:
      type: object
      properties: {}
      title: EmptyObject
    type_users_UpdateUserObject:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_users_UpdateUserRequestDataUnion'
      required:
      - data
      title: UpdateUserObject
    type_commons_ErrorObject:
      type: object
      properties:
        status:
          type: string
          description: Status code returned from the request
        title:
          type: string
          description: Name of error
        detail:
          type: string
          description: Description of the specific occurance of the error
        source:
          $ref: '#/components/schemas/type_commons_ErrorSource'
          description: An object containing a reference to the primary source of the error
        id:
          type: string
          description: The id of the resource which caused the error. Always returned for multi-status errors.
      required:
      - status
      - title
      - detail
      title: ErrorObject
    type_users_UpdateUserRequestAttributes:
      type: object
      properties:
        enrolledRewards:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_EnrolledRewardsType'
          description: Rewards programs to enroll the user in. If an empty array is supplied, the user will not be enrolled in any programs.
        zipCode:
          type: string
          description: Zipcode of user
        email:
          type: string
          description: Email address of user
        hashedEmail:
          type: string
          description: Hashed email address of user (using SHA-256)
        phoneNumber:
          type: string
          description: Phone number of user in E.164 format
        birthYear:
          type: string
          description: Birth year of user
        historicalTransactionsSent:
          type: boolean
          description: 'Set to `true` to confirm that historical transactions have been sent for this user. This is a one-way flag: once `true` it cannot be set back to `false`, and a request attempting to do so is rejected.'
      required:
      - enrolledRewards
      title: UpdateUserRequestAttributes
    type_users_CreateUsersMultiStatusResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_ErrorObject'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_users_UserRequestDataUnion'
      required:
      - errors
      title: CreateUsersMultiStatusResponse
    type_users_DeleteUserResponseObject:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_users_UserResponseUnionNoData'
      required:
      - data
      title: DeleteUserResponseObject
    type_users_CreateUsersObject:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_users_UserRequestDataUnion'
      required:
      - data
      title: CreateUsersObject
    type_users_UserResponseObject:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_users_UserRequestDataUnion'
      required:
      - data
      title: UserResponseObject
    type_commons_ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_ErrorObject'
      required:
      - errors
      title: ErrorResponse
    type_users_UpdateUserRequestDataUnion:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - user
            description: 'Discriminator value: user'
          id:
            $ref: '#/components/schemas/type_commons_UserId'
          attributes:
            $ref: '#/components/schemas/type_users_UpdateUserRequestAttributes'
        required:
        - type
        - id
        - attributes
      discriminator:
        propertyName: type
      title: UpdateUserRequestDataUnion
    type_commons_UserId:
      type: string
      description: The ID of the user as defined on the issuers system
      title: UserId
    type_users_UserRequestDataUnion:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - user
            description: 'Discriminator value: user'
          id:
            $ref: '#/components/schemas/type_commons_UserId'
          attributes:
            $ref: '#/components/schemas/type_users_UserRequestAttributes'
        required:
        - type
        - id
        - attributes
      discriminator:
        propertyName: type
      title: UserRequestDataUnion
    type_commons_EnrolledRewardsType:
      type: string
      enum:
      - CARDLINKED
      description: Enrolled Rewards
      title: EnrolledRewardsType
    type_commons_OrganizationId:
      type: string
      description: Your issuer organization ID, provided by Kard
      title: OrganizationId
    type_users_UserRequestAttributes:
      type: object
      properties:
        enrolledRewards:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_EnrolledRewardsType'
          description: Rewards programs to enroll the user in. If an empty array is supplied, the user will not be enrolled in any programs.
        zipCode:
          type: string
          description: Zipcode of user
        email:
          type: string
          description: Email address of user
        hashedEmail:
          type: string
          description: Hashed email address of user (using SHA-256)
        phoneNumber:
          type: string
          description: Phone number of user in E.164 format
        birthYear:
          type: string
          description: Birth year of user
        historicalTransactionsSent:
          type: boolean
          description: Indicates whether historical transactions have been sent for this user
      required:
      - enrolledRewards
      title: UserRequestAttributes
    type_commons_ErrorSource:
      type: object
      properties:
        pointer:
          type: string
          description: A JSON pointer to the value in the request document that caused the error
        parameter:
          type: string
          description: A string indicating which URI query parameter caused the error
        header:
          type: string
          description: A string indicating the name of a single request header which caused the error
      title: ErrorSource
    type_commons_MongoId:
      type: string
      description: The unique identifier for a document in the database
      title: MongoId
    type_users_CreateUserRequestBody:
      type: object
      properties:
        email:
          type: string
          description: Email of user; <b>AT LEAST one of email or userName is REQUIRED. We HIGHLY RECOMMEND sending both.</b>
        hashedEmail:
          type: string
          description: Hashed email address of user (using SHA-256)
        phoneNumber:
          type: string
          description: Phone number of user in E.164 format
        birthYear:
          type: string
          description: Birth year of user
        userName:
          type: string
          description: Username of user from issuer; <b>AT LEAST one of email or userName is REQUIRED. We HIGHLY RECOMMEND sending both.</b>
        firstName:
          type: string
          description: First name of user. <b>We HIGHLY RECOMMEND sending this field.</b>
        lastName:
          type: string
          description: Last name of user. <b>We HIGHLY RECOMMEND sending this field.</b>
        zipCode:
          type: string
          description: Zipcode of user. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
        referringPartnerUserId:
          type: string
          description: Referring partner user ID of user from issuer. Must be a unique identifier across users
        externalPartnerUserId:
          type: string
          description: Partner unique user id, might be equal to referringPartnerUserId
        enrolledRewards:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_EnrolledRewardsType_2'
          description: If field is not supplied, user will be automatically enrolled in all programs. Note, <b>please do not send AFFILIATE</b> as this field has been deprecated.
        cards:
          type: array
          items:
            $ref: '#/components/schemas/type_users_CardInfoRequest'
          description: List of User Cards Information. <b>This is REQUIRED for matching purposes.</b>
        cardInfo:
          $ref: '#/components/schemas/type_users_CardInfoRequest'
          description: <b>[Deprecated — please use 'cards' field]</b> User Card Information
        referringPartner:
          type: string
          description: Issuer name
      required:
      - referringPartnerUserId
      title: CreateUserRequestBody
    type_users_CardInfoResponse:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/type_commons_MongoId'
          description: Card ID in Kard's system
        last4:
          type: string
          description: Card last four digits. <b>Note, this field is REQUIRED for matching purposes.</b>
        bin:
          type: string
          description: Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6.<b>Note, this field is REQUIRED for matching purposes.</b>
        issuer:
          type: string
          description: Issuer name
        network:
          $ref: '#/components/schemas/type_commons_Network'
          description: Name of card network
        status:
          $ref: '#/components/schemas/type_users_CardStatus'
          description: Status of the card
        token:
          type: string
          description: Card token
        tokenSource:
          type: string
          description: Card token source
      required:
      - _id
      - last4
      - bin
      - issuer
      - network
      - status
      description: Credit Card Information
      title: CardInfoResponse
    type_users_CardInfoRequest:
      type: object
      properties:
        last4:
          type: string
          description: Card last four digits. <b>Note, this field is REQUIRED for matching purposes.</b>
        bin:
          type: string
          description: Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6.<b>Note, this field is REQUIRED for matching purposes.</b>
        issuer:
          type: string
          description: Issuer
        network:
          $ref: '#/components/schemas/type_commons_Network'
          description: Name of card network
        status:
          $ref: '#/components/schemas/type_users_CardStatus'
          description: Status of card
        token:
          type: string
          description: Card token
        tokenSource:
          type: string
          description: Card token source
      required:
      - last4
      - bin
      - issuer
      - network
      title: CardInfoRequest
    type_commons_UnauthorizedErrorBody:
      type: object
      properties:
        message:
          type: string
      required:
      - message
      title: UnauthorizedErrorBody
    type_users_CardStatus:
      type: string
      enum:
      - ENABLED
      - DISABLED
      title: CardStatus
    type_users_CreateUserCardResponse:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/type_commons_MongoId'
          description: Unique user ID of user in Kard's system
        email:
          type: string
          description: Email of user if available
        hashedEmail:
          type: string
          description: Hashed email address of user (using SHA-256)
        phoneNumber:
          type: string
          description: Phone number of user in E.164 format
        birthYear:
          type: string
          description: Birth year of user
        userName:
          type: string
          description: Username of user if available
        firstName:
          type: string
          description: First name of user if available
        lastName:
          type: string
          description: Last name of user if available
        zipCode:
          type: string
          description: Zipcode of user if available
        referringPartner:
          type: string
          description: Issuer name
        referringPartnerUserId:
          type: string
          description: Referring partner user ID of user from issuer
        externalPartnerUserId:
          type: string
          description: Partner unique user id, might be equal to referringPartnerUserId, if available
        enrolledRewards:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_EnrolledRewardsType_2'
          description: List of enrolled rewards
        cards:
          type: array
          items:
            $ref: '#/components/schemas/type_users_CardInfoResponse'
          description: List of User Cards Information (this will include the newly added cards added).
        createdDate:
          type: string
          format: date-time
          description: Created date of user in Kard's system (UTC)
        lastModified:
          type: string
          format: date-time
          description: Last modified date of user in Kard's system (UTC)
        __v:
          type: integer
          description: Version of user in Kard's system
      required:
      - _id
      - referringPartner
      - referringPartnerUserId
      - cards
      - createdDate
      - lastModified
      - __v
      title: CreateUserCardResponse
    type_commons_Network:
      type: string
      enum:
      - VISA
      - MASTERCARD
      - AMERICAN EXPRESS
      - DISCOVER
      title: Network
    type_users_CreateUserCardRequestBody:
      type: object
      properties:
        referringPartnerUserId:
          type: string
          description: Referring partner user ID from issuer
        cards:
          type: array
          items:
            $ref: '#/components/schemas/type_users_CardInfoRequest'
          description: List of User Cards Information to add
        cardInfo:
          $ref: '#/components/schemas/type_users_CardInfoRequest'
          description: <b>[Deprecated -- please use "cards" field]</b> User Card Information
      required:
      - referringPartnerUserId
      title: CreateUserCardRequestBody
    type_users_UpdateUserResponse:
      type: object
      properties:
        enrolledRewards:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_EnrolledRewardsType_2'
          description: List of enrolled rewards
        email:
          type: string
          description: Email of user if available
        hashedEmail:
          type: string
          description: Hashed email address of user (using SHA-256)
        phoneNumber:
          type: string
          description: Phone number of user in E.164 format
        birthYear:
          type: string
          description: Birth year of user
        firstName:
          type: string
          description: First name of user if available
        lastName:
          type: string
          description: Last name of user if available
        zipCode:
          type: string
          description: Zipcode of user if available
        referringPartnerUserId:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/openapi/kard-users-api-openapi.yml