> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inyett.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get warnings for a external batch

> Returns the current analysis status for a submitted payment batch, along with any warnings (e.g. sanctions or fraud indications) raised for its transactions so far.



## OpenAPI

````yaml https://api-test.inyett.com/swagger/v3/swagger.json get /3/{profileCountry}/payment-control/batches/{externalBatchId}/warnings
openapi: 3.0.4
info:
  title: Inyett Automation
  description: |-
    <p>Inyett Automation is a payment control and company screening API for
                        Swedish and Norwegian businesses. It lets integrators automatically check a company's
                        status and risk before doing business with it, monitor companies over time for changes,
                        and screen outgoing payment batches for anomalies, sanctions and compliance issues before
                        the money leaves the paying customer. It is used by ERP, payment and procurement systems
                        that need this control built into their own workflows rather than as a manual step.</p><h3>How to connect</h3>
                        <p>Read more about our API and how to connect on <a href='https://docs.inyett.com/home' target='_blank'>docs.inyett.com</a></p> 
  contact:
    email: support@inyett.com
  version: '3.0'
servers: []
security:
  - X-Api-Key: []
  - Bearer: []
tags:
  - name: Inyett Company Control
    description: >-
      Risk assessment endpoints such as main rating, fraud, debt and payment
      remark checks, used to screen a company before paying it.
  - name: Inyett Company Data
    description: >-
      Company master data: addresses, accounts, owners, directors, financial
      statements and other registry information for a company.
  - name: Inyett Company Debts & Credits
    description: >-
      Aggregated debt and credit information for a company, including historical
      claims and payment remarks.
  - name: Inyett Company Find
    description: Free-text and organisation-number search for companies.
  - name: Inyett Company Insights
    description: >-
      The company relation graph: companies related to a given company, grouped
      by relation category (tag).
  - name: Inyett Company Monitor
    description: >-
      Continuous monitoring of company portfolios: create portfolios, add or
      remove companies to watch, and read back detected changes over time.
  - name: Inyett Payment Control
    description: >-
      Batch screening of outgoing payments: submit a payment batch for analysis
      and read back any warnings before the money leaves the customer.
paths:
  /3/{profileCountry}/payment-control/batches/{externalBatchId}/warnings:
    get:
      tags:
        - Inyett Payment Control
      summary: Get warnings for a external batch
      description: >-
        Returns the current analysis status for a submitted payment batch, along
        with any warnings (e.g. sanctions or fraud indications) raised for its
        transactions so far.
      operationId: paymentControlWarningsGetBatchIndications
      parameters:
        - name: profileCountry
          in: path
          description: >-
            The country whose scope/entitlement profile (SE or NO) is used to
            authorize the request. Determines which market-specific rules apply,
            independent of the country the requested company is registered in.
          required: true
          schema:
            $ref: '#/components/schemas/Country'
        - name: externalBatchId
          in: path
          description: >-
            The caller-supplied identifier for the payment batch, used to
            correlate it with earlier submissions and results.
          required: true
          schema:
            type: string
        - name: languageCode
          in: query
          description: >-
            Language used for human-readable text in the response (e.g. check
            descriptions).
          schema:
            $ref: '#/components/schemas/LanguageCode'
        - name: AppId
          in: header
          description: App id
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AnalyzeResult'
              example:
                analyzeStatus: Done
                batchUrl: https://example.com
                warnings:
                  - id: 12345
                    transactionExternalId: '123456'
                    type:
                      type: FooBar
                      category: Transaction
                    name: Foo
                    description: Lorem ipsum dolor sit amet
                    warningUrl: https://example.com
                    status: CompletedWithAction
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyzeResult'
              example:
                analyzeStatus: Done
                batchUrl: https://example.com
                warnings:
                  - id: 12345
                    transactionExternalId: '123456'
                    type:
                      type: FooBar
                      category: Transaction
                    name: Foo
                    description: Lorem ipsum dolor sit amet
                    warningUrl: https://example.com
                    status: CompletedWithAction
            text/json:
              schema:
                $ref: '#/components/schemas/AnalyzeResult'
              example:
                analyzeStatus: Done
                batchUrl: https://example.com
                warnings:
                  - id: 12345
                    transactionExternalId: '123456'
                    type:
                      type: FooBar
                      category: Transaction
                    name: Foo
                    description: Lorem ipsum dolor sit amet
                    warningUrl: https://example.com
                    status: CompletedWithAction
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FailResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FailResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
components:
  schemas:
    Country:
      enum:
        - SE
        - 'NO'
      type: string
      description: >-
        ISO country code supported for company lookups: SE (Sweden) or NO
        (Norway).
    LanguageCode:
      enum:
        - SV
        - 'NO'
        - EN
      type: string
      description: >-
        Language used for human-readable text in a response: SV (Swedish), NO
        (Norwegian) or EN (English).
    AnalyzeResult:
      type: object
      properties:
        analyzeStatus:
          type: string
          nullable: true
        batchUrl:
          type: string
          nullable: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Warning'
          nullable: true
      additionalProperties: false
      description: >-
        The current analysis status of a submitted payment batch, including any
        warnings raised so far.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
      description: >-
        A machine-readable error response following the RFC 7807 Problem Details
        format.
    FailResponse:
      type: object
      properties:
        message:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        Error response returned when a request fails, containing a
        human-readable message.
    Warning:
      type: object
      properties:
        id:
          type: integer
          format: int32
        transactionExternalId:
          type: string
          nullable: true
        type:
          $ref: '#/components/schemas/WarningType'
        name:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        warningUrl:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/WarningStatus'
      additionalProperties: false
      description: >-
        A warning raised while analyzing a payment batch transaction, e.g. a
        sanctions or fraud indication.
    WarningType:
      type: object
      properties:
        type:
          type: string
          nullable: true
        category:
          type: string
          nullable: true
      additionalProperties: false
      description: The category and sub-category of a payment batch warning.
    WarningStatus:
      enum:
        - NotProcessed
        - Active
        - Completed
        - CompletedWithAction
        - Unknown
      type: string
      description: Processing status of a payment batch warning.
  securitySchemes:
    X-Api-Key:
      type: apiKey
      description: 'Api key needed to access the endpoints. X-Api-Key: My api key'
      name: X-Api-Key
      in: header
    Bearer:
      type: http
      description: Please enter a valid token
      scheme: Bearer
      bearerFormat: JWT

````