Finicity

Finicity App Registration API

Documentation GitHub OpenAPI

Operations 7

POST /aggregation/v1/partners/applications Register App #

PUT /aggregation/v1/partners/applications/{preAppId} Modify App Registration #

GET /aggregation/v2/partners/applications Get App Registration Status (Deprecated) #

GET /applications Get App Registration Details #

GET /applications/{application_id}/institutions Get App Registration Status by Institution #

PUT /aggregation/v1/customers/{customerId}/applications/{applicationId} Set Customer App ID #

PUT /aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration Migrate Institution Login Accounts #

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/finicity-app-registration-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

openapi: 3.2.0
info:
  title: Open Finance App Registration API
  description: 'OpenAPI specification for Finicity APIs.


    Open Finance (formerly Open Banking) solutions in the US are provided by

    Finicity, a Mastercard company.'
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/open-finance-us/documentation/support/
  version: 1.43.0
servers:
- url: https://api.finicity.com
  description: Production
security:
- FinicityAppKey: []
  FinicityAppToken: []
tags:
- name: App Registration
  description: Register and assign apps to customers
paths:
  /aggregation/v1/partners/applications:
    post:
      tags:
      - App Registration
      summary: Register App
      description: 'Register a new application to access financial institutions using OAuth connections.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: RegisterApp
      requestBody:
        $ref: '#/components/requestBodies/RegisterAppRequest'
      responses:
        '201':
          $ref: '#/components/responses/RegisterAppResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
  /aggregation/v1/partners/applications/{preAppId}:
    put:
      tags:
      - App Registration
      summary: Modify App Registration
      description: 'Update a registered application.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: ModifyAppRegistration
      parameters:
      - $ref: '#/components/parameters/PreAppIdPathParameter'
      requestBody:
        $ref: '#/components/requestBodies/ModifyAppRegistrationRequest'
      responses:
        '200':
          $ref: '#/components/responses/ModifyAppRegistrationResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
  /aggregation/v2/partners/applications:
    get:
      tags:
      - App Registration
      summary: Get App Registration Status (Deprecated)
      deprecated: true
      description: "This endpoint will not be supported after May 2026.\n\nYou must update your code to use one of the following alternatives.\n*  To check the status of your app registrations on Mastercard's\n   Open Finance platform, use:\n\n   [GET /applications](#getApplications)\n\n\n* To check the status of your application with a particular\n  Financial Institution, use:\n\n  [GET\n/applications/{application_id}/institutions](#getRegisteredInstitutions)\n\n_Supported regions_: ![\U0001F1FA\U0001F1F8](https://flagcdn.com/20x15/us.png)"
      operationId: GetAppRegistrationStatus
      parameters:
      - $ref: '#/components/parameters/PreAppIdQueryParameter'
      - $ref: '#/components/parameters/ApplicationIdQueryParameter'
      - $ref: '#/components/parameters/AppRegistrationStatusParameter'
      - $ref: '#/components/parameters/ApplicationNameParameter'
      - $ref: '#/components/parameters/SubmittedDateParameter'
      - $ref: '#/components/parameters/ModifiedDateParameter'
      - $ref: '#/components/parameters/ResultPageParameter'
      - $ref: '#/components/parameters/ResultPageSizeParameter'
      responses:
        '200':
          $ref: '#/components/responses/GetAppRegistrationStatusResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
  /applications:
    get:
      tags:
      - App Registration
      summary: Get App Registration Details
      description: 'This endpoint returns the status of the submitted application and provides additional details.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: getApplications
      parameters:
      - $ref: '#/components/parameters/StartParameter'
      - $ref: '#/components/parameters/ApplicationLimitParameter'
      - $ref: '#/components/parameters/PreAppIdParameter'
      - $ref: '#/components/parameters/ApplicationIdParameter'
      - $ref: '#/components/parameters/AppNameParameter'
      - $ref: '#/components/parameters/AppStatusParameter'
      responses:
        '200':
          $ref: '#/components/responses/AppResponse'
        '400':
          $ref: '#/components/responses/GetApplicationsStatusBadErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
  /applications/{application_id}/institutions:
    get:
      tags:
      - App Registration
      summary: Get App Registration Status by Institution
      description: 'Query the status of your application registration. If you specify the ID of a financial institution in your query then the status for that institution is returned. If you do not specify an instituion ID then the status for all financial institutions is returned.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: getRegisteredInstitutions
      parameters:
      - $ref: '#/components/parameters/AppIdPathParameter'
      - $ref: '#/components/parameters/StartParameter'
      - $ref: '#/components/parameters/InstitutionLimitParameter'
      - $ref: '#/components/parameters/InstitutionIdQueryParameter'
      responses:
        '200':
          $ref: '#/components/responses/InstitutionsResponse'
        '400':
          $ref: '#/components/responses/GetApplicationsRegistrationStatusBadErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/GetApplicationRegistrationStatusResourceNotFoundErrorResponse'
  /aggregation/v1/customers/{customerId}/applications/{applicationId}:
    put:
      tags:
      - App Registration
      summary: Set Customer App ID
      description: 'If you have multiple applications for a single client, and you want to register their applications to access financial institutions using OAuth connections, then use this API to assign applications to an existing customer.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: SetCustomerAppID
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/ApplicationIdPathParameter'
      responses:
        '200':
          $ref: '#/components/responses/SetCustomerAppIDResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
  /aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration:
    put:
      tags:
      - App Registration
      summary: Migrate Institution Login Accounts
      description: 'The `institutionLoginId` parameter uses Finicity''s internal FI mapping to move accounts from the current FI legacy connection to the new OAuth FI connection.


        This API returns a list of accounts for the given institution login ID.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: MigrateInstitutionLoginAccounts
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/InstitutionLoginIdParameter'
      responses:
        '200':
          $ref: '#/components/responses/MigrateInstitutionLoginAccountsResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
