openapi: 3.1.0
info:
  x-metadata:
    status: published
    tags:
      - Featured
  version: 1.0.0
  license:
    name: Proprietary
  title: Consumer And Misc
  description: >

    Endpoints to order Consumer Reports for multiple regions.


    **European Consumers (Sweden, Norway, Netherlands, Germany):**  

    In order to order a European Consumer Report, sufficient information to
    uniquely identify the Consumer (search criteria) must be provided to filter
    potential results down to one record. When one record has been found, the
    returned object will be the Consumer Report.


    **US Consumers:**  

    US Consumer credit reports require specific search criteria as defined by US
    credit bureau requirements.


    ---


    **Important Note on Response Structure**


    The response structure shown in this documentation represents the **full set
    of fields** that may be returned by the Consumer Report service.


    Actual responses depend on the data available for the requested consumer. If
    certain information (e.g., incomes, property details, credit score) is not
    available, those fields will be omitted from the response.


    **Always implement your integration to handle missing or partial data
    gracefully.**


    ---
tags:
  - name: Authentication
    description: Authentication endpoint to obtain access token for API requests.
  - name: European Consumers
    description: >-
      Endpoints for searching and retrieving European consumer credit reports
      (Sweden, Norway, Netherlands, Germany) based on provided search criteria.
  - name: US Consumers
    description: >-
      Endpoints for searching and retrieving US consumer credit reports based on
      provided search criteria.
servers:
  - url: https://connect.sandbox.creditsafe.com/v1
    description: Sandbox server
  - url: https://connect.creditsafe.com/v1
    description: Production server
