openapi: 3.0.1
info:
  title: Flinks Authorize Score API
  description: Representative specification of the Flinks financial data API. Businesses connect to consumer and business bank accounts to aggregate account, transaction, and statement data, verify identity, and derive income, credit-risk, and fraud analytics. A session is opened with the multi-step /Authorize (MFA) endpoint using a LoginId returned by Flinks Connect; the resulting RequestId is passed to subsequent data, enrichment, and analytics endpoints. All calls are authenticated with a short-lived authorize token supplied in the flinks-auth-key header.
  termsOfService: https://flinks.com/terms-of-service/
  contact:
    name: Flinks Support
    url: https://help.flinks.com/
  version: '3.0'
servers:
- url: https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
  description: Flinks per-customer instance host.
  variables:
    instance:
      default: toolbox
      description: Assigned instance / environment prefix (e.g. toolbox for sandbox).
    customerId:
      default: 00000000-0000-0000-0000-000000000000
      description: Your Flinks customer identifier (GUID).
security:
- flinks_auth_key: []
tags:
- name: Score
paths:
  /GetIncomeAttributes:
    post:
      operationId: getIncomeAttributes
      tags:
      - Score
      summary: Standardized income verification attributes.
      description: Returns a high-level overview of total income, employment income, and government income for standardized income verification.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttributesRequest'
      responses:
        '200':
          description: Income attributes returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributesResponse'
  /GetCreditRiskAttributes:
    post:
      operationId: getCreditRiskAttributes
      tags:
      - Score
      summary: Credit risk and income attributes.
      description: Returns overall financial information, employment and non-employment income sources, loan payments, bill payments, and additional risk analysis measures.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttributesRequest'
      responses:
        '200':
          description: Credit risk attributes returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributesResponse'
components:
  schemas:
    AttributesResponse:
      type: object
      properties:
        RequestId:
          type: string
          format: uuid
        Attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
    Attribute:
      type: object
      properties:
        Name:
          type: string
        Value:
          type: string
    AttributesRequest:
      type: object
      properties:
        RequestId:
          type: string
          format: uuid
        Package:
          type: string
          description: Attributes package name to compute.
      required:
      - RequestId
  securitySchemes:
    flinks_auth_key:
      type: apiKey
      in: header
      name: flinks-auth-key
      description: Short-lived (30-minute) authorize token obtained from /GenerateAuthorizeToken.