Investors
This section has operations to manage investors, i.e. showing, adding, encrypting, and removing investors
Returns all investors
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve all investors.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getInvestors |
parameters | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
depryption_key | string | no | For decrypting personally identifiable information |
user_identifier | string | no | For limiting the output to the investors that the user has access to |
Example code
Generates a random investor identifier
POST
https://api.bws.ninja/v1/call
Use this operation to generate investor identifiers, for cases where they need to random and not personally identifiable information (PII).
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | generateInvestorIdentifier |
Example responses
Example code
Generates an encryption key used to encrypt personal identifiable information
POST
https://api.bws.ninja/v1/call
Use this operation to generate an encryption, used to encrypt and decrypt personally identiable infomation (PII) in the data repository of ESG.Credits.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | generateEncryptionKey |
Example responses
Example code
Creates and updates the information of an existing investor
POST
https://api.bws.ninja/v1/call
Use this operation to create investors stored in ESG.Credits. Is also used to alter already existing investor data.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addInvestor |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor, potentially personally identifiable information (subject to encryption) |
investor_name | string | yes | Personally identiable information (subject to encryption) |
investor_currency_code | string | yes | Currency code of the investor, as per getCurrencies (currently not utilized) |
investor_email | string | no | For investor correspondence e.g investor reports |
encryption_key | string | no | For encrypting personally identifiable information |
Example code
Removes an investor
POST
https://api.bws.ninja/v1/call
Use this operation to remove investors from the ESG.Credits data repository.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Creditd |
operation* | string | removeInvestor |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
Example code
Last updated