Entities: Missing business information in the business query from NameX.

[eve-git]

Namex has the following two queries from entities:

1. get businesses
   ("ENTITY_SVC_URL")}/businesses/{corp_num}

2. get corp from colin
   ("COLIN_SVC_URL")}/businesses/{corp_num}/public

the following info should be returned to make name-examination run properly:

BC CORP: {'identifier': corp_num,
          'incorporated': incorp_date_str,
          'directors': incorp_directors_list,
          'registered office delivery address': incorp_registered_addr_list,
          'records office delivery address': incorp_records_addr_list,
          'jurisdiction': 'BC',
          'nature of business': incorp_nob
}

XPRO CORP: {'identifier': corp_num,
			'incorporated': incorp_date_str,
            'directors': incorp_directors_list,
            'attorney names': incorp_attorneys_list,
            'head office': incorp_ho_addr_list,
            'jurisdiction': incorp_jurisdiction,
            'nature of business': incorp_nob
}

for example:

XPRO CORP:{
    "directors": "Not Available",
    "incorp #": "XS1000661",
    "incorporated": "2016-12-08",
    "jurisdiction": "BC",
    "nature of business": "Not Available",
    "records office delivery address": "Not Available",
    "registered office delivery address": [
        "VICTORIA",
        "BC",
        "CA",
        "V8Y 3B6"
    ]
}

[ozamani9gh]

Omid to discuss with @severinbeauvais about who should complete work.

[severinbeauvais]

We should talk about what you need. I see you want directors and addresses in the business response -- but we have separate endpoints for that already. As for the COLIN call, I haven't confirmed that COLIN provides all the information you want.

cc: @vysakh-menon-aot

[severinbeauvais]

Also, when do you need this by?

[vysakh-menon-aot]

public endpoint in colin is intent to provide the basic details of business.

I could see few endpoints, lear is not using these (but not sure if someone is using these). you can try if it works
get party https://github.com/bcgov/lear/blob/main/colin-api/src/colin_api/resources/parties.py
get office https://github.com/bcgov/lear/blob/main/colin-api/src/colin_api/resources/office.py

[eve-git]

@vysakh-menon-aot The links provided above might work, but they require the 'colin' role for access. Namex accesses public business information through:

f'{current_app.config.get("COLIN_SVC_URL")}/businesses/{corp_num}/public

Is it possible to make the parties and offices endpoints publicly accessible in a similar way?

[severinbeauvais]

@eve-git , you are right: the parties and office endpoints require the "COLIN_SVC_ROLE", while the public endpoint just requires an auth token.

@vysakh-menon-aot , is there any reason to not change parties and office to match public?

@OlgaPotiagalova Maybe we do need some changes to our COLIN API for this.

[vysakh-menon-aot]

If we change similar to public anyone who logged in to registries can access other business parties and offices (which i don't think is right)

[severinbeauvais]

Good point. What's the alternative?

Could the Namex API use a JWT with the COLIN role?

[vysakh-menon-aot]

Yes. @eve-git use entity-service-account jwt token

[eve-git]

The HEAD Office information for expo companies is still missing from the Colin-API.
@Mihai-QuickSilverDev @ozamani9gh could we consult with the business to see if the requirement for the information can be delayed, allowing Entities having time to update the code.

[severinbeauvais]

Eve:

[severinbeauvais]

Eve, do you know for sure that the Head Office Information for xpro companies is available in COLIN?

And, are you planning to update COLIN API code or do you need Entities Team to do it?

cc: @OlgaPotiagalova

[eve-git]

The head office is for xpro company only. It is available in COLIN.

Perhaps we could add a general service, such as retrieving parties/all, to gather all office information.
@severinbeauvais I think it would be better for Entities to work on this. However, if you don't have time, I am available to do it.

[severinbeauvais]

@vysakh-menon-aot Any thoughts on what we should do here?

• create a new endpoint?
• add missing data to existing endpoint?
• Olga's team does the work?
• Eve does the work?

@eve-git , when do you need this by ???

[eve-git]

Since the missing information doesn't break the app, @ozamani9gh will consult with the business team to determine if the issue needs immediate attention. In the meantime, I will create a new ticket to address the issue, allowing this ticket to proceed with testing.

[eve-git]

deployed to both dev and test

[eve-git]

Testing

In Name Examination:

1. Edit Request and Validate Corp Number:

   • Open an NR and click Edit Request.
   • Change the request type to Change of Name or others that a corp number is required.
   • Verify that the corp number validation works correctly by saving edit.

2. Verify Conflict Name Details:

   • Open an NR and observe the Conflicts of Name section.
   • Ensure that companies with conflicting names appear under Exact Match or Exact Word Order + Synonym Match.
   • Click on a company number and verify:
     • The company information is correctly retrieved.
     • The app does not crash.

In Name Request:

• For Name Request types Change Name or Reactivate a Company, ensure that:
  • A company number must be entered.
  • The entered company number is validated correctly.

Please verify that all the above functionality works as expected.

[gunanagar]

Tested

Edit Request and Validate Corp Number:

Open an NR and click Edit Request.
Change the request type to Change of Name or others that a corp number is required.
Verify that the corp number validation works correctly by saving edit.

[gunanagar]

Verify Conflict Name Details: - PASS

Open an NR and observe the Conflicts of Name section.
Ensure that companies with conflicting names appear under Exact Match or Exact Word Order + Synonym Match.
Click on a company number and verify:
The company information is correctly retrieved.
The app does not crash.

[gunanagar]

In Name Request: - PASS

For Name Request types Change Name or Reactivate a Company, ensure that:
A company number must be entered.
The entered company number is validated correctly.

Invalid

Valid