components:
  examples:
    MissingFinicityAppKeyExample:
      value:
        code: '10026'
        message: Missing parameter (Finicity-App-Key)
    ResellerNoReportForPartnerExample:
      value:
        code: '10100'
        message: Cannot find resellerBilling reports with id 2445581559892.
    ResellerInvalidDateRangeGreaterThan31DaysExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - It is more than 31 days'
    ResellerInvalidDateRangeGreaterThanEndDateExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - startDate is greaterThan endDate'
    BothCraAndFtcPurposeTrueExample:
      value:
        code: '10100'
        status: '400'
        message: forCRAPurpose and forFTCPurpose may not both be TRUE.
    MissingFieldExample:
      value:
        code: '10005'
        message: Missing parameter (partnerId)
    ResellerInvalidDateRangeLessThanZeroExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - start or end date less than or equal to zero'
    InvalidConsumerEmailExample:
      value:
        code: '10100'
        message: Invalid format for field consumer.email.
    InvalidQueryParametersExample:
      value:
        code: '3008'
        status: '400'
        message: Bad Request
        user_message: 'Known query parameters: [pre_app_id, application_id, status, name] are allowed only'
    BadCredentialsExample:
      value:
        code: '24302'
        message: Bad credentials
    AppResponseExample:
      value:
        found: 2
        displaying: 2
        moreAvailable: false
        applications:
        - preAppId: 13
          applicationId: 234dsfdsf-535fdgdtrtr-546464564
          status: A
          name: Mvelopes
          scopes: Account Info
          note: Auto approved
          createdDate: 2020-07-30 16:11:23+00:00
          modifiedDate: 2020-07-30 16:11:23+00:00
          submittedDate: 2020-07-30 16:11:23+00:00
        - preAppId: 43
          applicationId: 32edsfdsf-535dsdsrtr-546dsaes4
          status: D
          name: TestApp
          scopes: Account Info
          note: Auto approved
          createdDate: 2020-07-30 16:11:23+00:00
          modifiedDate: 2020-07-30 16:11:23+00:00
          submittedDate: 2020-07-30 16:11:23+00:00
    InvalidForesightReportRequestExample:
      value:
        code: '10100'
        message: At least one of customerId or externalCustomerId must be provided; both are also allowed.
    ApplicationRegistrationStatusNotFoundExample:
      value:
        code: '3002'
        status: '404'
        message: Resource Not Found
        user_message: Requested application registration status is not found against financial institutions
    NoRegisteredApplicationExample:
      value:
        code: '50051'
        message: No registered partner applications found.
    ExpiredFinicityAppTokenExample:
      value:
        code: '10023'
        message: Expired (Finicity-App-Token)
    InvalidFieldExample:
      value:
        code: '10010'
        status: '400'
        message: Customer ID does not exist or does not belong to this partner
        user_message: One or more of the fields could not be validated. Please ensure you have entered the correct data.
        tags: ''
    InvalidValueExample:
      value:
        code: '1618'
        message: Negative or invalid value entered. Please use positive numbers only.
    InvalidConsumerSSNExample:
      value:
        code: '10100'
        message: Invalid format for field consumer.ssn.  Required format is 9 digits.
    InvalidFinicityAppTokenExample:
      value:
        code: '10022'
        message: Invalid (Finicity-App-Token)
    NoAccountForInstitutionLoginIdExample:
      value:
        code: '38007'
        message: Customer does not have any accounts associated with institutionLoginId.
    CustomerNotFoundExample:
      value:
        code: '14001'
        message: Customer not found.
    ResellerNoDataForPartnerExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Reports not found 2445583947903 resellerBilling reports'
    ExpiredTokenExample:
      value:
        code: '10023'
        message: Expired (Finicity-App-Token)
    InvalidStartValueExample:
      value:
        code: '3005'
        status: '400'
        message: Bad Request
        user_message: Invalid Start value
    ResellerInvalidDateRangeExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - start or end date is empty or null'
    ResourceNotFoundExample:
      value:
        code: '14001'
        message: Resource not found.
    ConsumerNotFoundExample:
      value:
        code: '10100'
        message: Cannot find consumer with id 1234.
    GenericBadRequestExample:
      value:
        code: '14020'
        message: Bad request.
    InvalidConsumerPhoneExample:
      value:
        code: '10100'
        message: Invalid format for field consumer.phone.
    AccountTypeNotSupportedExample:
      value:
        code: '14020'
        message: Bad request. (Account type not supported).
    PermissiblePurposeCodeExample:
      value:
        code: '10100'
        status: '400'
        message: Permissible Purpose Code is required
    InstitutionResponseExample:
      value:
        found: 500
        displaying: 2
        moreAvailable: true
        institutions:
        - institutionId: 170881
          institutionName: Citi
          status: true
          createdDate: 2020-07-30 16:11:23+00:00
          modifiedDate: 2020-07-30 16:11:23+00:00
        - institutionId: 102224
          institutionName: Chase
          status: true
          createdDate: 2020-07-30 16:11:23+00:00
          modifiedDate: 2020-07-30 16:11:23+00:00
    InvalidLimitValueExample:
      value:
        code: '3006'
        status: '400'
        message: Bad Request
        user_message: Invalid Limit value
    ResellerPartnerNotAuthorizedExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Partner is not authorized to access resellerBilling reports for partnerId 2445583947903'
    LimitValueExceededExample:
      value:
        code: '3007'
        status: '400'
        message: Bad Request
        user_message: Requested Limit value is exceeded than allowed max Limit value
    CustomerReportLimitExceedExample:
      value:
        code: '20400'
        message: The max report generation limit was exceeded for this customer.
    ApplicationIdNotFoundExample:
      value:
        code: '3001'
        status: '404'
        message: Resource Not Found
        user_message: Requested Application Id is not found
    InvalidExperienceFieldExample:
      value:
        code: '10010'
        status: '400'
        message: '"experience" must be a valid GUID'
        user_message: One or more of the fields could not be validated. Please ensure you have entered the correct data.
        tags: ''
    InvalidQueryParametersValueExample:
      value:
        code: '3009'
        status: '400'
        message: Bad Request
        user_message: One/more of [pre_app_id, application_id, status, name] query parameter values provided are invalid
    NoConsumerForCustomerExample:
      value:
        code: '10100'
        message: Cannot find consumer for customer with id 5011115315."
    MissingFinicityAppTokenExample:
      value:
        code: '10024'
        message: Missing parameter (Finicity-App-Token)
  responses:
    MigrateInstitutionLoginAccountsResponse:
      description: The migration succeeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CustomerAccounts'
    GetApplicationsRegistrationStatusBadErrorResponse:
      description: The request was rejected
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            InvalidStartValueExample:
              $ref: '#/components/examples/InvalidStartValueExample'
            InvalidLimitValueExample:
              $ref: '#/components/examples/InvalidLimitValueExample'
            LimitValueExceededExample:
              $ref: '#/components/examples/LimitValueExceededExample'
    BadRequestErrorResponse:
      description: The request was rejected
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            PermissiblePurposeCodeExample:
              $ref: '#/components/examples/PermissiblePurposeCodeExample'
            InvalidForesightReportRequestExample:
              $ref: '#/components/examples/InvalidForesightReportRequestExample'
            BothCraAndFtcPurposeTrueExample:
              $ref: '#/components/examples/BothCraAndFtcPurposeTrueExample'
            MissingFieldExample:
              $ref: '#/components/examples/MissingFieldExample'
            InvalidFieldExample:
              $ref: '#/components/examples/InvalidFieldExample'
            InvalidExperienceFieldExample:
              $ref: '#/components/examples/InvalidExperienceFieldExample'
            GenericBadRequestExample:
              $ref: '#/components/examples/GenericBadRequestExample'
            AccountTypeNotSupportedExample:
              $ref: '#/components/examples/AccountTypeNotSupportedExample'
            ResellerPartnerNotAuthorizedExample:
              $ref: '#/components/examples/ResellerPartnerNotAuthorizedExample'
            ResellerInvalidDateRangeExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeExample'
            ResellerInvalidDateRangeLessThanZeroExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeLessThanZeroExample'
            ResellerInvalidDateRangeGreaterThanEndDateExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeGreaterThanEndDateExample'
            ResellerInvalidDateRangeGreaterThan31DaysExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeGreaterThan31DaysExample'
            CustomerReportLimitExceedExample:
              $ref: '#/components/examples/CustomerReportLimitExceedExample'
            InvalidConsumerSSNExample:
              $ref: '#/components/examples/InvalidConsumerSSNExample'
            InvalidConsumerPhoneExample:
              $ref: '#/components/examples/InvalidConsumerPhoneExample'
            InvalidConsumerEmailExample:
              $ref: '#/components/examples/InvalidConsumerEmailExample'
            InvalidValue:
              $ref: '#/components/examples/InvalidValueExample'
    RegisterAppResponse:
      description: The app registration was successfully created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RegisteredApplication'
    InstitutionsResponse:
      description: The requested application registration status against financial institutions.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InstitutionResponse'
          examples:
            InstitutionsDetailResponseExample:
              $ref: '#/components/examples/InstitutionResponseExample'
    ModifyAppRegistrationResponse:
      description: The app registration was updated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RegisteredApplication'
    GetApplicationRegistrationStatusResourceNotFoundErrorResponse:
      description: The resource doesn't exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            ApplicationIdNotFoundExample:
              $ref: '#/components/examples/ApplicationIdNotFoundExample'
            ApplicationRegistrationStatusNotFoundExample:
              $ref: '#/components/examples/ApplicationRegistrationStatusNotFoundExample'
    UnauthorizedErrorResponse:
      description: The request lacks valid authentication credentials. Check "Finicity-App-Key" or "Finicity-App-Token".
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            ExpiredTokenExample:
              $ref: '#/components/examples/ExpiredTokenExample'
            MissingFinicityAppKeyExample:
              $ref: '#/components/examples/MissingFinicityAppKeyExample'
            MissingFinicityAppTokenExample:
              $ref: '#/components/examples/MissingFinicityAppTokenExample'
            InvalidFinicityAppTokenExample:
              $ref: '#/components/examples/InvalidFinicityAppTokenExample'
            ExpiredFinicityAppTokenExample:
              $ref: '#/components/examples/ExpiredFinicityAppTokenExample'
            BadCredentialsExample:
              $ref: '#/components/examples/BadCredentialsExample'
        text/plain:
          schema:
            type: string
            example: Invalid (Finicity-App-Key)
    AppResponse:
      description: Response containing one or more application details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApplicationResponse'
          examples:
            AppResponseExample:
              $ref: '#/components/examples/AppResponseExample'
    ResourceNotFoundErrorResponse:
      description: The resource doesn't exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            ConsumerNotFoundExample:
              $ref: '#/components/examples/ConsumerNotFoundExample'
            NoAccountForInstitutionLoginIdExample:
              $ref: '#/components/examples/NoAccountForInstitutionLoginIdExample'
            CustomerNotFoundExample:
              $ref: '#/components/examples/CustomerNotFoundExample'
            NoConsumerForCustomerExample:
              $ref: '#/components/examples/NoConsumerForCustomerExample'
            ResourceNotFoundExample:
              $ref: '#/components/examples/ResourceNotFoundExample'
            NoRegisteredApplicationExample:
              $ref: '#/components/examples/NoRegisteredApplicationExample'
            ResellerNoDataForPartnerExample:
              $ref: '#/components/examples/ResellerNoDataForPartnerExample'
            ResellerNoReportForPartnerExample:
              $ref: '#/components/examples/ResellerNoReportForPartnerExample'
    SetCustomerAppIDResponse:
      description: The app was successfully assigned
    GetApplicationsStatusBadErrorResponse:
      description: The request was rejected
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            InvalidStartValueExample:
              $ref: '#/components/examples/InvalidStartValueExample'
            InvalidLimitValueExample:
              $ref: '#/components/examples/InvalidLimitValueExample'
            LimitValueExceededExample:
              $ref: '#/components/examples/LimitValueExceededExample'
            InvalidQueryParametersExample:
              $ref: '#/components/examples/InvalidQueryParametersExample'
            InvalidQueryParametersValueExample:
              $ref: '#/components/examples/InvalidQueryParametersValueExample'
    GetAppRegistrationStatusResponse:
      description: The app registration statuses were returned
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppStatuses'
  schemas:
    AuthorizationExpires:
      type: boolean
      description: A Boolean flag that indicates whether the customer’s authorization period has a defined authorization end date.
      example: true
      default: false
    InstitutionResponse:
      type: object
      properties:
        found:
          $ref: '#/components/schemas/FoundResults'
        displaying:
          $ref: '#/components/schemas/DisplayingResults'
        moreAvailable:
          $ref: '#/components/schemas/MoreResultsAvailable'
        institutions:
          type: array
          description: List of institution details for an application
          example:
          - institutionId: 102224
            institutionName: Chase
            status: true
            createdDate: 2020-07-30 16:11:23+00:00
            modifiedDate: 2020-07-30 16:11:23+00:00
          items:
            $ref: '#/components/schemas/FinancialInstitution'
    PeriodEndDate:
      type: integer
      description: 'End date of period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).'
      format: int64
      example: 1607450357
    PayoffAmountDate:
      type: integer
      description: '(Mortgage/Loan) Date of final payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).'
      format: int64
      example: 1607450357
    CustomerAccountMarketSegment:
      type: string
      description: 'The market segment of the account. Possible values: personal, business'
      example: personal
    MaturityDate:
      type: integer
      description: '(Checking/Savings/CD/MoneyMarket) Maturity date of account type. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).'
      format: int64
      example: 1607450357
    AppStatus:
      description: Registration status details for the application
      required:
      - partnerId
      - preAppId
      - appName
      - submittedDate
      - modifiedDate
      - status
      type: object
      properties:
        partnerId:
          $ref: '#/components/schemas/PartnerId'
        preAppId:
          $ref: '#/components/schemas/PreAppId'
        note:
          type: string
          description: A note on the registration. Typically used to indicate reasons for rejected apps.
          example: Approved
        applicationId:
          $ref: '#/components/schemas/ApplicationId'
        appName:
          $ref: '#/components/schemas/ApplicationName'
        submittedDate:
          $ref: '#/components/schemas/UnixDate'
        modifiedDate:
          $ref: '#/components/schemas/UnixDate'
        status:
          $ref: '#/components/schemas/AppRegistrationStatus'
        scopes:
          type: string
          description: Indicates scopes of data accessible to the app
          example: Account Info
        institutionDetails:
          type: array
          items:
            $ref: '#/components/schemas/AppFinancialInstitutionStatus'
          description: A list of the registration status for each FI for the application
    DisplayingResults:
      type: integer
      description: The number of results returned
      example: 1
    CustomerAccountPosition:
      description: Details for investment account holdings
      type: object
      properties:
        id:
          type: integer
          description: The ID of the investment position
          format: int64
          example: 454678080
        description:
          type: string
          description: The description of the holding
          example: DELTA AIR LINES INC
        symbol:
          type: string
          description: The investment position's market ticker symbol
          example: DAL
        units:
          type: number
          description: The number of units of the holding
          example: 6.537
        currentPrice:
          type: number
          description: The current price of the investment holding
          example: 41.585
        securityName:
          type: string
          description: The security name for the investment holding
          example: DELTA AIR LINES INC
        transactionType:
          type: string
          description: The transaction type of the holding, such as cash, margin, and more
          example: Margin
        marketValue:
          type: number
          description: Market value of an investment position at the time of retrieval
          example: 271.84
        changePercent:
          type: number
          description: The percent change in value since the previous day
          example: 170.02
        dailyChange:
          type: number
          description: The value amount change since the previous day
          example: 180.03
        costBasis:
          type: number
          description: The total cost of acquiring the security
          example: 190.01
        paidPrice:
          type: number
          description: The price per unit of a holding at the time of purchase
          example: 11.1526
        holdType:
          type: string
          description: The type of the holding
          example: INVESTMENT
        invSecurityType:
          type: string
          description: The security type for the investment holding
          example: OTHERINFO
        status:
          type: string
          description: The status of the holding
          example: A
        currentPriceDate:
          $ref: '#/components/schemas/UnixDate'
        securityType:
          type: string
          description: Type of security for the investment position
          example: Stock
        mfType:
          type: string
          description: Type of mutual fund, such as open ended
          example: OPENEND
        posType:
          type: string
          description: Fund type assigned by the FI (long or short)
          example: Long
        totalGLDollar:
          type: number
          description: Total gain and loss of the position at the time of aggregation in dollars
          example: 162742.9
        totalGLPercent:
          type: number
          description: Total gain and loss of the position at the time of aggregation in percentage
          example: 68.89
        optionStrikePrice:
          type: number
          description: The strike price of the option contract
          example: 50
        optionType:
          type: string
          description: The type of option contract (PUT or CALL)
          example: PUT
        optionSharesPerContract:
          type: number
          description: The number of shares per option contract
          example: 100
        optionExpireDate:
          type: string
          description: Expiration date of option
          format: date
          example: '1644994800'
        fiAssetClass:
          type: string
          description: Financial Institution (FI) defined asset class (COMMON STOCK, COMNEQTY, EQUITY/STOCK, CMA-ISA, CONVERTIBLE PREFERREDS, CORPORATE BONDS, OTHER MONEY FUNDS, ALLOCATION FUNDS, CMA-TAXABLE, FOREIGNEQUITYADRS, COMMONSTOCK, PREFERRED STOCKS, STABLE VALUE, FOREIGN EQUITY ADRS)
          example: COMNEQTY
        assetClass:
          type: string
          description: An asset class is a grouping of comparable financial securities. These include equities (stocks), fixed income (bonds), and cash equivalent or money market instruments. (DOMESTICBOND, LARGESTOCK, INTLSTOCK, MONEYMRKT, OTHER)
          example: INTLSTOCK
        currencyRate:
          type: number
          description: Currency rate, ratio of currency to original currency
          example: 1
        securityId:
          type: string
          description: The security ID of the transaction
          example: 25400W102
        securityIdType:
          $ref: '#/components/schemas/SecurityIdType'
        costBasisPerShare:
          type: number
          description: The per share cost of acquiring the security
          example: 13.38
        subAccountType:
          type: string
          description: The subaccount's type, such as cash
          example: CASH
        securityCurrency:
          type: string
          description: Symbol for the currency that the account is being converted into
          example: USD
        todayGLDollar:
          type: number
          description: The current day's gain and loss of the position at the time of aggregation in dollars
          example: 16272.9
        todayGLPercent:
          type: number
          description: The current day's gain and loss of the position at the time of aggregation in percentage
          example: 18.89
    LoanStatusEndDate:
      type: integer
      description: '(Student Loan) The end date of the current status. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-fin

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finicity/refs/heads/main/openapi/finicity-app-registration-api-openapi.yml