Compliance GX Tagus Release V2 Api | Integrate the Gaia-X Clearinghouse Interface

[tfjanjua]

Description

Integrate the V2 api from Gaia-X Tagus release in company onboarding and SD document creation.

Gaia-X has released the V2 api in Tagus release which have changes in request and response interfaces.
So portal backend have to adapt these new changes.

This new version have more flexibility from Gaia-X perspective and Portal BE must switch to new api for correct data validation for companies onboarding and Sd document creation.

Currently Portal BE is using V1 api from Gaia-X

Acceptance Criteria

• Portal backend would need to analyse the V2 api from Gaia-X and then integrate the changes in backend code for new interfaces.
• Company onboarding should be successful by using V2 api from clearing house.

Test Cases

Test Case 1:  Verify the Company Onboarding Clearing house with valid VAT_ID 
  
Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid & real VAT_ID 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should process the data successfully. 
  
 
Test Case 2: Verify the Company Onboarding Clearing house with invalid VAT_ID 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with invalid VAT_ID 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should not process the data successfully. 
  

Test Case 3: Company Onboarding with valid Commercial Registration identifier. 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid & real Commercial registration number 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should process the data successfully. 
 

Test Case 4: Company Onboarding with invalid Commercial Registration identifier 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with invalid/fake Commercial registration number 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should not process the data successfully. 
 

Test Case 5: Company Onboarding with valid LEI code 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid Legal Entity Identifier (LEI) 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should process the data successfully. 
 

Test Case 6: Company Onboarding with invalid LEI code 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with invalid Legal Entity Identifier (LEI) 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should not process the data successfully. 
 
 
Test Case 7: Company Onboarding with valid EORI 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid EORI 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should process the data successfully. 
 

Test Case 8: Company Onboarding with invalid EORI 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with invalid EORI 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 
Clearing house should not process the data successfully. 
 

Test Case 9: Ensure the SD factory processed through successfully 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid identifer(s) 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 

• Clearing house should process the data successfully. 
• SD Factory process thorugh successfully and generate SD document 
   

Test Case 10: Ensure Company Onboarding for Non-European Companies 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid local identifer(s) for Non-European countries /companies e.g: Korea, China, Japan, USA 
• Submit registration data 
• Observe Company Onboarding process 

Expected Results: 

• Clearing house should process the data successfully. 
• SD Factory process thorugh successfully and generate SD document 
   

Test Case 11: Verify the Connector Registration for newly Onboarded Companies 

Test Steps: 

• Invite a Business Partner 
• Accept invite as invited Customer 
• Start with registration process 
• Fill out all registration details with valid identifer(s) 
• Submit registration data 
• Observe Company Onboarding process 
• Once the company gets Onboarded--> Login → Navigate to “Connector Registration“ 
• Create OWN Connector-->Fill in details → Confirm 

Expected Results: 

• Connector creation status should be “ACTIVE“ 
• SD document should be available 
   

Test Case 12: Verify the Connector Registration for existing Onboarded Companies 

Test Steps: 

• Login to any already onboarded existing company 
• Navigate to “Connector Registration“ 
• Create OWN Connector-->Fill in details → Confirm 

Expected Results: 

• Connector creation status should be “ACTIVE“ 
• SD document should be available 
   
  Please follow the link for more Test cases: Compliance GX Tagus Release V2 Api | Integrate the Gaia-X Clearinghouse Interface #1217 (comment)

Corresponding Release Ticket

eclipse-tractusx/sig-release#993

Updated Request

curl --location '{BASE_URL}/api/v2/validation/' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--data '{
    "legalEntity": {
        "legalName": "T-Systems International GmbH",
        "address": {
            "country": "DE",
            "region": "DE-NRW",
            "locality": "Bonn",
            "postalCode": "53113",
            "addressLine": "Friedrich-Ebert-Allee 140"
        },
        "identifiers": [
            { "type": "schema:vatID", "value": "DE118645675" },
            { "type": "schema:leiCode", "value": "5299004XPX8GS3AHAV34" }
        ]
    },
    "validationMode": "LEGAL_NAME",
    "callback": {
        "url": "https://example.com",
        "headers": {
            "X-Consumer-ExternalId": "32185be6-8c1c-4056-877e-5d2bb5db3048"
        }
    }
}'

Updated Response

{
    "id": "1489f4d0-6e75-4ba2-9b29-507ce4c90596",
    "status": "COMPLETED",
    "validationMode": "LEGAL_NAME",
    "validationUnits": [
        {
            "result": "VALID",
            "type": "schema:leiCode",
            "extractedLegalEntity": {
                "legalName": "T-Systems International GmbH",
                "address": {
                    "country": "DE",
                    "region": "DE-HE",
                    "locality": "Frankfurt am Main",
                    "postalCode": "60528",
                    "addressLine": "Hahnstraße 43 d"
                }
            },
            "executedAt": "2024-09-02T19:18:52.694466"
        },
        {
                "result": "INVALID",
                "type": "schema:vatID",
                "value": "DE118645675",
                "reason": {
                    "message": "Unable to process the request",
                    "code": "E2814",
                    "detailMessage": "E2101:VatID not found"
                },
                "executedAt": "2024-09-02T19:18:52.694466"
         }
    ]
}

[dorkabcox]

From Cofinity-X side we agree the strictness levels/"validationMode" is the ideal way to go with, however there are instances where complete override might still be necessary. We would like the option to be there, and not use it unless absolutely needed.
Regarding manual validation in case automated process fails, further refinement of the process will take place on the 23rd January among Cofinity-X and the GXDCH provider, of which we'll provide update.

One example for clear necessity recently: Issue in the formatting of the legal entity identifiers / spelling errors

thyssenkrupp Automotive Systems GmbH - spelling
While the provided commercial registration number, HRB 19873, is indeed valid, it is associated with an organization called ThyssenKrupp Automotive Systems GmbH, which was also seen on the screenshot of the German Commercial Register provided. While it was all clear that these both refer to the same legal entity and the difference is minimal (T and K being uppercase), Clearing House requires a strict match to claim the legal entity is valid.

Please let me know if further info is desired! :) @evegufy @MaximilianHauer

[evegufy]

Jan 23, Portal Open Meeting: after some further explanation @MaximilianHauer and we are fine to keep the overwrite function.