Polish Whitelist (VAT)

What kind of data I will get

By using this integration, you will get information about VAT status of company. This data will be taken from the government data register.

Input data definition

To get result, you can pass NIP or Account number as an input.

{
  "nip": "1580056873"
}

{
  "accountNumber": "37928400055119019661627633"
}

Output data

In the response from Polish Whitelist, you will find information about the company, its VAT status and company account numbers.

{
  "polishWhiteBook" : {
    "requestId" : "KdGcs-8fjfjd9",
    "requestDateTime" : "09-06-2020 16:38:57",
    "details" : [ {
      "name" : "RAFAŁ MALARCZYK",
      "nip" : "1580056873",
      "statusVat" : "ACTIVE",
      "regon" : "855193920",
      "residenceAddress" : "JODŁOWA 51, 28-500 MŁAWA",
      "representatives" : [ ],
      "authorizedClerks" : [ ],
      "partners" : [ ],
      "registrationLegalDate" : "2014-09-01",
      "registrationDenial" : { },
      "restoration" : { },
      "removal" : { },
      "accountNumbers" : [ "37928400055119019661627633", "24800200040882909458077296" ],
      "hasVirtualAccounts" : false
    } ]
  }
}

Output data model structure

A detailed description of the response structure using the swagger standard.

openapi: 3.0.1
info:
  title: Transactionlink Whitelist App model definition
  version: "1.0.0"
paths: {}
components:
  schemas:
    whitebook:
      type: object
      properties:
        requestId:
          type: string
          example: 'KqGcs-8fjfjd9'
        requestDateTime:
          type: string
          format: data-time
          example: '09-06-2022 16:38:57'
        details:
          type: object
          properties:
            name:
              type: string
              example: 'ADAM SŁODOWY'
            nip:
              type: string
              example: '1580056873'
            statusVat:
              type: string
              enum:
                - ACTIVE
                - RELEASED
                - UNREGISTERED
            regon:
              type: string
              example: '855193920'
            pesel:
              type: string
              example: '19292444689'
            krs:
              type: string
              example: '0000843971'
            residenceAddress:
              type: string
              example: 'JODŁOWA 51, 28-500 MŁAWA'
            workingAddress:
              type: string
              example: 'JODŁOWA 22, 28-500 MŁAWA'
            representatives:
              type: array
              items:
                $ref: '#/components/schemas/Person'
            authorizedClerks:
              type: array
              items:
                $ref: '#/components/schemas/Person'
            partners:
              type: array
              items:
                $ref: '#/components/schemas/Person'
            registrationLegalDate:
              type: string
              format: date
              example: '2015-09-01'
            registrationDenial:
              type: object
              properties:
                registrationDenialBasis:
                  type: string
                registrationDenialDate:
                  type: string
                  format: date
            restoration:
              type: object
              properties:
                restorationBasis:
                  type: string
                restorationDate:
                  type: string
                  format: date
            removal:
              type: object
              properties:
                removalBasis:
                  type: string
                removalnDate:
                  type: string
                  format: date
            accountNumbers:
              type: array
              items:
                type: string
            hasVirtualAccounts:
              type: boolean
    Person:
      type: object
      properties:
        companyName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        pesel:
          type: string
        nip:
          type: string