Documentation

Getting a List of Documents from Catalogue

Identify the reports that can be requested for a business in a Country

Suggest Edits

You can get a list of available registry files for a business that can be retrieved. You will need the entityId returned in the response to retrieve the business profile call.

Retrieve a list of available reports using the /business/{{enitityId}}/list endpoint.

  1. In the example above, replace YOUR_CUSTOMER_ID with your Customer ID and YOUR_API_Key with your API key provided by FrankieOne.
  2. You need to also replace the "entityid" in the URL param to the entity ID of the business that you need the registry documents for

⚠

️ Call Out

For companies with a substantial list of reports that can be fetched this endpoint can take more than 30 seconds to respond, so we suggest allowing up to 120 seconds before timing out.

curl --request POST \
     --url https://api.demo.frankiefinancial.io/compliance/v1.2/business/entityid/list \
     --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \
     --header 'api_key: YOUR_API_KEY'
     --header 'content-type: application/json' \

The response includes a series of reports that are available for the specifically requested business. Listing the reports most likely will return multiple matches. Each report will have a specific report code. Identify the report that needs to be requested and extract the reportCode. You will need it while requesting the actual report.

{
    "reports": [
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHON_Q0hfQ29tcGFueU1vcnRnYWdlc18x_U0MyMDU4NzA=",
            "reportTitle": "Company Mortgages"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHON_Q0hfQ29tcGFueU9mZmljaWFsc18x_U0MyMDU4NzA=",
            "reportTitle": "Company Officials"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHON_Q0hfQ29tcGFueVByb2ZpbGVfMQ==_U0MyMDU4NzA=",
            "reportTitle": "Company Profile"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_KipDb25maXJtYXRpb24gc3RhdGVtZW50KiogbWFkZSBvbiAyMDIyLTAyLTI3IHdpdGggbm8gdXBkYXRlcw==_U0MyMDU4NzA=_UFl5aWlPNW1MMENQREdKc01YUWZpdjZsbGhQeTFsNG9oSF9wdjU2U21OQQ==",
            "reportTitle": "**Confirmation statement** made on 2022-02-27 with no updates"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_KipEaXJlY3RvcidzIGRldGFpbHMgY2hhbmdlZCoqIGZvciBLZWl0aCBEYW1pYW4gUGVyZWlyYSBvbiAyMDIxLTA5LTA3_U0MyMDU4NzA=_N0VJaXUxb052U1ctZHVHOFY5ZXpaZVpiZ0QwRTdRTXpHVUZJZUF0N0hXYw==",
            "reportTitle": "**Director's details changed** for Keith Damian Pereira on 2021-09-07"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_KipEaXJlY3RvcidzIGRldGFpbHMgY2hhbmdlZCoqIGZvciBMdWtlIEVzcm9tIFJvYmVydHMgb24gMjAyMS0wOS0wNw==_U0MyMDU4NzA=_bnljZzJxa29ERU9oNVRZcmdyWTdhZ210VWl3MnpEaEtOb19QcHJhUVpZSQ==",
            "reportTitle": "**Director's details changed** for Luke Esrom Roberts on 2021-09-07"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_KipGdWxsIGFjY291bnRzKiogbWFkZSB1cCB0byAyMDIwLTEyLTMx_U0MyMDU4NzA=_a2hfdkk3V0JyakpYVVpsU0w4dHE5bTAxRzZZUWV2UVlqc0tJT2dVZVI2Zw==",
            "reportTitle": "**Full accounts** made up to 2020-12-31"
        },
        
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_RGlyZWN0b3IgcmVzaWduZWQ=_U0MyMDU4NzA=_ZkpDZWtKWEJ6MEhoaWx6b3htSFpEck9jYXBpYk5NejhpMFFOR2tDMnp0Yw==",
            "reportTitle": "Director resigned"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_U2VjcmV0YXJ5J3MgcGFydGljdWxhcnMgY2hhbmdlZA==_U0MyMDU4NzA=_WXhMc3ZOUmJ1em1ja1RqWGFZejN6bWZzUXo5UWM4bmVHMGlBX2pfeDFrZw==",
            "reportTitle": "Secretary's particulars changed"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_RGlyZWN0b3IgcmVzaWduZWQ=_U0MyMDU4NzA=_clo3ZW91UVNJMS1ncG0xWnZQakJTSlNUT1R3aU1qNFhCaEFaak11R2dfSQ==",
            "reportTitle": "Director resigned"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_TmV3IHNlY3JldGFyeSBhcHBvaW50ZWQ=_U0MyMDU4NzA=_R1diZUpRaldkTkNLeWxPZnBjajJ3MzB5Zk14eE1HclZlRkZ6VnRzNUhIUQ==",
            "reportTitle": "New secretary appointed"
        },
        {
            "availableFormats": "PDF",
            "provider": "{{provider}}",
            "reportCode": "CHOFF_R0JfQ0hfRE9D_U2VjcmV0YXJ5IHJlc2lnbmVk_U0MyMDU4NzA=_eDVMMWR6aXdlczVRcWtkdEQxenlRaGZGS1Z5Z0h0RlQ1N0E3TGdJSTlNYw==",
            "reportTitle": "Secretary resigned"
        }
    ],
    "entityId": "ceeba882-e72f-54a5-5145-2f7840411836",
    "requestId": "01G12HZSC26HD0H2DAKDGXYTXW"
}

Extract a Report Code

👍

What is the Report Code used for ?

The report code returned above is required for requesting the specific report. The report code signifies a specific report on the Provider end.

There are multiple reports that can be requested for a specific business the following step will need to be done for each of the reports that need to be requested.
For example, extract the report code for the first report available:

const reportCode = response['reports'][0]['reportCode']

Updated about 1 year ago