# Gets the income verifications for the accounts shared for a consent.

Endpoint: GET /income-verification/v1/consents/{consentId}/verifications
Version: all
Security: Bearer

## Path parameters:

  - `consentId` (string, required)
    The consent ID to fetch the income verifications results for

## Query parameters:

  - `accountId` (string)
    The account ID to fetch the income verification for.
If not specified, all accounts associated with this session are returned

  - `includeFlags` (boolean)
    Includes the flags used to calculate the confidence score

  - `excludeBenefits` (boolean)
    Excludes the benefits from the income streams

## Response 200 fields (application/json):

  - `accountDetails` (object)

  - `accountDetails.accountId` (string,null)
    Unique identifier for the account at the institution

  - `accountDetails.bankCode` (string,null)
    The national bank transit or transfer code used for identification of the bank assigned
by a central bank in a country, eg: A Routing number(US/CA) or Sort code(UK)

  - `accountDetails.accountNumber` (string,null)
    The bank’s unique identifier for the account

  - `accountDetails.accountType` (string)
    Enum: "Business", "Personal"

  - `accountDetails.accountSubType` (string)
    Enum: "ChargeCard", "CreditCard", "CurrentAccount", "Emoney", "Loan", "Mortgage", "PrepaidCard", "Savings"

  - `accountDetails.currencyCode` (string,null)
    ISO4217 currency code for the account

  - `accountDetails.accountHolderNames` (string,null)
    The AccountHolderNames is the name or names of the account owner(s) represented at an account level.

  - `accountDetails.customerReference` (string,null)
    The reference that is passed by the customer

  - `accountDetails.parties` (array,null)

  - `accountDetails.parties.accountHolderName` (string,null)
    Name by which a specific party is known and which is usually used to identify that party.

  - `accountDetails.parties.isIndividual` (boolean,null)
    Indicates the party is an individual and not a business.

  - `accountDetails.parties.isAuthorizingParty` (boolean,null)
    Indicates the party authorized the connection on behalf of a joint or business account.

  - `accountDetails.parties.partyType` (string)
    Party type, in a coded form.
    Enum: "Delegate", "Joint", "Sole"

  - `incomeStreams` (array,null)

  - `incomeStreams.month1` (object)

  - `incomeStreams.month1.income` (number)
    Income value for the month

  - `incomeStreams.month1.month` (integer)

  - `incomeStreams.month1.year` (integer)

  - `incomeStreams.month2` (object)

  - `incomeStreams.month3` (object)

  - `incomeStreams.month4` (object)

  - `incomeStreams.month5` (object)

  - `incomeStreams.month6` (object)

  - `incomeStreams.month7` (object)

  - `incomeStreams.month8` (object)

  - `incomeStreams.month9` (object)

  - `incomeStreams.month10` (object)

  - `incomeStreams.month11` (object)

  - `incomeStreams.estimatedIncome` (number)
    Estimated income for the combined income streams

  - `incomeStreams.confidenceScore` (number)
    Calculated confidence score for the combined income streams

  - `incomeStreams.confidenceScoreFlags` (object)

  - `incomeStreams.confidenceScoreFlags.incomeForLast3Months` (boolean)
    Boolean flag for determining whether the income for the last three months
is present for this group ( > 0)

  - `incomeStreams.confidenceScoreFlags.varianceTolerance5Percent` (boolean)
    Boolean flag for determining whether the difference between estimated income and each
of the last three months incomes is >= -5%

  - `incomeStreams.confidenceScoreFlags.varianceTolerance10Percent` (boolean)
    Boolean flag for determining whether the difference between estimated income and each
of the last three months incomes is >= -10%

  - `incomeStreams.confidenceScoreFlags.mostRecentCheckValue` (boolean)
    Boolean flag for determining whether the most recent recorded income is higher than
or equal to the estimated income

  - `incomeStreams.confidenceScoreFlags.stabilityOverall` (number)
    Calculated income stability over the whole recorded period

  - `incomeStreams.confidenceScoreFlags.stability6Months` (number)
    Calculated income stability over the period of 6 months

  - `incomeStreams.name` (string,null)
    Unique description of this income stream

  - `incomeStreams.numberOfDeposits` (integer)
    The number of deposits made for this income stream

  - `incomeStreams.isBenefit` (boolean)
    A flag indicating whether this income stream is a benefit

  - `incomeStreams.isSalary` (boolean)
    A flag indicating whether this income stream is a salary

  - `incomeStreams.rank` (string)
    Enum: "One", "Two", "Three"

  - `incomeStreamsSummary` (object,null)

  - `verifiedIncomeStatus` (string)
    Enum: "UnsupportedAccountType", "NoCreditTransactions", "Processed"

## Response 400 fields (application/json):

  - `code` (string,null)
    Error code.

  - `description` (string,null)
    Error message.

  - `details` (string,null)
    Error details.

  - `correlationId` (string,null)
    User transaction tracking Id

## Response 403 fields (application/json):

  - `code` (string,null)
    Error code.

  - `description` (string,null)
    Error message.

  - `details` (string,null)
    Error details.

  - `correlationId` (string,null)
    User transaction tracking Id

## Response 404 fields (application/json):

  - `code` (string,null)
    Error code.

  - `description` (string,null)
    Error message.

  - `details` (string,null)
    Error details.

  - `correlationId` (string,null)
    User transaction tracking Id

## Response 500 fields (application/json):

  - `code` (string,null)
    Error code.

  - `description` (string,null)
    Error message.

  - `details` (string,null)
    Error details.

  - `correlationId` (string,null)
    User transaction tracking Id

## Response 502 fields (application/json):

  - `code` (string,null)
    Error code.

  - `description` (string,null)
    Error message.

  - `details` (string,null)
    Error details.

  - `correlationId` (string,null)
    User transaction tracking Id