paths:
  /authenticate:
    post:
      operationId: authenticate
      summary: Authenticate
      security: []
      tags:
        - Authentication
      description: |
        Supply username and password to generate Authentication Token.
          
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectAuthenticationAuthRequest'
        required: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectAuthenticationAuthResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectAuthFailedResponse'
  /consumers/searchcriteria:
    get:
      tags:
        - European Consumers
      description: >-
        Returns country specific fields that can be used to search for a
        Consumer.
      operationId: consumerSearchCriteria
      summary: Return European Consumer Search Criteria
      parameters:
        - name: countries
          required: true
          in: query
          example: de
          description: Comma-separated list of ISO-2 country codes
          schema:
            type: string
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                    - $ref: >-
                        #/components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
  /reportcustomdata/{country}:
    get:
      tags:
        - European Consumers
      description: >-
        Returns the allowed values of the customData parameter.  

        Used in the `GET Company Report and Director Report endpoints`.  I.e.
        Supplying `DE` as a country code will return a list of reasons for
        requesting a DE Credit Report (a legal requirement to supply with each
        Credit Report request in Germany). This will provide a list of
        allowedValues to enter into the mandatory Parameter `customData` =
        `de_reason_code::allowedValue`.
      operationId: customReportParameters
      summary: Return Custom Report Parameters
      parameters:
        - name: country
          in: path
          description: >-
            An ISO/Alpha-2 country code to display any special mandatory
            parameters when ordering a Credit Report in that territory.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  customData:
                    - key: de_reason_code
                      optional: false
                      allowedValues:
                        - '1'
                        - '2'
                        - '3'
                        - '4'
                        - '5'
                        - '6'
                        - '7'
                        - '8'
                      description:
                        - 'DE report retrieval reason code:'
                        - 1 - Credit Decision'
                        - >-
                          2 - Credit Assessment - Future business connection
                          (with credit risk)
                        - >-
                          3 - Credit Assessment - Existing business connection
                          (with credit risk)
                        - 4 - Realisation check receivables collection
                        - >-
                          5 - Purchase Contract - Intention of signature of
                          purchase contract (with credit risk)
                        - 6 - Goods Credit Insurance (with credit risk)
                        - >-
                          7 - Contract - Intention of signature of leasing or
                          rent contract (with credit risk)
                        - >-
                          8 - Insurance Contract - Intention of signature of a
                          insurance contract (with credit risk)
                  country: DE
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
  /consumers:
    get:
      tags:
        - European Consumers
      description: >-
        Consumer Search and Report endpoint. When sufficient information has
        been provided to filter potential Consumer results down to one record
        then the Consumer Report will be returned.
      operationId: consumerReport
      summary: Consumer Report
      parameters:
        - name: countries
          in: query
          example: DE
          description: >-
            ISO-2 country code. Only available for `DE` (Germany) and `NL`
            (Netherlands)
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: ''
          schema:
            type:
              - string
              - 'null'
            default: EN
            maxLength: 2
            minLength: 2
        - name: firstName
          in: query
          description: Consumer's First Name
          schema:
            type: string
          required: true
        - name: lastName
          in: query
          description: Consumer's Last Name
          schema:
            type: string
          required: true
        - name: street
          in: query
          description: Address part identifier - Street of the Consumer
          schema:
            type: string
          required: true
        - name: houseNo
          in: query
          description: Address part identifier - House/Building Number of the Consumer
          schema:
            type: string
          required: true
        - name: city
          in: query
          description: Address part identifier - City of the Consumer
          schema:
            type: string
          required: true
        - name: postCode
          in: query
          description: Address part identifier - Postcode/Zip Code of the Consumer
          schema:
            type: string
          required: true
        - name: dateOfBirth
          in: query
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: customData
          in: query
          example: de_reason_code::ER
          schema:
            type:
              - string
              - 'null'
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type:
              - string
              - 'null'
            default: null
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: Unique identifier for tracing the request.
                  totalSize:
                    type: integer
                    format: int32
                  consumers:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
  /consumers/tryReport/searchcriteria:
    get:
      tags:
        - US Consumers
      description: >-
        Returns country specific fields that can be used to search for a US
        Consumer TryReport.  Use this endpoint to discover all supported search
        criteria query parameters and validation rules  for the
        /consumers/tryReport endpoint.
      operationId: consumerTryReportSearchCriteria
      parameters:
        - name: countries
          in: query
          example: US
          description: ISO-2 country code
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
      summary: Return US Consumers Search Criteria
  /consumers/tryReport:
    get:
      tags:
        - US Consumers
      description: >-
        Search for US consumer based on provided criteria. Returns a consumer
        report with credit information,  trade lines, negative information, and
        employment details.


        **Template Options:**

        - `basic` - Standard consumer report without credit score. No footprint
        left on consumer's credit file.

        - `hardcheck` - Includes credit score in response and leaves a footprint
        (inquiry) on the consumer's credit file. Used for actual credit
        decisions.
      operationId: consumerTryReport
      summary: US Consumer Report
      parameters:
        - name: countries
          in: query
          example: US
          description: >-
            A single country code in ISO-2 format. Must be `US` for US consumer
            reports.
          required: true
          schema:
            type: string
            pattern: ^[A-Z]{2}$
            maxLength: 2
            minLength: 2
        - name: firstName
          in: query
          description: First name of US consumer
          required: true
          schema:
            type: string
        - name: lastName
          in: query
          description: Last name of US consumer
          required: true
          schema:
            type: string
        - name: template
          in: query
          description: >-
            Consumer report template.  `basic` (default) returns report without
            credit score and leaves no footprint.  `hardcheck` includes credit
            score and leaves an inquiry on the consumer's credit file.
          schema:
            type: string
            enum:
              - basic
              - hardcheck
            default: basic
        - name: personNumber
          in: query
          description: Social security number (SSN) of US Consumer
          schema:
            type: string
            pattern: ^[a-zA-Z0-9]+$
        - name: dateOfBirth
          in: query
          description: Date of birth of US Consumer (format YYYY-MM-DD)
          schema:
            type: string
            format: date
        - name: street
          in: query
          description: Street name and house number of US consumer
          schema:
            type: string
        - name: city
          in: query
          description: City of US consumer
          schema:
            type: string
        - name: postalCode
          in: query
          description: Postal / zip code of US consumer
          schema:
            type: string
        - name: province
          in: query
          description: US state of US consumer (2-letter state code, e.g., AL, CA, NY)
          schema:
            type: string
            maxLength: 2
            minLength: 2
            pattern: ^[A-Z]{2}$
        - name: telephone
          in: query
          description: Telephone number of US consumer
          schema:
            type: string
      responses:
        '200':
          description: Consumer TryReport response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
