From 7faf41fb9b7fa9f71b5496b1177ede6c1780d1c5 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Wed, 19 Jul 2023 23:10:54 +0100 Subject: [PATCH 01/31] Create ReadME.md Created Financial Conduct Authority (FCA) UK Connector folder and ReadME file underneath --- .../ReadME.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md new file mode 100644 index 0000000000..729e3bcd08 --- /dev/null +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md @@ -0,0 +1,29 @@ +# FCA-Connector + +The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. + +# Publisher: Gulshan Khurana + +## Prerequisites + +You will need the following to proceed: +* A Microsoft Power Apps or Power Automate plan with custom connector feature +* An API key obtained [here](https://register.fca.org.uk/Developer/s/) and the email address used for registration + +## Supported Operations + +The connector supports the following operations: +* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number + + +## Obtaining Credentials + +An API key and email address is required for this connector to work. You can sign up for free with an account on FCA's website [here](https://register.fca.org.uk/Developer/s/registernewuser) + +## Known issues and limitations + +There are no known issues with this connector. There are functions in the API not implemented in this connector and I will continue to work on these if I can resolve the functions/syntax. + +## Deployment Instructions + +Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. From 45f7b6ab21c363e4f925e8054aa01a1537770677 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Wed, 7 Feb 2024 12:39:40 +0000 Subject: [PATCH 02/31] Update ReadME.md --- .../ReadME.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md index 729e3bcd08..64f354c843 100644 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md @@ -14,6 +14,24 @@ You will need the following to proceed: The connector supports the following operations: * `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number +* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number +* `Find Firm Details`: Get information about a specific firm using its Firm Reference Number +* `Product Details`: Get information about a product by using its Product Reference Number +* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number +* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number +* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number +* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number +* `Firm Address`: Get information about a specific firm using its Firm Reference Number +* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number +* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number +* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number +* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference +* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number +* `Firm Passport`: Get information about a passport details by using its Firm Reference Number +* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country +* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number +* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number +* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number ## Obtaining Credentials From d0a4bc16e5920c4103af9def9f24961d1013e251 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Wed, 7 Feb 2024 13:54:52 +0000 Subject: [PATCH 03/31] Update ReadME.md --- .../FInancial Conduct Authority (FCA) UK Connector/ReadME.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md index 64f354c843..06e1b41bb9 100644 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md @@ -1,4 +1,4 @@ -# FCA-Connector +# FCA Connector The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. From 69288f730cce9e8176f82c3f8707d8e4449c48ec Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Fri, 9 Feb 2024 20:55:27 +0000 Subject: [PATCH 04/31] Update ReadME.md --- .../FInancial Conduct Authority (FCA) UK Connector/ReadME.md | 1 - 1 file changed, 1 deletion(-) diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md index 06e1b41bb9..22e53878f6 100644 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md @@ -15,7 +15,6 @@ You will need the following to proceed: The connector supports the following operations: * `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number * `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number -* `Find Firm Details`: Get information about a specific firm using its Firm Reference Number * `Product Details`: Get information about a product by using its Product Reference Number * `Subfund Details`: Get information about subfund of a product by using its Product Reference Number * `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number From 8c0fff1d50ab4da29e915fd6aa9a1c79b64ae7f2 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:07:27 +0000 Subject: [PATCH 05/31] Rename ReadME.md to ReadME.md Corrected the foldername --- .../ReadME.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename independent-publisher-connectors/{FInancial Conduct Authority (FCA) UK Connector => Financial Conduct Authority (FCA) UK Connector}/ReadME.md (100%) diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md similarity index 100% rename from independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md rename to independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md From 85708fe062f2522c9067118a3fd804b6daa26452 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Tue, 13 Feb 2024 19:51:32 +0000 Subject: [PATCH 06/31] Update ReadME.md --- .../Financial Conduct Authority (FCA) UK Connector/ReadME.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md index 22e53878f6..d926878d87 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md @@ -15,10 +15,9 @@ You will need the following to proceed: The connector supports the following operations: * `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number * `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number -* `Product Details`: Get information about a product by using its Product Reference Number +* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number * `Subfund Details`: Get information about subfund of a product by using its Product Reference Number * `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number -* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number * `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number * `Firm Address`: Get information about a specific firm using its Firm Reference Number * `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number @@ -44,3 +43,5 @@ There are no known issues with this connector. There are functions in the API no ## Deployment Instructions Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. + +Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From cf8debdda7ab023df25a90db06431b3a8f4fb3d6 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Tue, 13 Feb 2024 19:59:35 +0000 Subject: [PATCH 07/31] Added files via upload Uploaded the following files: apiDefinition.swagger.json apiProperties.json --- .../apiDefinition.swagger.json | 2171 +++++++++++++++++ .../apiProperties.json | 66 + 2 files changed, 2237 insertions(+) create mode 100644 independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json new file mode 100644 index 0000000000..976ded7c32 --- /dev/null +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -0,0 +1,2171 @@ +{ + "swagger": "2.0", + "info": { + "title": "FCA", + "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA)", + "version": "1.0", + "contact": { + "name": "Gulshan Khurana", + "url": "https://www.linkedin.com/in/gulshankhurana/", + "email": "gulshankhurana@outlook.com" + } + }, + "host": "register.fca.org.uk", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [], + "paths": { + "/services/V0.1/Search": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "URL": { + "type": "string", + "description": "API to fetch the detail record of the data", + "title": "URL" + }, + "Status": { + "type": "string", + "description": "The status of the record", + "title": "Status" + }, + "Reference Number": { + "type": "string", + "description": "The Unique number of the record", + "title": "Reference Number" + }, + "Type of business or Individual": { + "type": "string", + "description": "The type of data returned. Example, Firm, Individual, Collective Investment Scheme", + "title": "Type of business or Individual" + }, + "Name": { + "type": "string", + "description": "The name of the firm or individual", + "title": "Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Common Search", + "description": "Gets the search results for Individuals, Firms or Collective Investment Schemes", + "operationId": "CommonSearch", + "parameters": [ + { + "name": "q", + "in": "query", + "required": false, + "type": "string", + "description": "Query String", + "x-ms-summary": "Query String" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "x-ms-visibility": "internal" + } + ], + "x-ms-visibility": "important" + } + }, + "/services/V0.1/Individuals/{q}": {}, + "/services/V0.1/Individuals/{IRN}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status Code", + "title": "Status Code", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "The number of records returned per page", + "title": "per_page", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Details": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "The status of the individual", + "title": "Status" + }, + "Disciplinary History": { + "type": "string", + "description": "URL to fetch the Disciplinary History", + "title": "Disciplinary History" + }, + "Roles & Activities": { + "type": "string", + "description": "URL to fetch all the roles of an individual", + "title": "Roles & Activities" + }, + "IRN": { + "type": "string", + "description": "Individual Reference Number", + "title": "IRN" + }, + "Commonly Used Name": { + "type": "string", + "description": "Commonly used names of the individual", + "title": "Commonly Used Name" + }, + "Full Name": { + "type": "string", + "description": "The name of the Individual", + "title": "Full Name" + } + }, + "description": "Details" + }, + "Workplace Location 1": { + "type": "object", + "properties": { + "Firm Name": { + "type": "string", + "description": "The firm name of an individual\u2019s workplace(s) displayed at the town/city line of the address where holding a customer-facing role", + "title": "Firm Name" + }, + "Location 1": { + "type": "string", + "description": "The geographical location of an individual\u2019s workplace(s) displayed at the town/city line of the address where holding a customer-facing role", + "title": "Location 1" + } + }, + "description": "Workplace Location 1" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Find Individuals Details", + "description": "Get information about the Individuals associated with its Individual Reference Number", + "operationId": "IndividualsDetailsByIRN", + "parameters": [ + { + "name": "IRN", + "in": "path", + "required": true, + "type": "string", + "description": "Individual Reference Number", + "x-ms-summary": "IRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "x-ms-summary": "Email address associated with your account", + "description": "Email address associated with your account to be passed in Header", + "x-ms-visibility": "internal" + } + ], + "x-ms-visibility": "important" + } + }, + "/services/V0.1/Firm/{FRN}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "description": "URL to fetch other trading name/ brand name for the firm", + "title": "Name" + }, + "Individuals": { + "type": "string", + "description": "URL to fetch the Individuals associated with the firm", + "title": "Individuals" + }, + "Requirements": { + "type": "string", + "description": "URL to fetch associated requirements of the firm", + "title": "Requirements" + }, + "Permissions": { + "type": "string", + "description": "URL to fetch the associated permissions of the firm", + "title": "Permissions" + }, + "Passport": { + "type": "string", + "description": "URL to fetch the associated passports of the firm", + "title": "Passport" + }, + "Regulators": { + "type": "string", + "description": "URL to fetch the associated regulators of the firm", + "title": "Regulators" + }, + "Appointed Representative": { + "type": "string", + "description": "URL to fetch the associated appointed representatives of the firm", + "title": "Appointed Representative" + }, + "Address": { + "type": "string", + "description": "URL to fetch the address and contact details of the firm", + "title": "Address" + }, + "Waivers": { + "type": "string", + "description": "URL to fetch the associated waivers of the firm", + "title": "Waivers" + }, + "Exclusions": { + "type": "string", + "description": "URL to fetch the exclusions associated with the firm", + "title": "Exclusions" + }, + "DisciplinaryHistory": { + "type": "string", + "description": "URL to fetch any disciplinary history against the firm", + "title": "DisciplinaryHistory" + }, + "System Timestamp": { + "type": "string", + "description": "System Timestamp", + "title": "System Timestamp" + }, + "Exceptional Info Details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Exceptional Info Title": { + "type": "string", + "description": "Exceptional Info Title" + }, + "Exceptional Info Body": { + "type": "string", + "description": "Exceptional Info Body" + } + } + }, + "description": "Exceptional Info Details" + }, + "Status Effective Date": { + "type": "string", + "description": "The effective date when the status was active from", + "title": "Status Effective Date" + }, + "Status": { + "type": "string", + "description": "Register Status for the firm", + "title": "Status" + }, + "Business Type": { + "type": "string", + "description": "The type of the firm", + "title": "Business Type" + }, + "Organisation Name": { + "type": "string", + "description": "Name of the firm", + "title": "Organisation Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Find Firm Details", + "description": "Get information about a specific firm using its Firm Reference Number", + "operationId": "FirmDetailsByFRN", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ], + "x-ms-visibility": "important" + } + }, + "/services/V0.1/CIS/{PRN}": {}, + "/services/V0.1/CIS/{PRN}/Subfund": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "URL": { + "type": "string", + "description": "Display the sub-fund product information", + "title": "URL" + }, + "Sub-Fund Type": { + "type": "string", + "description": "Display the sub-fund type information", + "title": "Sub-Fund Type" + }, + "Name": { + "type": "string", + "description": "Display the sub-fund name information", + "title": "Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Subfund Details", + "description": "Get information about subfund of a product by using its Product Reference Number", + "operationId": "SubfundDetailsByPRN", + "parameters": [ + { + "name": "PRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Product Reference Number", + "x-ms-summary": "PRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/CIS/{PRN}/Names": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective To": { + "type": "string", + "description": "Display the other name effective to information", + "title": "Effective To" + }, + "Effective From": { + "type": "string", + "description": "Display the other name effective from information", + "title": "Effective From" + }, + "Product Other Name": { + "type": "string", + "description": "Display the other name information", + "title": "Product Other Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Product Other Name Details", + "operationId": "ProductOtherNameDetailsByPRN", + "description": "Get information about other names of a product by using its Product Reference Number", + "parameters": [ + { + "name": "PRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Product Reference Number", + "x-ms-summary": "PRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Individuals/{IRN}/DisciplinaryHistory": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "TypeofDescription": { + "type": "string", + "description": "Display the final notice information of Disciplinary history", + "title": "TypeofDescription" + }, + "TypeofAction": { + "type": "string", + "description": "Display the Type of Action information of Disciplinary history", + "title": "TypeofAction" + }, + "EnforcementType": { + "type": "string", + "description": "Display the Enforcement Type information of Disciplinary history", + "title": "EnforcementType" + }, + "ActionEffectiveFrom": { + "type": "string", + "description": "Display the Action Date information of Disciplinary history", + "title": "ActionEffectiveFrom" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Individual Disciplinary History", + "operationId": "IndividualDisciplinaryHistoryByIRN", + "description": "Get information about Disciplinary History on an Individual using its Individual Reference Number", + "parameters": [ + { + "name": "IRN", + "in": "path", + "required": true, + "type": "string", + "description": "Individual Reference Number", + "x-ms-summary": "IRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Names": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "Next": { + "type": "string", + "description": "Next", + "title": "", + "x-ms-visibility": "internal" + }, + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Current Names": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective From": { + "type": "string", + "description": "Effective From" + }, + "Status": { + "type": "string", + "description": "Status" + }, + "Name": { + "type": "string", + "description": "Name" + } + } + }, + "description": "Current Names" + }, + "Previous Names": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective To": { + "type": "string", + "description": "Effective To" + }, + "Effective From": { + "type": "string", + "description": "Effective From" + }, + "Status": { + "type": "string", + "description": "Status" + }, + "Name": { + "type": "string", + "description": "Name" + } + } + }, + "description": "Previous Names" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Other Names", + "operationId": "FirmOtherNamesByFRN", + "description": "Get information about the other names used by the firms using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Address": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "URL": { + "type": "string", + "description": "URL to fetch the specific address", + "title": "URL" + }, + "Website Address": { + "type": "string", + "description": "Website address, if any, for the location", + "title": "Website Address" + }, + "Phone Number": { + "type": "string", + "description": "Phone, if any, for the location", + "title": "Phone Number" + }, + "Country": { + "type": "string", + "description": "The country of the address", + "title": "Country" + }, + "Postcode": { + "type": "string", + "description": "The postcode of the address", + "title": "Postcode" + }, + "County": { + "type": "string", + "description": "The county of the address", + "title": "County" + }, + "Town": { + "type": "string", + "description": "The town of the address", + "title": "Town" + }, + "Address Line 4": { + "type": "string", + "description": "The fourth line of the address", + "title": "Address Line 4" + }, + "Address Line 3": { + "type": "string", + "description": "The third line of the address", + "title": "Address Line 3" + }, + "Address Line 2": { + "type": "string", + "description": "The second line of the address", + "title": "Address Line 2" + }, + "Address Line 1": { + "type": "string", + "description": "The first line of the address", + "title": "Address Line 1" + }, + "Address Type": { + "type": "string", + "description": "Type of address", + "title": "Address Type" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Address", + "operationId": "FirmAddressByFRN", + "description": "Get information about a specific firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Individuals": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "Next": { + "type": "string", + "description": "Next", + "title": "", + "x-ms-visibility": "internal" + }, + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "The status of the individual", + "title": "Status" + }, + "URL": { + "type": "string", + "description": "URL to fetch the control functions for this individual", + "title": "URL" + }, + "IRN": { + "type": "string", + "description": "Individual Reference Number", + "title": "IRN" + }, + "Name": { + "type": "string", + "description": "The name of the Individual", + "title": "Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Individuals", + "operationId": "FirmIndividualsByFRN", + "description": "Get information about the Individuals associated with a firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Permissions": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "object", + "properties": { + "Acting as a CBTL advisor": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Acting as a CBTL advisor": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Acting as a CBTL advisor" + } + } + }, + "description": "Acting as a CBTL advisor" + }, + "Acting as a CBTL administrator": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Acting as a CBTL administrator": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Acting as a CBTL administrator" + } + } + }, + "description": "Acting as a CBTL administrator" + }, + "CBTL Status": { + "type": "array", + "items": { + "type": "object", + "properties": { + "CBTL Status": { + "type": "array", + "items": { + "type": "string" + }, + "description": "CBTL Status" + } + } + }, + "description": "CBTL Status" + }, + "CBTL Effective Date": { + "type": "array", + "items": { + "type": "object", + "properties": { + "CBTL Effective Date": { + "type": "array", + "items": { + "type": "string" + }, + "description": "CBTL Effective Date" + } + } + }, + "description": "CBTL Effective Date" + }, + "Entering into Regulated Consumer Hire Agreements as owner": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Limitation": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limitation" + } + } + }, + "description": "Entering into Regulated Consumer Hire Agreements as owner" + }, + "Agreeing to carry on a regulated activity": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Limitation Not Found": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limitation Not Found" + } + } + }, + "description": "Agreeing to carry on a regulated activity" + }, + "Acting as a CBTL Administrator": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Limitation Not Found": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limitation Not Found" + } + } + }, + "description": "Acting as a CBTL Administrator" + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Activities and Permissions", + "operationId": "FirmActivitiesAndPermissionsByFRN", + "description": "Get information about the activities and permissions associated with a specific firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Requirements": {}, + "/services/V0.1/Firm/{FRN}/Requirements/{REQREF}/InvestmentTypes": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Investment Type Name": { + "type": "string", + "description": "Name of the Investment Type associated with the Requirement", + "title": "Investment Type Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Requirements Investment Types", + "operationId": "FirmRequirementsInvestmentTypesByFRNandREQREF", + "description": "Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "REQREF", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Requirement Ref #", + "description": "Requirement Reference Number" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Regulators/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Termination Date": { + "type": "string", + "description": "The date until which the regulator will be valid", + "title": "Termination Date" + }, + "Effective Date": { + "type": "string", + "description": "The date from which the regulator was effective from", + "title": "Effective Date" + }, + "Regulator Name": { + "type": "string", + "description": "Name of the Regulator", + "title": "Regulator Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Regulators", + "description": "Get information about a regulator on a firm using its Firm Reference Number", + "operationId": "FirmRegulatorsByFRN", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Passports/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "Next": { + "type": "string", + "description": "Next", + "title": "", + "x-ms-visibility": "internal" + }, + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Passports": { + "type": "array", + "items": { + "type": "object", + "properties": { + "PassportDirection": { + "type": "string", + "description": "PassportDirection" + }, + "Permissions": { + "type": "string", + "description": "Permissions" + }, + "Country": { + "type": "string", + "description": "Country" + } + } + }, + "description": "Passports" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Passport", + "operationId": "FirmPassportByFRN", + "description": "Get information about a passport details by using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Passports/{Country}/Permission/": {}, + "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Waivers": {}, + "/services/V0.1/Firm/{FRN}/Exclusions": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + ";Status": { + "type": "string", + "description": "Status", + "title": "Status", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "PSD2_Exclusion_Type": { + "type": "string", + "description": "Display the Exclusion type information", + "title": "PSD2_Exclusion_Type" + }, + "Particular_Exclusion_relied_upon": { + "type": "string", + "description": "Display the Exemption Rule information", + "title": "Particular_Exclusion_relied_upon" + }, + "Description_of_services": { + "type": "string", + "description": "Display the description information", + "title": "Description_of_services" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Exclusions", + "description": "Get information about an Exclusion on a firm using its Firm Reference Number", + "operationId": "FirmExclusionsByFRN", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/DisciplinaryHistory": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "TypeofDescription": { + "type": "string", + "description": "Display the final notice information of Disciplinary history", + "title": "TypeofDescription" + }, + "TypeofAction": { + "type": "string", + "description": "Display the Type of Action information of Disciplinary history", + "title": "TypeofAction" + }, + "EnforcementType": { + "type": "string", + "description": "Display the Enforcement Type information of Disciplinary history", + "title": "EnforcementType" + }, + "ActionEffectiveFrom": { + "type": "string", + "description": "Display the Action Date information of Disciplinary history", + "title": "ActionEffectiveFrom" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Disciplinary History", + "operationId": "FirmDisciplinaryHistoryByFRN", + "description": "Get information about a Disciplinary History on a firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Requirements": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective Date": { + "type": "string", + "description": "Date from which the Requirement became effective", + "title": "Effective Date" + }, + "Derivatives as incidental services only.": { + "type": "string", + "description": "The description of the requirement. The requirement data is structured in large paragraphs and therefore is represented with escape sequence to identify paragraphs, tabs and new lines", + "title": "Value" + }, + "Requirement Reference": { + "type": "string", + "description": "Requirement reference number", + "title": "Requirement Reference" + }, + "Financial Promotions Requirement": { + "type": "string", + "description": "TRUE for financial promotions requirement, FALSE otherwise", + "title": "Financial Promotions Requirement" + }, + "Financial Promotions Investment Types": { + "type": "string", + "description": "API URL for Investment Types for the Financial Promotions Requirement", + "title": "Financial Promotions Investment Types" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Requirements", + "operationId": "FirmRequirementsByFRN", + "description": "Get information about the requirements associated with a specific firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Waivers": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Waivers_Discretions_URL": { + "type": "string", + "description": "Display the waivers attachment URL information", + "title": "Waivers_Discretions_URL" + }, + "Waivers_Discretions": { + "type": "string", + "description": "Display the waivers attachment name information", + "title": "Waivers_Discretions" + }, + "Rule_ArticleNo": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Rule_ArticleNo" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Waiver", + "operationId": "FirmWaiverByFRN", + "description": "Get information about a Waiver on a firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Passports/{Country}/Permission/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "description": "Name" + }, + "InvestmentTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "InvestmentTypes" + } + } + }, + "description": "Permissions" + } + } + }, + "description": "Data" + }, + "PassportType": { + "type": "string", + "description": "Hold the passport type information like Service", + "title": "PassportType" + }, + "PassportDirection": { + "type": "string", + "description": "Display the passport direction information e.g. Passporting Out or Passporting In", + "title": "PassportDirection" + }, + "Directive": { + "type": "string", + "description": "Display the directive information for country specific passport", + "title": "Directive" + }, + "Country": { + "type": "string", + "description": "Display the country information", + "title": "Country" + } + } + } + } + }, + "summary": "Firm Passport Permission", + "operationId": "FirmPassportPermissionByFRNandCountry", + "description": "Get information about a passport permission by using its Firm Reference Number and Country", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "FRN", + "description": "FCA Firm Reference Number" + }, + { + "name": "Country", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Country", + "description": "Enter the country name to get information about a passport permission of a firm" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + } + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.fca.org.uk/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://www.fca.org.uk/privacy" + }, + { + "propertyName": "Categories", + "propertyValue": "Business Management;Finance" + } + ], + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "X-Auth-Key" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-openai-manifest": { + "humanName": "", + "modelDescription": "" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json new file mode 100644 index 0000000000..64ebab3060 --- /dev/null +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json @@ -0,0 +1,66 @@ +{ + "properties": { + "connectionParameters": { + "x-Auth-Email": { + "type": "string", + "uiDefinition": { + "displayName": "Email Address", + "description": "The Email Address registered for this api", + "tooltip": "Provide your Email Address associated with this api", + "constraints": { + "required": "true" + } + } + }, + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Key", + "description": "The API Key for this api", + "tooltip": "Provide your API Key", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "policyTemplateInstances": [ + { + "templateId": "setheader", + "title": "X-Auth-Email", + "parameters": { + "x-ms-apimTemplateParameter.name": "X-Auth-Email", + "x-ms-apimTemplateParameter.value": "@connectionParameters('X-Auth-Email')", + "x-ms-apimTemplateParameter.existsAction": "append", + "x-ms-apimTemplate-policySection": "Request", + "x-ms-apimTemplate-operationName": [ + "CommonSearch", + "IndividualsDetailsByIRN", + "IndividualDisciplinaryHistoryByIRN", + "FirmDetailsByFRN", + "SubfundDetailsByPRN", + "ProductOtherNameDetailsByPRN", + "FirmOtherNamesByFRN", + "FirmAddressByFRN", + "FirmIndividualsByFRN", + "FirmActivitiesAndPermissionsByFRN", + "FirmRequirementsByFRN", + "FirmRequirementsInvestmentTypesByFRNandREQREF", + "FirmRegulatorsByFRN", + "FirmPassportByFRN", + "FirmPassportPermissionByFRNandCountry", + "FirmWaiverByFRN", + "FirmExclusionsByFRN", + "FirmDisciplinaryHistoryByFRN" + ] + } + } + ], + "publisher": "Gulshan Khurana", + "stackOwner": "Financial Conduct Authority" + } +} \ No newline at end of file From 4a1f856ba0b5518b86d8a4442d4fb0c111d4183a Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Tue, 13 Feb 2024 21:17:19 +0000 Subject: [PATCH 08/31] Update apiProperties.json --- .../apiProperties.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json index 64ebab3060..a8e1908261 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json @@ -41,7 +41,6 @@ "CommonSearch", "IndividualsDetailsByIRN", "IndividualDisciplinaryHistoryByIRN", - "FirmDetailsByFRN", "SubfundDetailsByPRN", "ProductOtherNameDetailsByPRN", "FirmOtherNamesByFRN", @@ -63,4 +62,4 @@ "publisher": "Gulshan Khurana", "stackOwner": "Financial Conduct Authority" } -} \ No newline at end of file +} From b6a0a05a0391824ad5f9c20eb6f3e2c29be97b5e Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Wed, 14 Feb 2024 17:11:31 +0000 Subject: [PATCH 09/31] Update ReadME.md --- .../ReadME.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md index 729e3bcd08..d926878d87 100644 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md @@ -1,4 +1,4 @@ -# FCA-Connector +# FCA Connector The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. @@ -14,6 +14,22 @@ You will need the following to proceed: The connector supports the following operations: * `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number +* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number +* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number +* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number +* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number +* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number +* `Firm Address`: Get information about a specific firm using its Firm Reference Number +* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number +* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number +* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number +* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference +* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number +* `Firm Passport`: Get information about a passport details by using its Firm Reference Number +* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country +* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number +* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number +* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number ## Obtaining Credentials @@ -27,3 +43,5 @@ There are no known issues with this connector. There are functions in the API no ## Deployment Instructions Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. + +Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From 2c7d278be747dd42996821d63e5af6d26cfac7f7 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Wed, 14 Feb 2024 17:13:41 +0000 Subject: [PATCH 10/31] Added file via upload Added the following files: * apiDefinition.swagger.json * apiProperties.json --- .../apiDefinition.swagger.json | 2171 +++++++++++++++++ .../apiProperties.json | 66 + 2 files changed, 2237 insertions(+) create mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json new file mode 100644 index 0000000000..976ded7c32 --- /dev/null +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -0,0 +1,2171 @@ +{ + "swagger": "2.0", + "info": { + "title": "FCA", + "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA)", + "version": "1.0", + "contact": { + "name": "Gulshan Khurana", + "url": "https://www.linkedin.com/in/gulshankhurana/", + "email": "gulshankhurana@outlook.com" + } + }, + "host": "register.fca.org.uk", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [], + "paths": { + "/services/V0.1/Search": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "URL": { + "type": "string", + "description": "API to fetch the detail record of the data", + "title": "URL" + }, + "Status": { + "type": "string", + "description": "The status of the record", + "title": "Status" + }, + "Reference Number": { + "type": "string", + "description": "The Unique number of the record", + "title": "Reference Number" + }, + "Type of business or Individual": { + "type": "string", + "description": "The type of data returned. Example, Firm, Individual, Collective Investment Scheme", + "title": "Type of business or Individual" + }, + "Name": { + "type": "string", + "description": "The name of the firm or individual", + "title": "Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Common Search", + "description": "Gets the search results for Individuals, Firms or Collective Investment Schemes", + "operationId": "CommonSearch", + "parameters": [ + { + "name": "q", + "in": "query", + "required": false, + "type": "string", + "description": "Query String", + "x-ms-summary": "Query String" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "x-ms-visibility": "internal" + } + ], + "x-ms-visibility": "important" + } + }, + "/services/V0.1/Individuals/{q}": {}, + "/services/V0.1/Individuals/{IRN}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status Code", + "title": "Status Code", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "The number of records returned per page", + "title": "per_page", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Details": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "The status of the individual", + "title": "Status" + }, + "Disciplinary History": { + "type": "string", + "description": "URL to fetch the Disciplinary History", + "title": "Disciplinary History" + }, + "Roles & Activities": { + "type": "string", + "description": "URL to fetch all the roles of an individual", + "title": "Roles & Activities" + }, + "IRN": { + "type": "string", + "description": "Individual Reference Number", + "title": "IRN" + }, + "Commonly Used Name": { + "type": "string", + "description": "Commonly used names of the individual", + "title": "Commonly Used Name" + }, + "Full Name": { + "type": "string", + "description": "The name of the Individual", + "title": "Full Name" + } + }, + "description": "Details" + }, + "Workplace Location 1": { + "type": "object", + "properties": { + "Firm Name": { + "type": "string", + "description": "The firm name of an individual\u2019s workplace(s) displayed at the town/city line of the address where holding a customer-facing role", + "title": "Firm Name" + }, + "Location 1": { + "type": "string", + "description": "The geographical location of an individual\u2019s workplace(s) displayed at the town/city line of the address where holding a customer-facing role", + "title": "Location 1" + } + }, + "description": "Workplace Location 1" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Find Individuals Details", + "description": "Get information about the Individuals associated with its Individual Reference Number", + "operationId": "IndividualsDetailsByIRN", + "parameters": [ + { + "name": "IRN", + "in": "path", + "required": true, + "type": "string", + "description": "Individual Reference Number", + "x-ms-summary": "IRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "x-ms-summary": "Email address associated with your account", + "description": "Email address associated with your account to be passed in Header", + "x-ms-visibility": "internal" + } + ], + "x-ms-visibility": "important" + } + }, + "/services/V0.1/Firm/{FRN}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "description": "URL to fetch other trading name/ brand name for the firm", + "title": "Name" + }, + "Individuals": { + "type": "string", + "description": "URL to fetch the Individuals associated with the firm", + "title": "Individuals" + }, + "Requirements": { + "type": "string", + "description": "URL to fetch associated requirements of the firm", + "title": "Requirements" + }, + "Permissions": { + "type": "string", + "description": "URL to fetch the associated permissions of the firm", + "title": "Permissions" + }, + "Passport": { + "type": "string", + "description": "URL to fetch the associated passports of the firm", + "title": "Passport" + }, + "Regulators": { + "type": "string", + "description": "URL to fetch the associated regulators of the firm", + "title": "Regulators" + }, + "Appointed Representative": { + "type": "string", + "description": "URL to fetch the associated appointed representatives of the firm", + "title": "Appointed Representative" + }, + "Address": { + "type": "string", + "description": "URL to fetch the address and contact details of the firm", + "title": "Address" + }, + "Waivers": { + "type": "string", + "description": "URL to fetch the associated waivers of the firm", + "title": "Waivers" + }, + "Exclusions": { + "type": "string", + "description": "URL to fetch the exclusions associated with the firm", + "title": "Exclusions" + }, + "DisciplinaryHistory": { + "type": "string", + "description": "URL to fetch any disciplinary history against the firm", + "title": "DisciplinaryHistory" + }, + "System Timestamp": { + "type": "string", + "description": "System Timestamp", + "title": "System Timestamp" + }, + "Exceptional Info Details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Exceptional Info Title": { + "type": "string", + "description": "Exceptional Info Title" + }, + "Exceptional Info Body": { + "type": "string", + "description": "Exceptional Info Body" + } + } + }, + "description": "Exceptional Info Details" + }, + "Status Effective Date": { + "type": "string", + "description": "The effective date when the status was active from", + "title": "Status Effective Date" + }, + "Status": { + "type": "string", + "description": "Register Status for the firm", + "title": "Status" + }, + "Business Type": { + "type": "string", + "description": "The type of the firm", + "title": "Business Type" + }, + "Organisation Name": { + "type": "string", + "description": "Name of the firm", + "title": "Organisation Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Find Firm Details", + "description": "Get information about a specific firm using its Firm Reference Number", + "operationId": "FirmDetailsByFRN", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ], + "x-ms-visibility": "important" + } + }, + "/services/V0.1/CIS/{PRN}": {}, + "/services/V0.1/CIS/{PRN}/Subfund": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "URL": { + "type": "string", + "description": "Display the sub-fund product information", + "title": "URL" + }, + "Sub-Fund Type": { + "type": "string", + "description": "Display the sub-fund type information", + "title": "Sub-Fund Type" + }, + "Name": { + "type": "string", + "description": "Display the sub-fund name information", + "title": "Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Subfund Details", + "description": "Get information about subfund of a product by using its Product Reference Number", + "operationId": "SubfundDetailsByPRN", + "parameters": [ + { + "name": "PRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Product Reference Number", + "x-ms-summary": "PRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/CIS/{PRN}/Names": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective To": { + "type": "string", + "description": "Display the other name effective to information", + "title": "Effective To" + }, + "Effective From": { + "type": "string", + "description": "Display the other name effective from information", + "title": "Effective From" + }, + "Product Other Name": { + "type": "string", + "description": "Display the other name information", + "title": "Product Other Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Product Other Name Details", + "operationId": "ProductOtherNameDetailsByPRN", + "description": "Get information about other names of a product by using its Product Reference Number", + "parameters": [ + { + "name": "PRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Product Reference Number", + "x-ms-summary": "PRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Individuals/{IRN}/DisciplinaryHistory": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "TypeofDescription": { + "type": "string", + "description": "Display the final notice information of Disciplinary history", + "title": "TypeofDescription" + }, + "TypeofAction": { + "type": "string", + "description": "Display the Type of Action information of Disciplinary history", + "title": "TypeofAction" + }, + "EnforcementType": { + "type": "string", + "description": "Display the Enforcement Type information of Disciplinary history", + "title": "EnforcementType" + }, + "ActionEffectiveFrom": { + "type": "string", + "description": "Display the Action Date information of Disciplinary history", + "title": "ActionEffectiveFrom" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Individual Disciplinary History", + "operationId": "IndividualDisciplinaryHistoryByIRN", + "description": "Get information about Disciplinary History on an Individual using its Individual Reference Number", + "parameters": [ + { + "name": "IRN", + "in": "path", + "required": true, + "type": "string", + "description": "Individual Reference Number", + "x-ms-summary": "IRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Names": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "Next": { + "type": "string", + "description": "Next", + "title": "", + "x-ms-visibility": "internal" + }, + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Current Names": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective From": { + "type": "string", + "description": "Effective From" + }, + "Status": { + "type": "string", + "description": "Status" + }, + "Name": { + "type": "string", + "description": "Name" + } + } + }, + "description": "Current Names" + }, + "Previous Names": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective To": { + "type": "string", + "description": "Effective To" + }, + "Effective From": { + "type": "string", + "description": "Effective From" + }, + "Status": { + "type": "string", + "description": "Status" + }, + "Name": { + "type": "string", + "description": "Name" + } + } + }, + "description": "Previous Names" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Other Names", + "operationId": "FirmOtherNamesByFRN", + "description": "Get information about the other names used by the firms using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Address": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "URL": { + "type": "string", + "description": "URL to fetch the specific address", + "title": "URL" + }, + "Website Address": { + "type": "string", + "description": "Website address, if any, for the location", + "title": "Website Address" + }, + "Phone Number": { + "type": "string", + "description": "Phone, if any, for the location", + "title": "Phone Number" + }, + "Country": { + "type": "string", + "description": "The country of the address", + "title": "Country" + }, + "Postcode": { + "type": "string", + "description": "The postcode of the address", + "title": "Postcode" + }, + "County": { + "type": "string", + "description": "The county of the address", + "title": "County" + }, + "Town": { + "type": "string", + "description": "The town of the address", + "title": "Town" + }, + "Address Line 4": { + "type": "string", + "description": "The fourth line of the address", + "title": "Address Line 4" + }, + "Address Line 3": { + "type": "string", + "description": "The third line of the address", + "title": "Address Line 3" + }, + "Address Line 2": { + "type": "string", + "description": "The second line of the address", + "title": "Address Line 2" + }, + "Address Line 1": { + "type": "string", + "description": "The first line of the address", + "title": "Address Line 1" + }, + "Address Type": { + "type": "string", + "description": "Type of address", + "title": "Address Type" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Address", + "operationId": "FirmAddressByFRN", + "description": "Get information about a specific firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Individuals": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "Next": { + "type": "string", + "description": "Next", + "title": "", + "x-ms-visibility": "internal" + }, + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "The status of the individual", + "title": "Status" + }, + "URL": { + "type": "string", + "description": "URL to fetch the control functions for this individual", + "title": "URL" + }, + "IRN": { + "type": "string", + "description": "Individual Reference Number", + "title": "IRN" + }, + "Name": { + "type": "string", + "description": "The name of the Individual", + "title": "Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Individuals", + "operationId": "FirmIndividualsByFRN", + "description": "Get information about the Individuals associated with a firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Permissions": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "object", + "properties": { + "Acting as a CBTL advisor": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Acting as a CBTL advisor": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Acting as a CBTL advisor" + } + } + }, + "description": "Acting as a CBTL advisor" + }, + "Acting as a CBTL administrator": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Acting as a CBTL administrator": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Acting as a CBTL administrator" + } + } + }, + "description": "Acting as a CBTL administrator" + }, + "CBTL Status": { + "type": "array", + "items": { + "type": "object", + "properties": { + "CBTL Status": { + "type": "array", + "items": { + "type": "string" + }, + "description": "CBTL Status" + } + } + }, + "description": "CBTL Status" + }, + "CBTL Effective Date": { + "type": "array", + "items": { + "type": "object", + "properties": { + "CBTL Effective Date": { + "type": "array", + "items": { + "type": "string" + }, + "description": "CBTL Effective Date" + } + } + }, + "description": "CBTL Effective Date" + }, + "Entering into Regulated Consumer Hire Agreements as owner": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Limitation": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limitation" + } + } + }, + "description": "Entering into Regulated Consumer Hire Agreements as owner" + }, + "Agreeing to carry on a regulated activity": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Limitation Not Found": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limitation Not Found" + } + } + }, + "description": "Agreeing to carry on a regulated activity" + }, + "Acting as a CBTL Administrator": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Limitation Not Found": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Limitation Not Found" + } + } + }, + "description": "Acting as a CBTL Administrator" + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Activities and Permissions", + "operationId": "FirmActivitiesAndPermissionsByFRN", + "description": "Get information about the activities and permissions associated with a specific firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Requirements": {}, + "/services/V0.1/Firm/{FRN}/Requirements/{REQREF}/InvestmentTypes": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Investment Type Name": { + "type": "string", + "description": "Name of the Investment Type associated with the Requirement", + "title": "Investment Type Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Requirements Investment Types", + "operationId": "FirmRequirementsInvestmentTypesByFRNandREQREF", + "description": "Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "REQREF", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Requirement Ref #", + "description": "Requirement Reference Number" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Regulators/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Termination Date": { + "type": "string", + "description": "The date until which the regulator will be valid", + "title": "Termination Date" + }, + "Effective Date": { + "type": "string", + "description": "The date from which the regulator was effective from", + "title": "Effective Date" + }, + "Regulator Name": { + "type": "string", + "description": "Name of the Regulator", + "title": "Regulator Name" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Regulators", + "description": "Get information about a regulator on a firm using its Firm Reference Number", + "operationId": "FirmRegulatorsByFRN", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Passports/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "Next": { + "type": "string", + "description": "Next", + "title": "", + "x-ms-visibility": "internal" + }, + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Passports": { + "type": "array", + "items": { + "type": "object", + "properties": { + "PassportDirection": { + "type": "string", + "description": "PassportDirection" + }, + "Permissions": { + "type": "string", + "description": "Permissions" + }, + "Country": { + "type": "string", + "description": "Country" + } + } + }, + "description": "Passports" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Passport", + "operationId": "FirmPassportByFRN", + "description": "Get information about a passport details by using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Passports/{Country}/Permission/": {}, + "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Waivers": {}, + "/services/V0.1/Firm/{FRN}/Exclusions": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + ";Status": { + "type": "string", + "description": "Status", + "title": "Status", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "PSD2_Exclusion_Type": { + "type": "string", + "description": "Display the Exclusion type information", + "title": "PSD2_Exclusion_Type" + }, + "Particular_Exclusion_relied_upon": { + "type": "string", + "description": "Display the Exemption Rule information", + "title": "Particular_Exclusion_relied_upon" + }, + "Description_of_services": { + "type": "string", + "description": "Display the description information", + "title": "Description_of_services" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Exclusions", + "description": "Get information about an Exclusion on a firm using its Firm Reference Number", + "operationId": "FirmExclusionsByFRN", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/DisciplinaryHistory": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "TypeofDescription": { + "type": "string", + "description": "Display the final notice information of Disciplinary history", + "title": "TypeofDescription" + }, + "TypeofAction": { + "type": "string", + "description": "Display the Type of Action information of Disciplinary history", + "title": "TypeofAction" + }, + "EnforcementType": { + "type": "string", + "description": "Display the Enforcement Type information of Disciplinary history", + "title": "EnforcementType" + }, + "ActionEffectiveFrom": { + "type": "string", + "description": "Display the Action Date information of Disciplinary history", + "title": "ActionEffectiveFrom" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Disciplinary History", + "operationId": "FirmDisciplinaryHistoryByFRN", + "description": "Get information about a Disciplinary History on a firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Requirements": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Effective Date": { + "type": "string", + "description": "Date from which the Requirement became effective", + "title": "Effective Date" + }, + "Derivatives as incidental services only.": { + "type": "string", + "description": "The description of the requirement. The requirement data is structured in large paragraphs and therefore is represented with escape sequence to identify paragraphs, tabs and new lines", + "title": "Value" + }, + "Requirement Reference": { + "type": "string", + "description": "Requirement reference number", + "title": "Requirement Reference" + }, + "Financial Promotions Requirement": { + "type": "string", + "description": "TRUE for financial promotions requirement, FALSE otherwise", + "title": "Financial Promotions Requirement" + }, + "Financial Promotions Investment Types": { + "type": "string", + "description": "API URL for Investment Types for the Financial Promotions Requirement", + "title": "Financial Promotions Investment Types" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Requirements", + "operationId": "FirmRequirementsByFRN", + "description": "Get information about the requirements associated with a specific firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Waivers": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Waivers_Discretions_URL": { + "type": "string", + "description": "Display the waivers attachment URL information", + "title": "Waivers_Discretions_URL" + }, + "Waivers_Discretions": { + "type": "string", + "description": "Display the waivers attachment name information", + "title": "Waivers_Discretions" + }, + "Rule_ArticleNo": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Rule_ArticleNo" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Firm Waiver", + "operationId": "FirmWaiverByFRN", + "description": "Get information about a Waiver on a firm using its Firm Reference Number", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Firm Reference Number", + "x-ms-summary": "FRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + }, + "/services/V0.1/Firm/{FRN}/Passports/{Country}/Permission/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status", + "title": "", + "x-ms-visibility": "internal" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "", + "x-ms-visibility": "internal" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "", + "x-ms-visibility": "internal" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "", + "x-ms-visibility": "internal" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "", + "x-ms-visibility": "internal" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "description": "Name" + }, + "InvestmentTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "InvestmentTypes" + } + } + }, + "description": "Permissions" + } + } + }, + "description": "Data" + }, + "PassportType": { + "type": "string", + "description": "Hold the passport type information like Service", + "title": "PassportType" + }, + "PassportDirection": { + "type": "string", + "description": "Display the passport direction information e.g. Passporting Out or Passporting In", + "title": "PassportDirection" + }, + "Directive": { + "type": "string", + "description": "Display the directive information for country specific passport", + "title": "Directive" + }, + "Country": { + "type": "string", + "description": "Display the country information", + "title": "Country" + } + } + } + } + }, + "summary": "Firm Passport Permission", + "operationId": "FirmPassportPermissionByFRNandCountry", + "description": "Get information about a passport permission by using its Firm Reference Number and Country", + "parameters": [ + { + "name": "FRN", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "FRN", + "description": "FCA Firm Reference Number" + }, + { + "name": "Country", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Country", + "description": "Enter the country name to get information about a passport permission of a firm" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] + } + } + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.fca.org.uk/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://www.fca.org.uk/privacy" + }, + { + "propertyName": "Categories", + "propertyValue": "Business Management;Finance" + } + ], + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "X-Auth-Key" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-openai-manifest": { + "humanName": "", + "modelDescription": "" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json new file mode 100644 index 0000000000..64ebab3060 --- /dev/null +++ b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json @@ -0,0 +1,66 @@ +{ + "properties": { + "connectionParameters": { + "x-Auth-Email": { + "type": "string", + "uiDefinition": { + "displayName": "Email Address", + "description": "The Email Address registered for this api", + "tooltip": "Provide your Email Address associated with this api", + "constraints": { + "required": "true" + } + } + }, + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Key", + "description": "The API Key for this api", + "tooltip": "Provide your API Key", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "policyTemplateInstances": [ + { + "templateId": "setheader", + "title": "X-Auth-Email", + "parameters": { + "x-ms-apimTemplateParameter.name": "X-Auth-Email", + "x-ms-apimTemplateParameter.value": "@connectionParameters('X-Auth-Email')", + "x-ms-apimTemplateParameter.existsAction": "append", + "x-ms-apimTemplate-policySection": "Request", + "x-ms-apimTemplate-operationName": [ + "CommonSearch", + "IndividualsDetailsByIRN", + "IndividualDisciplinaryHistoryByIRN", + "FirmDetailsByFRN", + "SubfundDetailsByPRN", + "ProductOtherNameDetailsByPRN", + "FirmOtherNamesByFRN", + "FirmAddressByFRN", + "FirmIndividualsByFRN", + "FirmActivitiesAndPermissionsByFRN", + "FirmRequirementsByFRN", + "FirmRequirementsInvestmentTypesByFRNandREQREF", + "FirmRegulatorsByFRN", + "FirmPassportByFRN", + "FirmPassportPermissionByFRNandCountry", + "FirmWaiverByFRN", + "FirmExclusionsByFRN", + "FirmDisciplinaryHistoryByFRN" + ] + } + } + ], + "publisher": "Gulshan Khurana", + "stackOwner": "Financial Conduct Authority" + } +} \ No newline at end of file From 7844457572d5f82141e4bd4dce0a0af22ba214ac Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 15:25:39 +0000 Subject: [PATCH 11/31] Delete independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md --- .../ReadME.md | 47 ------------------- 1 file changed, 47 deletions(-) delete mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md deleted file mode 100644 index d926878d87..0000000000 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ /dev/null @@ -1,47 +0,0 @@ -# FCA Connector - -The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. - -# Publisher: Gulshan Khurana - -## Prerequisites - -You will need the following to proceed: -* A Microsoft Power Apps or Power Automate plan with custom connector feature -* An API key obtained [here](https://register.fca.org.uk/Developer/s/) and the email address used for registration - -## Supported Operations - -The connector supports the following operations: -* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number -* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number -* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number -* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number -* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number -* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number -* `Firm Address`: Get information about a specific firm using its Firm Reference Number -* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number -* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number -* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number -* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference -* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number -* `Firm Passport`: Get information about a passport details by using its Firm Reference Number -* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country -* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number -* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number -* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number - - -## Obtaining Credentials - -An API key and email address is required for this connector to work. You can sign up for free with an account on FCA's website [here](https://register.fca.org.uk/Developer/s/registernewuser) - -## Known issues and limitations - -There are no known issues with this connector. There are functions in the API not implemented in this connector and I will continue to work on these if I can resolve the functions/syntax. - -## Deployment Instructions - -Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. - -Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From bd0a4ac3723d0db49b4036aef8d033048c9aa18f Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 15:26:10 +0000 Subject: [PATCH 12/31] Delete independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json --- .../apiDefinition.swagger.json | 2171 ----------------- 1 file changed, 2171 deletions(-) delete mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json deleted file mode 100644 index 976ded7c32..0000000000 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ /dev/null @@ -1,2171 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "FCA", - "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA)", - "version": "1.0", - "contact": { - "name": "Gulshan Khurana", - "url": "https://www.linkedin.com/in/gulshankhurana/", - "email": "gulshankhurana@outlook.com" - } - }, - "host": "register.fca.org.uk", - "basePath": "/", - "schemes": [ - "https" - ], - "consumes": [], - "produces": [], - "paths": { - "/services/V0.1/Search": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "URL": { - "type": "string", - "description": "API to fetch the detail record of the data", - "title": "URL" - }, - "Status": { - "type": "string", - "description": "The status of the record", - "title": "Status" - }, - "Reference Number": { - "type": "string", - "description": "The Unique number of the record", - "title": "Reference Number" - }, - "Type of business or Individual": { - "type": "string", - "description": "The type of data returned. Example, Firm, Individual, Collective Investment Scheme", - "title": "Type of business or Individual" - }, - "Name": { - "type": "string", - "description": "The name of the firm or individual", - "title": "Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Common Search", - "description": "Gets the search results for Individuals, Firms or Collective Investment Schemes", - "operationId": "CommonSearch", - "parameters": [ - { - "name": "q", - "in": "query", - "required": false, - "type": "string", - "description": "Query String", - "x-ms-summary": "Query String" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "x-ms-visibility": "internal" - } - ], - "x-ms-visibility": "important" - } - }, - "/services/V0.1/Individuals/{q}": {}, - "/services/V0.1/Individuals/{IRN}": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status Code", - "title": "Status Code", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", - "title": "page", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "The number of records returned per page", - "title": "per_page", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "The total number of records returned by the request. For firm details it will be only 1", - "title": "total_count", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "Message", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Details": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "The status of the individual", - "title": "Status" - }, - "Disciplinary History": { - "type": "string", - "description": "URL to fetch the Disciplinary History", - "title": "Disciplinary History" - }, - "Roles & Activities": { - "type": "string", - "description": "URL to fetch all the roles of an individual", - "title": "Roles & Activities" - }, - "IRN": { - "type": "string", - "description": "Individual Reference Number", - "title": "IRN" - }, - "Commonly Used Name": { - "type": "string", - "description": "Commonly used names of the individual", - "title": "Commonly Used Name" - }, - "Full Name": { - "type": "string", - "description": "The name of the Individual", - "title": "Full Name" - } - }, - "description": "Details" - }, - "Workplace Location 1": { - "type": "object", - "properties": { - "Firm Name": { - "type": "string", - "description": "The firm name of an individual\u2019s workplace(s) displayed at the town/city line of the address where holding a customer-facing role", - "title": "Firm Name" - }, - "Location 1": { - "type": "string", - "description": "The geographical location of an individual\u2019s workplace(s) displayed at the town/city line of the address where holding a customer-facing role", - "title": "Location 1" - } - }, - "description": "Workplace Location 1" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Find Individuals Details", - "description": "Get information about the Individuals associated with its Individual Reference Number", - "operationId": "IndividualsDetailsByIRN", - "parameters": [ - { - "name": "IRN", - "in": "path", - "required": true, - "type": "string", - "description": "Individual Reference Number", - "x-ms-summary": "IRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "x-ms-summary": "Email address associated with your account", - "description": "Email address associated with your account to be passed in Header", - "x-ms-visibility": "internal" - } - ], - "x-ms-visibility": "important" - } - }, - "/services/V0.1/Firm/{FRN}": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "URL to fetch other trading name/ brand name for the firm", - "title": "Name" - }, - "Individuals": { - "type": "string", - "description": "URL to fetch the Individuals associated with the firm", - "title": "Individuals" - }, - "Requirements": { - "type": "string", - "description": "URL to fetch associated requirements of the firm", - "title": "Requirements" - }, - "Permissions": { - "type": "string", - "description": "URL to fetch the associated permissions of the firm", - "title": "Permissions" - }, - "Passport": { - "type": "string", - "description": "URL to fetch the associated passports of the firm", - "title": "Passport" - }, - "Regulators": { - "type": "string", - "description": "URL to fetch the associated regulators of the firm", - "title": "Regulators" - }, - "Appointed Representative": { - "type": "string", - "description": "URL to fetch the associated appointed representatives of the firm", - "title": "Appointed Representative" - }, - "Address": { - "type": "string", - "description": "URL to fetch the address and contact details of the firm", - "title": "Address" - }, - "Waivers": { - "type": "string", - "description": "URL to fetch the associated waivers of the firm", - "title": "Waivers" - }, - "Exclusions": { - "type": "string", - "description": "URL to fetch the exclusions associated with the firm", - "title": "Exclusions" - }, - "DisciplinaryHistory": { - "type": "string", - "description": "URL to fetch any disciplinary history against the firm", - "title": "DisciplinaryHistory" - }, - "System Timestamp": { - "type": "string", - "description": "System Timestamp", - "title": "System Timestamp" - }, - "Exceptional Info Details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Exceptional Info Title": { - "type": "string", - "description": "Exceptional Info Title" - }, - "Exceptional Info Body": { - "type": "string", - "description": "Exceptional Info Body" - } - } - }, - "description": "Exceptional Info Details" - }, - "Status Effective Date": { - "type": "string", - "description": "The effective date when the status was active from", - "title": "Status Effective Date" - }, - "Status": { - "type": "string", - "description": "Register Status for the firm", - "title": "Status" - }, - "Business Type": { - "type": "string", - "description": "The type of the firm", - "title": "Business Type" - }, - "Organisation Name": { - "type": "string", - "description": "Name of the firm", - "title": "Organisation Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Find Firm Details", - "description": "Get information about a specific firm using its Firm Reference Number", - "operationId": "FirmDetailsByFRN", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ], - "x-ms-visibility": "important" - } - }, - "/services/V0.1/CIS/{PRN}": {}, - "/services/V0.1/CIS/{PRN}/Subfund": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "URL": { - "type": "string", - "description": "Display the sub-fund product information", - "title": "URL" - }, - "Sub-Fund Type": { - "type": "string", - "description": "Display the sub-fund type information", - "title": "Sub-Fund Type" - }, - "Name": { - "type": "string", - "description": "Display the sub-fund name information", - "title": "Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Subfund Details", - "description": "Get information about subfund of a product by using its Product Reference Number", - "operationId": "SubfundDetailsByPRN", - "parameters": [ - { - "name": "PRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Product Reference Number", - "x-ms-summary": "PRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/CIS/{PRN}/Names": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Effective To": { - "type": "string", - "description": "Display the other name effective to information", - "title": "Effective To" - }, - "Effective From": { - "type": "string", - "description": "Display the other name effective from information", - "title": "Effective From" - }, - "Product Other Name": { - "type": "string", - "description": "Display the other name information", - "title": "Product Other Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Product Other Name Details", - "operationId": "ProductOtherNameDetailsByPRN", - "description": "Get information about other names of a product by using its Product Reference Number", - "parameters": [ - { - "name": "PRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Product Reference Number", - "x-ms-summary": "PRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Individuals/{IRN}/DisciplinaryHistory": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TypeofDescription": { - "type": "string", - "description": "Display the final notice information of Disciplinary history", - "title": "TypeofDescription" - }, - "TypeofAction": { - "type": "string", - "description": "Display the Type of Action information of Disciplinary history", - "title": "TypeofAction" - }, - "EnforcementType": { - "type": "string", - "description": "Display the Enforcement Type information of Disciplinary history", - "title": "EnforcementType" - }, - "ActionEffectiveFrom": { - "type": "string", - "description": "Display the Action Date information of Disciplinary history", - "title": "ActionEffectiveFrom" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Individual Disciplinary History", - "operationId": "IndividualDisciplinaryHistoryByIRN", - "description": "Get information about Disciplinary History on an Individual using its Individual Reference Number", - "parameters": [ - { - "name": "IRN", - "in": "path", - "required": true, - "type": "string", - "description": "Individual Reference Number", - "x-ms-summary": "IRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Names": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "Next": { - "type": "string", - "description": "Next", - "title": "", - "x-ms-visibility": "internal" - }, - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Current Names": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Effective From": { - "type": "string", - "description": "Effective From" - }, - "Status": { - "type": "string", - "description": "Status" - }, - "Name": { - "type": "string", - "description": "Name" - } - } - }, - "description": "Current Names" - }, - "Previous Names": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Effective To": { - "type": "string", - "description": "Effective To" - }, - "Effective From": { - "type": "string", - "description": "Effective From" - }, - "Status": { - "type": "string", - "description": "Status" - }, - "Name": { - "type": "string", - "description": "Name" - } - } - }, - "description": "Previous Names" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Other Names", - "operationId": "FirmOtherNamesByFRN", - "description": "Get information about the other names used by the firms using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Address": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "URL": { - "type": "string", - "description": "URL to fetch the specific address", - "title": "URL" - }, - "Website Address": { - "type": "string", - "description": "Website address, if any, for the location", - "title": "Website Address" - }, - "Phone Number": { - "type": "string", - "description": "Phone, if any, for the location", - "title": "Phone Number" - }, - "Country": { - "type": "string", - "description": "The country of the address", - "title": "Country" - }, - "Postcode": { - "type": "string", - "description": "The postcode of the address", - "title": "Postcode" - }, - "County": { - "type": "string", - "description": "The county of the address", - "title": "County" - }, - "Town": { - "type": "string", - "description": "The town of the address", - "title": "Town" - }, - "Address Line 4": { - "type": "string", - "description": "The fourth line of the address", - "title": "Address Line 4" - }, - "Address Line 3": { - "type": "string", - "description": "The third line of the address", - "title": "Address Line 3" - }, - "Address Line 2": { - "type": "string", - "description": "The second line of the address", - "title": "Address Line 2" - }, - "Address Line 1": { - "type": "string", - "description": "The first line of the address", - "title": "Address Line 1" - }, - "Address Type": { - "type": "string", - "description": "Type of address", - "title": "Address Type" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Address", - "operationId": "FirmAddressByFRN", - "description": "Get information about a specific firm using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Individuals": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "Next": { - "type": "string", - "description": "Next", - "title": "", - "x-ms-visibility": "internal" - }, - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "The status of the individual", - "title": "Status" - }, - "URL": { - "type": "string", - "description": "URL to fetch the control functions for this individual", - "title": "URL" - }, - "IRN": { - "type": "string", - "description": "Individual Reference Number", - "title": "IRN" - }, - "Name": { - "type": "string", - "description": "The name of the Individual", - "title": "Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Individuals", - "operationId": "FirmIndividualsByFRN", - "description": "Get information about the Individuals associated with a firm using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Permissions": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "object", - "properties": { - "Acting as a CBTL advisor": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Acting as a CBTL advisor": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Acting as a CBTL advisor" - } - } - }, - "description": "Acting as a CBTL advisor" - }, - "Acting as a CBTL administrator": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Acting as a CBTL administrator": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Acting as a CBTL administrator" - } - } - }, - "description": "Acting as a CBTL administrator" - }, - "CBTL Status": { - "type": "array", - "items": { - "type": "object", - "properties": { - "CBTL Status": { - "type": "array", - "items": { - "type": "string" - }, - "description": "CBTL Status" - } - } - }, - "description": "CBTL Status" - }, - "CBTL Effective Date": { - "type": "array", - "items": { - "type": "object", - "properties": { - "CBTL Effective Date": { - "type": "array", - "items": { - "type": "string" - }, - "description": "CBTL Effective Date" - } - } - }, - "description": "CBTL Effective Date" - }, - "Entering into Regulated Consumer Hire Agreements as owner": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Limitation": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Limitation" - } - } - }, - "description": "Entering into Regulated Consumer Hire Agreements as owner" - }, - "Agreeing to carry on a regulated activity": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Limitation Not Found": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Limitation Not Found" - } - } - }, - "description": "Agreeing to carry on a regulated activity" - }, - "Acting as a CBTL Administrator": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Limitation Not Found": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Limitation Not Found" - } - } - }, - "description": "Acting as a CBTL Administrator" - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Activities and Permissions", - "operationId": "FirmActivitiesAndPermissionsByFRN", - "description": "Get information about the activities and permissions associated with a specific firm using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Requirements": {}, - "/services/V0.1/Firm/{FRN}/Requirements/{REQREF}/InvestmentTypes": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Investment Type Name": { - "type": "string", - "description": "Name of the Investment Type associated with the Requirement", - "title": "Investment Type Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Requirements Investment Types", - "operationId": "FirmRequirementsInvestmentTypesByFRNandREQREF", - "description": "Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "REQREF", - "in": "path", - "required": true, - "type": "string", - "x-ms-summary": "Requirement Ref #", - "description": "Requirement Reference Number" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Regulators/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Termination Date": { - "type": "string", - "description": "The date until which the regulator will be valid", - "title": "Termination Date" - }, - "Effective Date": { - "type": "string", - "description": "The date from which the regulator was effective from", - "title": "Effective Date" - }, - "Regulator Name": { - "type": "string", - "description": "Name of the Regulator", - "title": "Regulator Name" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Regulators", - "description": "Get information about a regulator on a firm using its Firm Reference Number", - "operationId": "FirmRegulatorsByFRN", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Passports/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "Next": { - "type": "string", - "description": "Next", - "title": "", - "x-ms-visibility": "internal" - }, - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Passports": { - "type": "array", - "items": { - "type": "object", - "properties": { - "PassportDirection": { - "type": "string", - "description": "PassportDirection" - }, - "Permissions": { - "type": "string", - "description": "Permissions" - }, - "Country": { - "type": "string", - "description": "Country" - } - } - }, - "description": "Passports" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Passport", - "operationId": "FirmPassportByFRN", - "description": "Get information about a passport details by using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Passports/{Country}/Permission/": {}, - "/register.fca.org.uk/services/V0.1/Firm/{FRN}/Waivers": {}, - "/services/V0.1/Firm/{FRN}/Exclusions": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - ";Status": { - "type": "string", - "description": "Status", - "title": "Status", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "PSD2_Exclusion_Type": { - "type": "string", - "description": "Display the Exclusion type information", - "title": "PSD2_Exclusion_Type" - }, - "Particular_Exclusion_relied_upon": { - "type": "string", - "description": "Display the Exemption Rule information", - "title": "Particular_Exclusion_relied_upon" - }, - "Description_of_services": { - "type": "string", - "description": "Display the description information", - "title": "Description_of_services" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Exclusions", - "description": "Get information about an Exclusion on a firm using its Firm Reference Number", - "operationId": "FirmExclusionsByFRN", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/DisciplinaryHistory": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "TypeofDescription": { - "type": "string", - "description": "Display the final notice information of Disciplinary history", - "title": "TypeofDescription" - }, - "TypeofAction": { - "type": "string", - "description": "Display the Type of Action information of Disciplinary history", - "title": "TypeofAction" - }, - "EnforcementType": { - "type": "string", - "description": "Display the Enforcement Type information of Disciplinary history", - "title": "EnforcementType" - }, - "ActionEffectiveFrom": { - "type": "string", - "description": "Display the Action Date information of Disciplinary history", - "title": "ActionEffectiveFrom" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Disciplinary History", - "operationId": "FirmDisciplinaryHistoryByFRN", - "description": "Get information about a Disciplinary History on a firm using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Requirements": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Effective Date": { - "type": "string", - "description": "Date from which the Requirement became effective", - "title": "Effective Date" - }, - "Derivatives as incidental services only.": { - "type": "string", - "description": "The description of the requirement. The requirement data is structured in large paragraphs and therefore is represented with escape sequence to identify paragraphs, tabs and new lines", - "title": "Value" - }, - "Requirement Reference": { - "type": "string", - "description": "Requirement reference number", - "title": "Requirement Reference" - }, - "Financial Promotions Requirement": { - "type": "string", - "description": "TRUE for financial promotions requirement, FALSE otherwise", - "title": "Financial Promotions Requirement" - }, - "Financial Promotions Investment Types": { - "type": "string", - "description": "API URL for Investment Types for the Financial Promotions Requirement", - "title": "Financial Promotions Investment Types" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Requirements", - "operationId": "FirmRequirementsByFRN", - "description": "Get information about the requirements associated with a specific firm using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Waivers": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Waivers_Discretions_URL": { - "type": "string", - "description": "Display the waivers attachment URL information", - "title": "Waivers_Discretions_URL" - }, - "Waivers_Discretions": { - "type": "string", - "description": "Display the waivers attachment name information", - "title": "Waivers_Discretions" - }, - "Rule_ArticleNo": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Rule_ArticleNo" - } - } - }, - "description": "Data" - } - } - } - } - }, - "summary": "Firm Waiver", - "operationId": "FirmWaiverByFRN", - "description": "Get information about a Waiver on a firm using its Firm Reference Number", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "description": "FCA Firm Reference Number", - "x-ms-summary": "FRN" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - }, - "/services/V0.1/Firm/{FRN}/Passports/{Country}/Permission/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "Status": { - "type": "string", - "description": "Status", - "title": "", - "x-ms-visibility": "internal" - }, - "ResultInfo": { - "type": "object", - "properties": { - "page": { - "type": "string", - "description": "page", - "title": "", - "x-ms-visibility": "internal" - }, - "per_page": { - "type": "string", - "description": "per_page", - "title": "", - "x-ms-visibility": "internal" - }, - "total_count": { - "type": "string", - "description": "total_count", - "title": "", - "x-ms-visibility": "internal" - } - }, - "description": "ResultInfo" - }, - "Message": { - "type": "string", - "description": "Message", - "title": "", - "x-ms-visibility": "internal" - }, - "Data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "Name" - }, - "InvestmentTypes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "InvestmentTypes" - } - } - }, - "description": "Permissions" - } - } - }, - "description": "Data" - }, - "PassportType": { - "type": "string", - "description": "Hold the passport type information like Service", - "title": "PassportType" - }, - "PassportDirection": { - "type": "string", - "description": "Display the passport direction information e.g. Passporting Out or Passporting In", - "title": "PassportDirection" - }, - "Directive": { - "type": "string", - "description": "Display the directive information for country specific passport", - "title": "Directive" - }, - "Country": { - "type": "string", - "description": "Display the country information", - "title": "Country" - } - } - } - } - }, - "summary": "Firm Passport Permission", - "operationId": "FirmPassportPermissionByFRNandCountry", - "description": "Get information about a passport permission by using its Firm Reference Number and Country", - "parameters": [ - { - "name": "FRN", - "in": "path", - "required": true, - "type": "string", - "x-ms-summary": "FRN", - "description": "FCA Firm Reference Number" - }, - { - "name": "Country", - "in": "path", - "required": true, - "type": "string", - "x-ms-summary": "Country", - "description": "Enter the country name to get information about a passport permission of a firm" - }, - { - "name": "X-Auth-Email", - "in": "header", - "required": false, - "type": "string", - "description": "Email address associated with your account to be passed in Header", - "x-ms-summary": "Email address associated with your account", - "x-ms-visibility": "internal" - } - ] - } - } - }, - "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://www.fca.org.uk/" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://www.fca.org.uk/privacy" - }, - { - "propertyName": "Categories", - "propertyValue": "Business Management;Finance" - } - ], - "definitions": {}, - "parameters": {}, - "responses": {}, - "securityDefinitions": { - "API Key": { - "type": "apiKey", - "in": "header", - "name": "X-Auth-Key" - } - }, - "security": [ - { - "API Key": [] - } - ], - "tags": [], - "x-ms-openai-manifest": { - "humanName": "", - "modelDescription": "" - } -} \ No newline at end of file From 1b90173489adb9e708010d3fd049ca593c24a8a4 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 15:27:59 +0000 Subject: [PATCH 13/31] Delete independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json --- .../apiProperties.json | 66 ------------------- 1 file changed, 66 deletions(-) delete mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json deleted file mode 100644 index 64ebab3060..0000000000 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/apiProperties.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "properties": { - "connectionParameters": { - "x-Auth-Email": { - "type": "string", - "uiDefinition": { - "displayName": "Email Address", - "description": "The Email Address registered for this api", - "tooltip": "Provide your Email Address associated with this api", - "constraints": { - "required": "true" - } - } - }, - "api_key": { - "type": "securestring", - "uiDefinition": { - "displayName": "API Key", - "description": "The API Key for this api", - "tooltip": "Provide your API Key", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" - } - } - } - }, - "iconBrandColor": "#da3b01", - "capabilities": [], - "policyTemplateInstances": [ - { - "templateId": "setheader", - "title": "X-Auth-Email", - "parameters": { - "x-ms-apimTemplateParameter.name": "X-Auth-Email", - "x-ms-apimTemplateParameter.value": "@connectionParameters('X-Auth-Email')", - "x-ms-apimTemplateParameter.existsAction": "append", - "x-ms-apimTemplate-policySection": "Request", - "x-ms-apimTemplate-operationName": [ - "CommonSearch", - "IndividualsDetailsByIRN", - "IndividualDisciplinaryHistoryByIRN", - "FirmDetailsByFRN", - "SubfundDetailsByPRN", - "ProductOtherNameDetailsByPRN", - "FirmOtherNamesByFRN", - "FirmAddressByFRN", - "FirmIndividualsByFRN", - "FirmActivitiesAndPermissionsByFRN", - "FirmRequirementsByFRN", - "FirmRequirementsInvestmentTypesByFRNandREQREF", - "FirmRegulatorsByFRN", - "FirmPassportByFRN", - "FirmPassportPermissionByFRNandCountry", - "FirmWaiverByFRN", - "FirmExclusionsByFRN", - "FirmDisciplinaryHistoryByFRN" - ] - } - } - ], - "publisher": "Gulshan Khurana", - "stackOwner": "Financial Conduct Authority" - } -} \ No newline at end of file From 1520277217d23ab6aa0704ca0b6f30d1daa07aea Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:25:48 +0000 Subject: [PATCH 14/31] Rename ReadME.md to ReadME.md --- .../ReadME.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename independent-publisher-connectors/{Financial Conduct Authority (FCA) UK Connector => FInancial Conduct Authority (FCA) UK Connector}/ReadME.md (100%) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md similarity index 100% rename from independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md rename to independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md From 68f75aad62efd615f395c664df147cefed4eea33 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:32:19 +0000 Subject: [PATCH 15/31] Delete independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md --- .../ReadME.md | 47 ------------------- 1 file changed, 47 deletions(-) delete mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md deleted file mode 100644 index d926878d87..0000000000 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ /dev/null @@ -1,47 +0,0 @@ -# FCA Connector - -The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. - -# Publisher: Gulshan Khurana - -## Prerequisites - -You will need the following to proceed: -* A Microsoft Power Apps or Power Automate plan with custom connector feature -* An API key obtained [here](https://register.fca.org.uk/Developer/s/) and the email address used for registration - -## Supported Operations - -The connector supports the following operations: -* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number -* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number -* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number -* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number -* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number -* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number -* `Firm Address`: Get information about a specific firm using its Firm Reference Number -* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number -* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number -* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number -* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference -* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number -* `Firm Passport`: Get information about a passport details by using its Firm Reference Number -* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country -* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number -* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number -* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number - - -## Obtaining Credentials - -An API key and email address is required for this connector to work. You can sign up for free with an account on FCA's website [here](https://register.fca.org.uk/Developer/s/registernewuser) - -## Known issues and limitations - -There are no known issues with this connector. There are functions in the API not implemented in this connector and I will continue to work on these if I can resolve the functions/syntax. - -## Deployment Instructions - -Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. - -Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From 36f1990fc194ef6394c183928f216551cebf21b0 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:38:23 +0000 Subject: [PATCH 16/31] Added ReadME.md file --- .../ReadME.md | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md new file mode 100644 index 0000000000..d926878d87 --- /dev/null +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md @@ -0,0 +1,47 @@ +# FCA Connector + +The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. + +# Publisher: Gulshan Khurana + +## Prerequisites + +You will need the following to proceed: +* A Microsoft Power Apps or Power Automate plan with custom connector feature +* An API key obtained [here](https://register.fca.org.uk/Developer/s/) and the email address used for registration + +## Supported Operations + +The connector supports the following operations: +* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number +* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number +* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number +* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number +* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number +* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number +* `Firm Address`: Get information about a specific firm using its Firm Reference Number +* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number +* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number +* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number +* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference +* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number +* `Firm Passport`: Get information about a passport details by using its Firm Reference Number +* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country +* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number +* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number +* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number + + +## Obtaining Credentials + +An API key and email address is required for this connector to work. You can sign up for free with an account on FCA's website [here](https://register.fca.org.uk/Developer/s/registernewuser) + +## Known issues and limitations + +There are no known issues with this connector. There are functions in the API not implemented in this connector and I will continue to work on these if I can resolve the functions/syntax. + +## Deployment Instructions + +Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. + +Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From 6e34d969d33589aa2037a18a5d2589bfd1b865b6 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:39:47 +0000 Subject: [PATCH 17/31] Rename ReadME.md to ReadME.md --- .../ReadME.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename independent-publisher-connectors/{Financial Conduct Authority (FCA) UK Connector => FInancial Conduct Authority (FCA) UK Connector}/ReadME.md (100%) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md similarity index 100% rename from independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md rename to independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md From a22edb4d3cb9a987dcf4947178bd41bdb78d0016 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:41:08 +0000 Subject: [PATCH 18/31] Add files via upload --- .../ReadME.md | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md new file mode 100644 index 0000000000..d926878d87 --- /dev/null +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md @@ -0,0 +1,47 @@ +# FCA Connector + +The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. + +# Publisher: Gulshan Khurana + +## Prerequisites + +You will need the following to proceed: +* A Microsoft Power Apps or Power Automate plan with custom connector feature +* An API key obtained [here](https://register.fca.org.uk/Developer/s/) and the email address used for registration + +## Supported Operations + +The connector supports the following operations: +* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number +* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number +* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number +* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number +* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number +* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number +* `Firm Address`: Get information about a specific firm using its Firm Reference Number +* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number +* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number +* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number +* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference +* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number +* `Firm Passport`: Get information about a passport details by using its Firm Reference Number +* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country +* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number +* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number +* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number + + +## Obtaining Credentials + +An API key and email address is required for this connector to work. You can sign up for free with an account on FCA's website [here](https://register.fca.org.uk/Developer/s/registernewuser) + +## Known issues and limitations + +There are no known issues with this connector. There are functions in the API not implemented in this connector and I will continue to work on these if I can resolve the functions/syntax. + +## Deployment Instructions + +Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. + +Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From 9b44834c5a251aeb348ce1e34168a4aa14922dfd Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:42:39 +0000 Subject: [PATCH 19/31] Delete independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector directory --- .../ReadME.md | 47 ------------------- 1 file changed, 47 deletions(-) delete mode 100644 independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md diff --git a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md deleted file mode 100644 index d926878d87..0000000000 --- a/independent-publisher-connectors/FInancial Conduct Authority (FCA) UK Connector/ReadME.md +++ /dev/null @@ -1,47 +0,0 @@ -# FCA Connector - -The Financial Conduct Authority (FCA) is a financial regulatory body in the United Kingdom. Their website allows people to search the Financial Services Register for firms and individuals and the activities firms have permissions for. The Financial Services Register is a public record of firms, individuals and other bodies that are authorised by the Prudential Regulation Authority (PRA) and/or FCA. The website can be used by anyone, looking to gather information. - -# Publisher: Gulshan Khurana - -## Prerequisites - -You will need the following to proceed: -* A Microsoft Power Apps or Power Automate plan with custom connector feature -* An API key obtained [here](https://register.fca.org.uk/Developer/s/) and the email address used for registration - -## Supported Operations - -The connector supports the following operations: -* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number -* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number -* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number -* `Subfund Details`: Get information about subfund of a product by using its Product Reference Number -* `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number -* `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number -* `Firm Address`: Get information about a specific firm using its Firm Reference Number -* `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number -* `Firm Activities and Permissions`: Get information about the activities and permissions associated with a specific firm using its Firm Reference Number -* `Firm Requirements`: Get information about the requirements associated with a specific firm using its Firm Reference Number -* `Firm Requirements Investment Types`: Get information about the investment types associated with a specific firm requirement using its Firm Reference Number and Requirement Reference -* `Firm Regulators`: Get information about a regulator on a firm using its Firm Reference Number -* `Firm Passport`: Get information about a passport details by using its Firm Reference Number -* `Firm Passport Permission`: Get information about a passport permission by using its Firm Reference Number and Country -* `Firm Exclusions`: Get information about an Exclusion on a firm using its Firm Reference Number -* `Firm Disciplinary History`: Get information about a Disciplinary History on a firm using its Firm Reference Number -* `Firm Waiver`: Get information about a Waiver on a firm using its Firm Reference Number - - -## Obtaining Credentials - -An API key and email address is required for this connector to work. You can sign up for free with an account on FCA's website [here](https://register.fca.org.uk/Developer/s/registernewuser) - -## Known issues and limitations - -There are no known issues with this connector. There are functions in the API not implemented in this connector and I will continue to work on these if I can resolve the functions/syntax. - -## Deployment Instructions - -Upload the connector and create a connection using the API key along with the registered email address from the prerequisites. - -Go to the 'Definition' section of the connector (in edit mode), click on 'X-Auth-Email' policy under 'Policies' and ensure that, in 'Operations' field in the Policy Details that emerge on the screen, all operations listed there are ticked/checked. From 2aceeb96b83d1ad3ba5ea4d4ddb833a7c04cb3d9 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Sat, 20 Apr 2024 22:53:59 +0100 Subject: [PATCH 20/31] Update apiDefinition.swagger.json Updated the title and description --- .../apiDefinition.swagger.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json index 976ded7c32..9408f08148 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "FCA", - "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA)", + "title": "Financial Conduct Authority (FCA) UK", + "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA) in the UK", "version": "1.0", "contact": { "name": "Gulshan Khurana", @@ -2168,4 +2168,4 @@ "humanName": "", "modelDescription": "" } -} \ No newline at end of file +} From 98ed72e5ecc3b274118353b493cf28f84d6f479a Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:05:10 +0100 Subject: [PATCH 21/31] Update apiDefinition.swagger.json Truncated the title to keep it 30 characters long --- .../apiDefinition.swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json index 9408f08148..a40ac81863 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Financial Conduct Authority (FCA) UK", + "title": "Financial Conduct Authority UK", "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA) in the UK", "version": "1.0", "contact": { From 269ab223c278ca732e2f54f7e0461d402e3e70ca Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:07:57 +0100 Subject: [PATCH 22/31] Update apiDefinition.swagger.json Truncated the title length to 30 characters From 347e4c1b6108aa32d478d3eae38c487c85f00688 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 16 May 2024 00:41:00 +0100 Subject: [PATCH 23/31] Update ReadME.md * Fixed 'Common Search' action * Added 'Find Firm Details' action * Added 'Find Product Details' action --- .../ReadME.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md index d926878d87..60ddeb1c62 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/ReadME.md @@ -13,11 +13,13 @@ You will need the following to proceed: ## Supported Operations The connector supports the following operations: -* `Common Search`: Search the Financial Services Register for a firm or an individual by name or unique reference number -* `Find Individuals Details`: Get information about the Individuals associated with its Individual Reference Number -* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number +* `Common Search`: Search the Financial Services Register for a firm or an individual or a fund (collective investment scheme) by name or unique reference number +* `Find Individuals Details`: Get information about an Individual associated with its Individual Reference Number +* `Find Firm Details`: Get information about a specific firm using its Firm Reference Number +* `Find Product Details`: Get information about a specific product using its Product Reference Number * `Subfund Details`: Get information about subfund of a product by using its Product Reference Number * `Product Other Name Details`: Get information about other names of a product by using its Product Reference Number +* `Individual Disciplinary History`: Get information about Disciplinary History on an Individual using its Individual Reference Number * `Firm Other Names`: Get information about the other names used by the firms using its Firm Reference Number * `Firm Address`: Get information about a specific firm using its Firm Reference Number * `Firm Individuals`: Get information about the Individuals associated with a firm using its Firm Reference Number From 83bb4cd01edf06c7250a1dd10ae0858e330e9e8c Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 16 May 2024 00:59:35 +0100 Subject: [PATCH 24/31] Update apiProperties.json Updated apiProperties.json file --- .../apiProperties.json | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json index a8e1908261..af9c3326bd 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiProperties.json @@ -40,21 +40,23 @@ "x-ms-apimTemplate-operationName": [ "CommonSearch", "IndividualsDetailsByIRN", - "IndividualDisciplinaryHistoryByIRN", + "FirmDetailsByFRN", + "ProductDetailsByPRN", "SubfundDetailsByPRN", "ProductOtherNameDetailsByPRN", + "IndividualDisciplinaryHistoryByIRN", "FirmOtherNamesByFRN", "FirmAddressByFRN", "FirmIndividualsByFRN", "FirmActivitiesAndPermissionsByFRN", - "FirmRequirementsByFRN", "FirmRequirementsInvestmentTypesByFRNandREQREF", "FirmRegulatorsByFRN", "FirmPassportByFRN", - "FirmPassportPermissionByFRNandCountry", - "FirmWaiverByFRN", "FirmExclusionsByFRN", - "FirmDisciplinaryHistoryByFRN" + "FirmDisciplinaryHistoryByFRN", + "FirmRequirementsByFRN", + "FirmWaiverByFRN", + "FirmPassportPermissionByFRNandCountry" ] } } From ff0a70a914108164df0bf9fa781500d6f70cda09 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 16 May 2024 01:00:47 +0100 Subject: [PATCH 25/31] Update apiDefinition.swagger.json Updated apiDefinition.swagger.json --- .../apiDefinition.swagger.json | 306 +++++++++++++++--- 1 file changed, 264 insertions(+), 42 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json index a40ac81863..a46538f5de 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -29,7 +29,7 @@ "Status": { "type": "string", "description": "Status", - "title": "", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -38,19 +38,19 @@ "page": { "type": "string", "description": "page", - "title": "", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", "description": "per_page", - "title": "", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", "description": "total_count", - "title": "", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -59,7 +59,7 @@ "Message": { "type": "string", "description": "Message", - "title": "", + "title": "Message", "x-ms-visibility": "internal" }, "Data": { @@ -89,7 +89,7 @@ }, "Name": { "type": "string", - "description": "The name of the firm or individual", + "description": "The name of the firm or individual or collective investment scheme", "title": "Name" } } @@ -107,23 +107,38 @@ { "name": "q", "in": "query", - "required": false, + "required": true, "type": "string", "description": "Query String", - "x-ms-summary": "Query String" + "x-ms-summary": "Query String", + "x-ms-visibility": "advanced" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "individual", + "firm", + "fund" + ], + "description": "type", + "x-ms-summary": "type" }, { "name": "X-Auth-Email", "in": "header", "required": false, "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, - "/services/V0.1/Individuals/{q}": {}, "/services/V0.1/Individuals/{IRN}": { "get": { "responses": { @@ -234,7 +249,7 @@ } }, "summary": "Find Individuals Details", - "description": "Get information about the Individuals associated with its Individual Reference Number", + "description": "Get information about an Individual associated with its Individual Reference Number", "operationId": "IndividualsDetailsByIRN", "parameters": [ { @@ -269,8 +284,7 @@ "Status": { "type": "string", "description": "Status", - "title": "", - "x-ms-visibility": "internal" + "title": "Status" }, "ResultInfo": { "type": "object", @@ -278,20 +292,17 @@ "page": { "type": "string", "description": "page", - "title": "", - "x-ms-visibility": "internal" + "title": "page" }, "per_page": { "type": "string", "description": "per_page", - "title": "", - "x-ms-visibility": "internal" + "title": "per_page" }, "total_count": { "type": "string", "description": "total_count", - "title": "", - "x-ms-visibility": "internal" + "title": "total_count" } }, "description": "ResultInfo" @@ -299,8 +310,7 @@ "Message": { "type": "string", "description": "Message", - "title": "", - "x-ms-visibility": "internal" + "title": "Message" }, "Data": { "type": "array", @@ -322,10 +332,10 @@ "description": "URL to fetch associated requirements of the firm", "title": "Requirements" }, - "Permissions": { + "Permission": { "type": "string", "description": "URL to fetch the associated permissions of the firm", - "title": "Permissions" + "title": "Permission" }, "Passport": { "type": "string", @@ -387,22 +397,94 @@ "Status Effective Date": { "type": "string", "description": "The effective date when the status was active from", - "title": "Status Effective Date" + "title": "Status Effective Date", + "x-ms-visibility": "important" + }, + "E-Money Agent Status": { + "type": "string", + "description": "Status as an E-Money Agent", + "title": "E-Money Agent Status" + }, + "PSD / EMD Effective Date": { + "type": "string", + "description": "Date from which the PSD/EMD Status was effective", + "title": "PSD / EMD Effective Date" + }, + "Client Money Permission": { + "type": "string", + "description": "Permission of the firm in relation to Client Money", + "title": "Client Money Permission" + }, + "Sub Status Effective from": { + "type": "string", + "description": "Date from which the Sub-status was effective", + "title": "Sub Status Effective from" + }, + "Sub-Status": { + "type": "string", + "description": "Related sub-status to the firms status", + "title": "Sub-Status" + }, + "Mutual Society Number": { + "type": "string", + "description": "Registered number as a Mutual Society", + "title": "Mutual Society Number" + }, + "Companies House Number": { + "type": "string", + "description": "Registered number with Companies House", + "title": "Companies House Number" + }, + "MLRs Status Effective Date": { + "type": "string", + "description": "Date from which the MLRs Status was effective", + "title": "MLRs Status Effective Date" + }, + "MLRs Status": { + "type": "string", + "description": "Status under the Money Laundering Regulations", + "title": "MLRs Status" + }, + "E-Money Agent Effective Date": { + "type": "string", + "description": "Date from which the E-Money Agent Status was effective", + "title": "E-Money Agent Effective Date" + }, + "PSD Agent Effective date": { + "type": "string", + "description": "Date from which the PSD Agent Status was effective", + "title": "PSD Agent Effective date" + }, + "PSD Agent Status": { + "type": "string", + "description": "Status as a PSD Agent", + "title": "PSD Agent Status" + }, + "PSD / EMD Status": { + "type": "string", + "description": "Status under the Payment Services Directive or the Electronic Money Directive", + "title": "PSD / EMD Status" }, "Status": { "type": "string", - "description": "Register Status for the firm", - "title": "Status" + "description": "Register Status for the firm /Authorised", + "title": "Status", + "x-ms-visibility": "important" }, "Business Type": { "type": "string", - "description": "The type of the firm", + "description": "The type of the firm /Regulated", "title": "Business Type" }, "Organisation Name": { "type": "string", "description": "Name of the firm", "title": "Organisation Name" + }, + "FRN": { + "type": "string", + "description": "FCA Firm Reference Number", + "title": "FRN" } } }, @@ -415,6 +497,7 @@ "summary": "Find Firm Details", "description": "Get information about a specific firm using its Firm Reference Number", "operationId": "FirmDetailsByFRN", + "x-ms-visibility": "important", "parameters": [ { "name": "FRN", @@ -433,11 +516,150 @@ "x-ms-summary": "Email address associated with your account", "x-ms-visibility": "internal" } - ], - "x-ms-visibility": "important" + ] + } + }, + "/services/V0.1/CIS/{PRN}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "Status": { + "type": "string", + "description": "Status" + }, + "ResultInfo": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "page", + "title": "page" + }, + "per_page": { + "type": "string", + "description": "per_page", + "title": "per_page" + }, + "total_count": { + "type": "string", + "description": "total_count", + "title": "per_page" + } + }, + "description": "ResultInfo" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message" + }, + "Data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Sub-funds": { + "type": "string", + "description": "Display the sub fund information", + "title": "Sub-funds" + }, + "Other Name": { + "type": "string", + "description": "Display the other name information", + "title": "Other Name" + }, + "CIS Depositary": { + "type": "string", + "description": "Display CIS depositary information", + "title": "CIS Depositary" + }, + "CIS Depositary Name": { + "type": "string", + "description": "Display CIS depositary name information", + "title": "CIS Depositary Name" + }, + "Operator Name": { + "type": "string", + "description": "Display the operator name information", + "title": "Operator Name" + }, + "Operator": { + "type": "string", + "description": "Display the operator information", + "title": "Operator" + }, + "MMF Term Type": { + "type": "string", + "description": "Display the MMF Term Type information", + "title": "MMF Term Type" + }, + "MMF NAV Type": { + "type": "string", + "description": "Display the MMF NAV Type information", + "title": "MMF NAV Type" + }, + "Effective Date": { + "type": "string", + "description": "Display the Effective Date information", + "title": "Effective Date" + }, + "Scheme Type": { + "type": "string", + "description": "Display the Scheme Type information", + "title": "Scheme Type" + }, + "Product Type": { + "type": "string", + "description": "Display the Product Type information", + "title": "Product Type" + }, + "ICVC Registration No": { + "type": "string", + "description": "Display the ICVC Registration No information", + "title": "ICVC Registration No" + }, + "Status": { + "type": "string", + "description": "Display the Status information", + "title": "Status" + } + } + }, + "description": "Data" + } + } + } + } + }, + "summary": "Find Product Details", + "description": "Get information about a product by using its Product Reference Number", + "operationId": "ProductDetailsByPRN", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "PRN", + "in": "path", + "required": true, + "type": "string", + "description": "FCA Product Reference Number", + "x-ms-summary": "PRN" + }, + { + "name": "X-Auth-Email", + "in": "header", + "required": false, + "type": "string", + "description": "Email address associated with your account to be passed in Header", + "x-ms-summary": "Email address associated with your account", + "x-ms-visibility": "internal" + } + ] } }, - "/services/V0.1/CIS/{PRN}": {}, "/services/V0.1/CIS/{PRN}/Subfund": { "get": { "responses": { @@ -449,7 +671,7 @@ "Status": { "type": "string", "description": "Status", - "title": "", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -458,19 +680,19 @@ "page": { "type": "string", "description": "page", - "title": "", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", "description": "per_page", - "title": "", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", "description": "total_count", - "title": "", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -479,7 +701,7 @@ "Message": { "type": "string", "description": "Message", - "title": "", + "title": "Message", "x-ms-visibility": "internal" }, "Data": { @@ -681,17 +903,17 @@ "properties": { "TypeofDescription": { "type": "string", - "description": "Display the final notice information of Disciplinary history", + "description": "Display the final notice information of Disciplinary history", "title": "TypeofDescription" }, "TypeofAction": { "type": "string", - "description": "Display the Type of Action information of Disciplinary history", + "description": "Display the Type of Action information of Disciplinary history", "title": "TypeofAction" }, "EnforcementType": { "type": "string", - "description": "Display the Enforcement Type information of Disciplinary history", + "description": "Display the Enforcement Type information of Disciplinary history", "title": "EnforcementType" }, "ActionEffectiveFrom": { @@ -983,7 +1205,7 @@ }, "summary": "Firm Address", "operationId": "FirmAddressByFRN", - "description": "Get information about a specific firm using its Firm Reference Number", + "description": "Get information about a specific firm's addresses using its Firm Reference Number", "parameters": [ { "name": "FRN", @@ -1750,22 +1972,22 @@ "properties": { "TypeofDescription": { "type": "string", - "description": "Display the final notice information of Disciplinary history", + "description": "Display the final notice information of Disciplinary history", "title": "TypeofDescription" }, "TypeofAction": { "type": "string", - "description": "Display the Type of Action information of Disciplinary history", + "description": "Display the Type of Action information of Disciplinary history", "title": "TypeofAction" }, "EnforcementType": { "type": "string", - "description": "Display the Enforcement Type information of Disciplinary history", + "description": "Display the Enforcement Type information of Disciplinary history", "title": "EnforcementType" }, "ActionEffectiveFrom": { "type": "string", - "description": "Display the Action Date information of Disciplinary history", + "description": "Display the Action Date information of Disciplinary history", "title": "ActionEffectiveFrom" } } From 553c69b4b6a1d280951112fa8152a843213ab287 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Thu, 16 May 2024 01:07:01 +0100 Subject: [PATCH 26/31] Update apiDefinition.swagger.json --- .../apiDefinition.swagger.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json index a46538f5de..bb7141e8d2 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -467,13 +467,13 @@ }, "Status": { "type": "string", - "description": "Register Status for the firm /Authorised", + "description": "Register Status for the firm", "title": "Status", "x-ms-visibility": "important" }, "Business Type": { "type": "string", - "description": "The type of the firm /Regulated", + "description": "The type of the firm", "title": "Business Type" }, "Organisation Name": { From f28470efe442a35333ef11227230164b0b46372e Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Tue, 21 May 2024 16:36:27 +0100 Subject: [PATCH 27/31] Update apiDefinition.swagger.json --- .../apiDefinition.swagger.json | 283 +++++++++--------- 1 file changed, 145 insertions(+), 138 deletions(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json index bb7141e8d2..fcecb830da 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -28,7 +28,7 @@ "properties": { "Status": { "type": "string", - "description": "Status", + "description": "The status of the record", "title": "Status", "x-ms-visibility": "internal" }, @@ -37,19 +37,19 @@ "properties": { "page": { "type": "string", - "description": "page", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", + "description": "The number of records returned per page", "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", + "description": "The total number of records returned by the request. For firm details it will be only 1", "title": "total_count", "x-ms-visibility": "internal" } @@ -75,7 +75,8 @@ "Status": { "type": "string", "description": "The status of the record", - "title": "Status" + "title": "Status", + "x-ms-visibility": "internal" }, "Reference Number": { "type": "string", @@ -149,8 +150,8 @@ "properties": { "Status": { "type": "string", - "description": "Status Code", - "title": "Status Code", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -193,8 +194,9 @@ "properties": { "Status": { "type": "string", - "description": "The status of the individual", - "title": "Status" + "description": "The status of the record", + "title": "Status", + "x-ms-visibility": "internal" }, "Disciplinary History": { "type": "string", @@ -283,26 +285,29 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "Status" + "description": "The status of the record", + "title": "Status", + "x-ms-visibility": "internal" }, "ResultInfo": { "type": "object", "properties": { "page": { "type": "string", - "description": "page", - "title": "page" + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", + "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", + "description": "The number of records returned per page", "title": "per_page" }, "total_count": { "type": "string", - "description": "total_count", - "title": "total_count" + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", + "x-ms-visibility": "internal" } }, "description": "ResultInfo" @@ -467,13 +472,13 @@ }, "Status": { "type": "string", - "description": "Register Status for the firm", + "description": "Register Status for the firm /Authorised", "title": "Status", "x-ms-visibility": "important" }, "Business Type": { "type": "string", - "description": "The type of the firm", + "description": "The type of the firm /Regulated", "title": "Business Type" }, "Organisation Name": { @@ -536,18 +541,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "page" + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", + "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", + "description": "The number of records returned per page", "title": "per_page" }, "total_count": { "type": "string", - "description": "total_count", - "title": "per_page" + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", + "x-ms-visibility": "internal" } }, "description": "ResultInfo" @@ -670,7 +677,7 @@ "properties": { "Status": { "type": "string", - "description": "Status", + "description": "The status of the record", "title": "Status", "x-ms-visibility": "internal" }, @@ -679,19 +686,19 @@ "properties": { "page": { "type": "string", - "description": "page", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", + "description": "The number of records returned per page", "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", + "description": "The total number of records returned by the request. For firm details it will be only 1", "title": "total_count", "x-ms-visibility": "internal" } @@ -766,8 +773,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -775,20 +782,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -862,8 +869,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -871,20 +878,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -963,8 +970,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -978,20 +985,20 @@ }, "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1096,8 +1103,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1105,20 +1112,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1237,8 +1244,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1252,20 +1259,20 @@ }, "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1344,8 +1351,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1353,20 +1360,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1535,8 +1542,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1544,20 +1551,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1629,8 +1636,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1638,20 +1645,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1725,8 +1732,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1740,20 +1747,20 @@ }, "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1835,7 +1842,7 @@ "properties": { ";Status": { "type": "string", - "description": "Status", + "description": "The status of the record", "title": "Status", "x-ms-visibility": "internal" }, @@ -1844,20 +1851,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -1931,8 +1938,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -1940,20 +1947,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -2032,8 +2039,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -2041,20 +2048,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -2138,8 +2145,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -2147,20 +2154,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, @@ -2236,8 +2243,8 @@ "properties": { "Status": { "type": "string", - "description": "Status", - "title": "", + "description": "The status of the record", + "title": "Status", "x-ms-visibility": "internal" }, "ResultInfo": { @@ -2245,20 +2252,20 @@ "properties": { "page": { "type": "string", - "description": "page", - "title": "", + "description": "The page number of the request, when the data returned is in page, it returns the current page. For account details, it will be 1", + "title": "page", "x-ms-visibility": "internal" }, "per_page": { "type": "string", - "description": "per_page", - "title": "", + "description": "The number of records returned per page", + "title": "per_page", "x-ms-visibility": "internal" }, "total_count": { "type": "string", - "description": "total_count", - "title": "", + "description": "The total number of records returned by the request. For firm details it will be only 1", + "title": "total_count", "x-ms-visibility": "internal" } }, From cec8f1bf177095a5d6a660ddfb425791d870a88c Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Tue, 21 May 2024 16:42:52 +0100 Subject: [PATCH 28/31] Update apiProperties.json From fbe31e3dd7203f42799675472922bae590af0853 Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Wed, 22 May 2024 15:56:50 +0100 Subject: [PATCH 29/31] Update apiDefinition.swagger.json Changed the name back to 'FCA' as it was initially. --- .../apiDefinition.swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json index fcecb830da..6bab2c39c8 100644 --- a/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Financial Conduct Authority (FCA) UK Connector/apiDefinition.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Financial Conduct Authority UK", + "title": "FCA", "description": "The online Financial Services Register is a public record of financial services firms, individuals and other bodies regulated by the Financial Conduct Authority (FCA) in the UK", "version": "1.0", "contact": { From 1916611639250b320cbc363d4a393dd2d769b06a Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Sat, 22 Jun 2024 17:06:29 +0100 Subject: [PATCH 30/31] Create README.md --- .../README.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 independent-publisher-connectors/Proposal - Securities and Exchange Commission USA (Independent Publisher)/README.md diff --git a/independent-publisher-connectors/Proposal - Securities and Exchange Commission USA (Independent Publisher)/README.md b/independent-publisher-connectors/Proposal - Securities and Exchange Commission USA (Independent Publisher)/README.md new file mode 100644 index 0000000000..edeb96622c --- /dev/null +++ b/independent-publisher-connectors/Proposal - Securities and Exchange Commission USA (Independent Publisher)/README.md @@ -0,0 +1,21 @@ +# Securities and Exchange Commission (SEC) USA + +Electronic Data Gathering, Analysis, and Retrieval (EDGAR) is an online database of public filings maintained by the Securities and Exchange Commission (SEC). The EDGAR database provides free public access to corporate information, allowing you to research a public company’s financial information and operations by reviewing the filings the company makes with the SEC. +## Publisher: Gulshan Khurana + +## Prerequisites +Use of this service does not require any authentication or API keys to access +## Supported Operations + +### Retrieve Filing History + +### Extract XBRL Data - Company Concepts + +### Extract XBRL Data - Company Facts + +### Extract XBRL Data - Frames + + + +## Known Issues and Limitations +SEC's current guidelines limit each user to a total of no more than 10 requests per second, regardless of the number of machines used to submit requests. From 3a698bbd48ca6c3955b905e1349096320781183f Mon Sep 17 00:00:00 2001 From: Gulshan Khurana <67651578+gulshankhurana@users.noreply.github.com> Date: Sat, 22 Jun 2024 17:07:23 +0100 Subject: [PATCH 31/31] Update README.md