Supporting documents

This API endpoint makes an HTTP GET request to retrieve the documentation for a specific beneficial ownership registration by statement ID.

The response will include an array of documents with details such as documentation ID, registration ID, reference number, content type, created date, document type description, document status description, and document name. Additionally, the response will contain an array of links with their respective relation and href. To "Add documentation", further details about the specific requirements for adding documentation would be needed.

supporting-documents

get

Get supporting document by entity statement id

Authorizations

apiKeyHeaderapiKeyQuery

Path parameters

entitystatementidinteger · enumRequired

Entity Id of the registered beneficial ownership registration

Possible values:

Responses

200

Success

application/json

401

Unauthorised

application/json

404

Resource Not Found

get

HTTPcURLJavaScriptPython

GET /sandbox/boreg/register/files/{entitystatementid} HTTP/1.1
Host: cipc-apm-rs-dev.azure-api.net
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "documents": [
    {
      "bodocumentationid": 242,
      "boregid": 4,
      "referencenumber": "60000707734",
      "contenttype": "application/pdf",
      "createddate": "2023-04-15T21:44:19.0000000+00:00",
      "documenttypedesc": "OTHER",
      "documentstatusdesc": "ACTIVE",
      "documentname": "COR14.3 (1).pdf"
    },
    {
      "bodocumentationid": 362,
      "boregid": 4,
      "referencenumber": "60000709767",
      "contenttype": "application/pdf",
      "createddate": "2023-04-25T09:05:57.0000000+00:00",
      "documenttypedesc": "OTHER",
      "documentstatusdesc": "ACTIVE",
      "documentname": "Welcome Letter.pdf"
    },
    {
      "bodocumentationid": 387,
      "boregid": 4,
      "referencenumber": "60000710168",
      "contenttype": "application/pdf",
      "createddate": "2023-04-26T14:22:26.0000000+00:00",
      "documenttypedesc": "OTHER",
      "documentstatusdesc": "ACTIVE",
      "documentname": "beb12ca9-c3a6-4be4-a1c5-4fab975b5fda (1).pdf"
    },
    {
      "bodocumentationid": 563,
      "boregid": 4,
      "referencenumber": "60000712633",
      "contenttype": "application/pdf",
      "createddate": "2023-05-11T09:35:38.0000000+00:00",
      "documenttypedesc": "OTHER",
      "documentstatusdesc": "ACTIVE",
      "documentname": "2022-09-16 - CoR39 (BR Address accepted but not changed).pdf"
    },
    {
      "bodocumentationid": 346,
      "boregid": 4,
      "referencenumber": "60000709681",
      "contenttype": "application/pdf",
      "createddate": "2023-04-24T16:12:14.0000000+00:00",
      "documenttypedesc": "OTHER",
      "documentstatusdesc": "ACTIVE",
      "documentname": "Share certificate.pdf"
    }
  ],
  "links": [
    {
      "rel": "collection",
      "href": "/register/files/"
    }
  ]
}