components:
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This API requires authentication for access to protected endpoints.
        Authentication is performed by providing a valid JWT token in the
        `Authorization` header of each request.
  schemas:
    ConnectAuthenticationAuthRequest:
      type: object
      properties:
        username:
          type: string
          description: Credentials assigned upon sign up
          example: username@domain.com
        password:
          type: string
          example: ^1gHySRA56aj>tf421o
    ConnectAuthenticationAuthResponse:
      type: object
      properties:
        token:
          type: string
          description: Authentication Token
          example: >-
            eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA
    ConnectAuthFailedResponse:
      type: object
      properties:
        message:
          type: string
      example:
        message: >-
          Access denied -  Please check that your username and password are
          correct.  Please be aware that usernames and passwords are case
          sensitive. If the problem persists, please contact your Creditsafe
          account manager.
    CreditsafeGlobalDataReportsConsumerCriteriaSet:
      properties:
        countries:
          type: array
          items:
            type: string
            example: DE
        criteriaSets:
          type: array
          items:
            type: object
    ConnectErrorResponsesBadRequest:
      type: object
      description: Bad Request
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        message:
          type: string
        details:
          type: string
          description: Provides further information on why the request was rejected
    ConnectErrorResponsesInvalidToken:
      type: object
      properties:
        error:
          type: string
      description: >-
        401 - Authorization Token has either expired or is not a valid Connect
        Token
    CreditsafeGlobalDataReportsGender:
      enum:
        - Unknown
        - Male
        - Female
        - NotApplicable
      type: string
    CreditsafeGlobalDataAddressData:
      type: object
      properties:
        type:
          type: string
          description: >-
            Address type description. Examples - "Registered Office", "Trading
            Address", "Postal Address", "Service Address" etc.
        simpleValue:
          type: string
          description: >-
            (Optionally populated) Registered address of the company. Whole
            string address if Creditsafe is unable to accurately assign values
            to specific address fields, or when specific local address formats
            need to be observed.
        street:
          type: string
          description: >-
            Street portion of the address line. Can also, optionally contain,
            the house number alongside the street.
        houseNumber:
          type: string
          description: House number portion of the address line.
        additionToAddress:
          type: string
          description: >-
            Additional details for a specified address, such as a PO Box number,
            or a unit number at the specified address location.
        city:
          type: string
          description: City portion of the address line.
        postalCode:
          type: string
          description: Postal code portion of the address line.
        province:
          type: string
          description: Province portion of the address line.
        region:
          type: string
          description: >-
            May contain the geographical region, for example "South-East" or a
            territorial division.
        telephone:
          type: string
          description: Registered telephone number.
        directMarketingOptOut:
          type:
            - boolean
            - 'null'
          description: >-
            Boolean [true/false]. Where set to true, the subject has "opted out"
            via a central register, and they must not be contacted for
            commercial marketing purposes.
        directMarketingOptIn:
          type:
            - boolean
            - 'null'
        country:
          type: string
          pattern: ^[A-Z]{2}$
          description: >-
            ISO 3166-1 alpha-2 country code representing the geographic location
            of the entity.
          example: MC
    CreditsafeGlobalDataReportsAdditionalData:
      type: object
      description: >
        The additionalData field is country-specific and may contain different
        properties depending on the country and product configuration.

        For the UK, it may include director verification details (See this
        link).

        For other countries, the structure and content may vary or be absent.
    CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsConsumerConsumerInformation:
      type: object
      properties:
        name:
          type: string
        firstName:
          type: string
        surname:
          type: string
        age:
          type:
            - integer
            - 'null'
          format: int32
        dateOfBirth:
          type:
            - string
            - 'null'
          format: date-time
        gender:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsGender'
        consumerID:
          type: string
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData
    CreditsafeGlobalDataReportsConsumerConsumerIncome:
      type: object
      properties:
        incomeYear:
          type: integer
          format: int32
        taxClass:
          type: string
        netWealth:
          type:
            - number
            - 'null'
          format: double
        netIncome:
          type:
            - number
            - 'null'
          format: double
        sumTax:
          type:
            - number
            - 'null'
          format: double
        grossIncome:
          type:
            - number
            - 'null'
          format: double
        municipalityNr:
          type: string
    CreditsafeGlobalDataReportsConsumerConsumerDirectorship:
      type: object
      properties:
        companyName:
          type: string
        companyStatus:
          type: string
        appointmentDate:
          type:
            - string
            - 'null'
          format: date-time
        turnover:
          type:
            - number
            - 'null'
          format: double
        creditRating:
          type: string
        companyNumber:
          type: string
        function:
          type: string
        companyRegistrationDate:
          type:
            - string
            - 'null'
          format: date-time
        netWorth:
          type:
            - number
            - 'null'
          format: double
        creditLimit:
          type:
            - number
            - 'null'
          format: double
    CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary:
      type: object
      properties:
        unsettledROPNumber:
          type:
            - integer
            - 'null'
          format: int32
        partlySettledROPNumber:
          type:
            - integer
            - 'null'
          format: int32
        voluntaryPledgeNumber:
          type:
            - integer
            - 'null'
          format: int32
        unsettledROPAmount:
          type:
            - number
            - 'null'
          format: double
        partlySettledROPAmount:
          type:
            - number
            - 'null'
          format: double
        voluntaryPledgeAmount:
          type:
            - number
            - 'null'
          format: double
    CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment:
      type: object
      properties:
        type:
          type: string
        date:
          type:
            - string
            - 'null'
          format: date-time
        source:
          type: string
        refNr:
          type: string
        amount:
          type:
            - number
            - 'null'
          format: double
        creditor:
          type: string
        status:
          type: string
    CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString:
      type: object
      properties:
        maxValue:
          type: string
          description: The maximum value of the score that is provided for the Country.
        minValue:
          type: string
          description: The minimum value of the score that is provided for the Country.
        value:
          type: string
          description: >-
            Local credit score, as used by the supplier in that particular
            country
    CreditsafeGlobalDataReportsConsumerConsumerCreditRating:
      type: object
      properties:
        providerValue:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString
        providerDescription:
          type: string
    CreditsafeGlobalDataCurrency:
      description: >-
        The Currency in which the financial value is displayed, as a
        three-character ISO code.
      enum:
        - AFA
        - ALL
        - DZD
        - ADF
        - ADP
        - AOA
        - ARA
        - ARS
        - AMD
        - AWG
        - AUD
        - AZM
        - BSD
        - BHD
        - BDT
        - BBD
        - BYR
        - BZD
        - BMD
        - BTN
        - BOB
        - BAM
        - BWP
        - BRC
        - BRL
        - GBP
        - BND
        - BGN
        - BIF
        - XOF
        - XAF
        - KHR
        - CAD
        - CVE
        - KYD
        - CLP
        - CNY
        - COP
        - KMF
        - CDF
        - CRC
        - HRK
        - CUP
        - CZK
        - DKK
        - DJF
        - DOP
        - NLG
        - EUR
        - ECS
        - EGP
        - SVC
        - EEK
        - ETB
        - FKP
        - FJD
        - FRF
        - GMD
        - GEL
        - GHC
        - GIP
        - XAU
        - GTQ
        - GNF
        - GWP
        - GYD
        - HTG
        - HNL
        - HKD
        - HUF
        - ISK
        - INR
        - IDR
        - IRR
        - IQD
        - ILS
        - JMD
        - JPY
        - JOD
        - KZT
        - KES
        - KRW
        - KWD
        - KGS
        - LAK
        - LVL
        - LBP
        - LSL
        - LRD
        - LYD
        - LTL
        - MOP
        - MKD
        - MGF
        - MWK
        - MYR
        - MVR
        - MTL
        - MRO
        - MUR
        - MXN
        - MDL
        - MNT
        - MAD
        - MZM
        - MMK
        - ANG
        - NAD
        - NPR
        - NZD
        - NIO
        - NGN
        - KPW
        - NOK
        - OMR
        - PKR
        - XPD
        - PAB
        - PGK
        - PYG
        - PEN
        - PHP
        - XPT
        - PLN
        - QAR
        - RON
        - RUB
        - RWF
        - WST
        - STD
        - SAR
        - RSD
        - SCR
        - SLL
        - XAG
        - SGD
        - SKK
        - SIT
        - SBD
        - SOS
        - ZAR
        - LKR
        - SHP
        - SDD
        - SDG
        - SDP
        - SRD
        - SRG
        - SZL
        - SEK
        - CHF
        - SYP
        - TWD
        - TJS
        - TZS
        - THB
        - TOP
        - TTD
        - TND
        - TRY
        - TMM
        - USD
        - UGX
        - UAG
        - UAK
        - AED
        - UYU
        - UZS
        - VUV
        - VEF
        - VND
        - YUN
        - ZMK
        - ZWD
        - AFN
        - ATS
        - AZN
        - BYN
        - BEF
        - BOV
        - GRD
        - FIM
        - DEM
        - GHS
        - IEP
        - ITL
        - LUF
        - PTE
        - ESP
        - XDR
        - TMT
        - UAH
        - ERN
        - MGA
        - MRU
        - MZN
        - SSP
        - STN
        - YER
        - XPF
        - XCD
        - ZMW
        - ZWL
      type: string
    CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        value:
          type: number
          format: double
          description: >-
            The maximum amount of share capital the company is authorised by its
            constitutional documents to issue to shareholders.
    CreditsafeGlobalDataReportsCommonRatingValue:
      description: Standardised credit score – will be A, B, C, D or E.
      enum:
        - A
        - B
        - C
        - D
        - E
      type: string
    CreditsafeGlobalDataReportsFinancialValue_1_SystemString:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        value:
          type: string
          description: Amount of credit advisable at any one time.
    CreditsafeGlobalDataReportsCreditRating:
      type: object
      properties:
        commonValue:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCommonRatingValue'
        commonDescription:
          type: string
          description: A text description of the common credit score.
        creditLimit:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString
        providerValue:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString
        providerDescription:
          type: string
          description: Local credit score description.
        pod:
          type:
            - number
            - 'null'
          format: double
          description: >-
            Probability of Default (POD) is the anticipated likelihood of
            company default within the next 12 months in a percentage format.
        assessment:
          type: string
          description: An additional score assessment commentary.
    CreditsafeGlobalDataReportsConsumerConsumerCreditScore:
      type: object
      properties:
        currentCreditRating:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating
        currentContractLimit:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        previousCreditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
        latestRatingChangeDate:
          type:
            - string
            - 'null'
          format: date-time
    CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation:
      type: object
    CreditsafeGlobalDataReportsConsumerConsumerReport:
      type: object
      properties:
        language:
          type: string
          description: Language code for the consumer data (e.g., EN, DE).
        consumerInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation
        incomes:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome
        registeredProperty:
          type:
            - integer
            - 'null'
          format: int32
        registeredHousingShare:
          type:
            - integer
            - 'null'
          format: int32
        directorships:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship
        paymentRemarks:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary
        paymentRemarksDetails:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment
        voluntaryPledges:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment
        consumerRating:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore
        additionalInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation
    ConnectErrorResponsesAccessForbidden:
      type: object
      description: 403 - Access Forbidden
      properties:
        message:
          type: string
          example: Access forbidden
    CreditsafeGlobalDataReportsConsumerCsusAddress:
      type: object
      properties:
        type:
          type: string
          description: Type of address (current/former)
        simpleValue:
          type: string
          description: Consumer's full address
        street:
          type: string
          description: Street Name of the Consumer's address
        houseNumber:
          type: string
          description: House Number of the Consumer's address
        city:
          type: string
          description: City of the Consumer's address
        postalCode:
          type: string
          description: ZIP code of the Consumer's address
        province:
          type: string
          description: State of the Consumer's address
        telephoneNumber:
          type: string
          description: Telephone Number of the Consumer
        country:
          type: string
          description: Country of the Consumer's address
        dateFrom:
          type:
            - string
            - 'null'
          format: date-time
          description: Date the Consumer's address was first reported
    CreditsafeGlobalDataReportsConsumerCsusConsumerInformation:
      type: object
      properties:
        name:
          type: string
          description: Full name of the Consumer
        firstName:
          type: string
          description: First name of the Consumer
        middleName:
          type: string
          description: Middle name(s) of the Consumer
        surname:
          type: string
          description: Surname of the Consumer
        age:
          type:
            - integer
            - 'null'
          format: int32
          description: Age of Consumer
        dateOfBirth:
          type:
            - string
            - 'null'
          format: date-time
          description: Consumer's Date of Birth
        gender:
          type: string
          description: Consumer's Gender
        consumerID:
          type: string
          description: Consumer's consumer ID
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress'
    CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating:
      type: object
      properties:
        providerValue:
          type: object
          properties:
            modelNumber:
              type: string
              description: Model Number of the specific scoring model used
            modelName:
              type: string
              description: Name of the scoring model
            value:
              type: string
              description: Actual Credit Score
        providerDescriptions:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Numerical code applied for credit score reasons
              description:
                type: string
                description: >-
                  A commentary that provides reasons behind the credit score
                  produced
    CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra:
      type: object
      properties:
        currentCreditRatings:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating
    CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData:
      type: object
      properties:
        poBox:
          type:
            - boolean
            - 'null'
          description: Indicator that shows if the address is a PO Box
        rentOwnBuy:
          type: string
          description: Rent, Own or Buy flag for the specific address/property
        addressSource:
          type: string
          description: The source of the address
        dateLastReported:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the address was last reported by the Consumer
    CreditsafeGlobalDataReportsConsumerCsusContactAddress:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress'
        - type: object
          properties:
            additionalData:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData
    CreditsafeGlobalDataReportsConsumerCsusContactInformation:
      type: object
      properties:
        mainAddress:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress
        previousAddresses:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress
    CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation:
      type: object
      properties:
        collections:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of collections
        thirtyDayDelinquent:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of payments over due by 30-59 days
        sixtyDayDelinquent:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of payments over due by 60-90 days
        ninetyDayDelinquent:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of payments over due by 90+ days
        chargeOffAccounts:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of accounts that have been charged-off for the Consumer
        bankruptcyAccounts:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of accounts the Consumer has in bankruptcy
        foreclosureAccounts:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of accounts the Consumer has in foreclosure
        vehicleRepossessions:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of vehicle repossessions for the Consumer
        potentialFraud:
          type:
            - boolean
            - 'null'
          description: Potential Fraudulence indicator
    CreditsafeGlobalDataReportsConsumerCsusBankruptcy:
      type: object
      properties:
        customerNumber:
          type: string
          description: The Customer Number assigned to the Consumer
        caseNumber:
          type: string
          description: The Case Number assigned to the bankruptcy
        type:
          type: string
          description: Type of bankruptcy e.g. individual, other etc.
        dateFiled:
          type:
            - string
            - 'null'
          format: date-time
          description: The Date the bankruptcy was filed
        assetAmount:
          type:
            - number
            - 'null'
          format: double
          description: The value of assets that are part of the bankruptcy estate
        exemptAmount:
          type:
            - number
            - 'null'
          format: double
          description: The value of assets that are not part of the bankruptcy estate
        liabilityAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amounts owed to creditors
        filer:
          type: string
          description: The filer of the bankruptcy e.g. Individual, Joint, Spouse etc.
        industryCode:
          type: string
          description: Industry Code
        industryDescription:
          type: string
          description: Industry Description
        comments:
          type: string
          description: Additional Comments relating to the bankruptcy
    CreditsafeGlobalDataReportsConsumerCsusCollection:
      type: object
      properties:
        customerNumber:
          type: string
          description: Customer Number assigned to the collection
        clientNameOrNumber:
          type: string
          description: Client Name or Number
        balance:
          type:
            - number
            - 'null'
          format: double
          description: Amount owed at the time of reporting
        balanceDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Date the balance was last reported
        status:
          type: string
          description: Status of the collection
        statusDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the status was last updated
        dateReported:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the collection was reported
        dateAssigned:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the collection was assigned
        originalAmount:
          type:
            - number
            - 'null'
          format: double
          description: Original Amount owed to the collection agency
        lastActivityDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the collection was last updated
        accountOwner:
          type: string
          description: The creditor that holds legal rights to the collection
        industryCode:
          type: string
          description: Industry Code
        industryDescription:
          type: string
          description: Industry Description
        comments:
          type: string
          description: Additional comments relating to the collection
    CreditsafeGlobalDataReportsConsumerCsusNegativeInformation:
      type: object
      properties:
        potentiallyNegativeInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation
        bankruptcies:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy
        collections:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection
    CreditsafeGlobalDataReportsConsumerCsusMisc:
      type: object
      properties:
        reportDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the report was created
        lastActivityDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the report was last updated
        stateOfIssuance:
          type: string
          description: >-
            The state where a specific document or identifier was issued for the
            Consumer
        yearOfIssuance:
          type: string
          description: >-
            The year when a specific document or identifier was issued for the
            Consumer
        subjectSSN:
          type: string
          description: The Consumer's person number
        ssnMatch:
          type: string
          description: Verifies that the person number is linked to the Consumer
        referralCode:
          type: string
          description: Referral Code
        reportOnFileSince:
          type:
            - string
            - 'null'
          format: date-time
          description: Date the report was first created at the credit bureau
        dateOfBirth:
          type:
            - string
            - 'null'
          format: date-time
          description: Date of Birth
        deceasedDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Deceased Date
        hitCode:
          type: string
          description: Hit Code
        hitCodeDescription:
          type: string
          description: Hit Code Description
        addressDiscrepancyIndicator:
          type: string
          description: >-
            Identifies discrepancies in the addresses on file compared to
            addresses reported by lenders/creditors
        fraudVictimAlert:
          type: string
          description: Fraud Victim Alert Code
        fraudVictimAlertDescription:
          type: string
          description: Fraud Victim Alert Description
        inquiriesWithin2Years:
          type:
            - integer
            - 'null'
          format: int32
          description: Number of inquiries within the last 2 years
        ofac:
          type:
            - integer
            - 'null'
          format: int32
          description: Office of Foreign Assets Control indicator
        ssnAffirm:
          type: string
          description: SSN affirm Yes/No
        identityScanAlert:
          type: string
          description: Flags any potential discrepancies in the Consumer's identification
        ecoaInquiryType:
          type: string
          description: Equal Credit Opportunity Act inquiry type
        frozenFile:
          type:
            - boolean
            - 'null'
          description: Advises if the Consumer's credit file is frozen
        lockAlert:
          type:
            - boolean
            - 'null'
          description: Advises if the Consumer's credit file is locked
        mlaStatus:
          type: string
          description: Advises if the Consumer is covered under the military lending act
    CreditsafeGlobalDataReportsConsumerCsusSearchCriteria:
      type: object
      properties:
        identifier:
          type: string
          description: Identifier
        nameIdentifier:
          type: string
          description: Name identifier e.g. current etc.
        firstName:
          type: string
          description: The First Name used in the search criteria
        lastName:
          type: string
          description: The Last Name used in the search criteria
        dateOfBirth:
          type:
            - string
            - 'null'
          format: date-time
          description: The Date of Birth used in the search criteria
        socialSecurityNumber:
          type: string
          description: The person number used in the search criteria
        addressSource:
          type: string
          description: Address Source
        addressStatus:
          type: string
          description: Address Status e.g. current, former etc.
        addressLine1:
          type: string
          description: First line of the address used in the search criteria
        city:
          type: string
          description: The City used in the search criteria
        state:
          type: string
          description: The State used in the search criteria
        zip:
          type: string
          description: The Zip used in the search criteria
        country:
          type: string
          description: The Country the address is domiciled
    CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary:
      type: object
      properties:
        accountType:
          type: string
          description: Account types Revolving, Installment, Others and Totals
        summary:
          type: object
          properties:
            accounts:
              type: string
              description: Total number of accounts on file per account type
            balance:
              type: string
              description: Balance due on file per account type
            creditAvailable:
              type: string
              description: Total Credit Available per account type
            pastDue:
              type: string
              description: Total Number of days past due per account type
            termsOfPayment:
              type: string
              description: Total Terms of payment in month per account type
    CreditsafeGlobalDataReportsConsumerCsusTradeLine:
      type: object
      properties:
        customerAccountNumber:
          type: string
          description: The customer account number for the trade line
        customerNumber:
          type: string
          description: The customer number for the trade line
        accountOwner:
          type: string
          description: The account owner, name of the lender/creditor
        customerName:
          type: string
          description: The customer name
        balance:
          type: string
          description: Balance remaining on the trade line
        pastDue:
          type: string
          description: Number of payments past due on the trade line
        thirtyDayCounter:
          type: string
          description: >-
            Number of times the Consumer has been late on a payment by 30-59
            days on the trade line
        sixtyDayCounter:
          type: string
          description: >-
            Number of times the Consumer has been late on a payment by 60-90
            days on the trade line
        ninetyDayCounter:
          type: string
          description: >-
            Number of times the Consumer has been late on a payment by more than
            90 days on the trade line
        highCredit:
          type: string
          description: The high credit for the trade line (often the credit limit)
        accountType:
          type: string
          description: >-
            The trade line's account type e.g. Revolving, Installment, Other
            etc.
        monthsReviewed:
          type: string
          description: Number of months the trade line has been reviewed
        statusCode:
          type: string
          description: The status code of the trade line
        status:
          type: string
          description: The status of the trade line
        dateOpened:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the trade line was first opened
        dateReported:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the trade line was first reported
        dateOfLastActivity:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the trade line was last updated
        terms:
          type: string
          description: Payment terms of the trade line
        comments:
          type: array
          items:
            type: string
          description: Additional comments relating to the trade line
    CreditsafeGlobalDataReportsConsumerCsusFormerName:
      type: object
      properties:
        firstName:
          type: string
          description: First name of the former reported name for the Consumer
        middleName:
          type: string
          description: Middle name of the former reported name for the Consumer
        lastName:
          type: string
          description: Last name of the former reported name for the Consumer
        suffix:
          type: string
          description: Suffix of the former reported name for the Consumer
    CreditsafeGlobalDataReportsConsumerCsusEmployment:
      type: object
      properties:
        employmentStatus:
          type: string
          description: The status of the reported employment e.g. Current, Former etc.
        employerName:
          type: string
          description: The employer for the listed employment
        occupation:
          type: string
          description: >-
            The occupation or job title of the Consumer during the listed
            employment
    CreditsafeGlobalDataReportsConsumerCsusConsumerStatement:
      type: object
      properties:
        dateReported:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the statement was reported
        datePurged:
          type:
            - string
            - 'null'
          format: date-time
          description: Date the statement was purged
        statement:
          type: string
          description: Free text containing the statement of the Consumer
    CreditsafeGlobalDataReportsConsumerCsusAlertContact:
      type: object
      properties:
        alertType:
          type: string
          description: >-
            The type of alert reported on the Consumer e.g. Extended Fraud,
            Initial Fraud etc.
        dateReported:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the alert was reported
        dateEffective:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the alert was effective from
        status:
          type: string
          description: The status of the alert
        address:
          type: object
          properties:
            street:
              type: string
              description: Street of the listed address of the contact
            city:
              type: string
              description: City of the listed address of the contact
            province:
              type: string
              description: Province of the listed address of the contact
            postalCode:
              type: string
              description: Postal/Zip of the listed address of the contact
            additionalInformation:
              type: string
              description: Any additional data for the listed address of the contact
        telephoneNumbers:
          type: array
          items:
            type: object
            properties:
              telephoneNumberType:
                type: string
                description: >-
                  The type of telephone number e.g. Cellular, Pager, Daytime
                  etc.
              countryCode:
                type: string
                description: The country code for the contact telephone number
              telephoneNumber:
                type: string
                description: The reported telephone number for the contact
              extension:
                type: string
                description: The extension of the contact
    CreditsafeGlobalDataReportsConsumerCsusInquiry:
      type: object
      properties:
        customerName:
          type: string
          description: The name of the customer that initiated the inquiry
        customerNumber:
          type: string
          description: The designated ID of the customer that initiated the inquiry
        dateOfInquiry:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the inquiry was carried out
        foreignInquiry:
          type:
            - boolean
            - 'null'
          description: Foreign inquiry indicator, true/false
    CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation:
      type: object
      properties:
        misc:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc'
        searchCriteria:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria
        activeAccountDetailsSummary:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary
        tradeLines:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine
        formerNames:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName
        employments:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment
        consumerStatements:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement
        alertContacts:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact
        inquiries:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry
    CreditsafeGlobalDataReportsConsumerCsusConsumerReport:
      type: object
      description: Consumer Report response
      properties:
        language:
          type: string
          description: Report language code
        consumerInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation
        creditScoreExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra
        contactInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation
        negativeInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation
        additionalInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation
    CreditsafeGlobalDataReportsConsumerCsusTryReportResponse:
      type: object
      properties:
        correlationId:
          type: string
        report:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport
        dateOfOrder:
          type: string
          format: date-time
        language:
          type: string
        userId:
          type: string
security:
  - bearerToken: []
