Update Shareholder

'UpdateShareHolder' API enables to update the existing shareholders of business customer

Bank or financial institution can update existing shareholders of business customer, if required. On providing the details to be updated as request, the shareholder information is updated.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
Id Mandatory	String System generated ID assigned to the shareholder Sample value – "2574004"
customerId Mandatory	String Unique ID of the customer whose shareholder details are updated Sample value – "100000000007001"
name Mandatory	String Name of the shareholder for whom the details to be updated Sample value – "John"
identification Mandatory	Object
type Mandatory	String Identification type of the shareholder Constant value – "SSN"
value Mandatory	String Value of the Identification type Sample value – "334134545"
contact Mandatory	Object
email Optional	String Contact email ID of the shareholder Sample value – "john@gmail.com"
phoneNumber Mandatory	String Contact phone number of the shareholder Sample value – "87559855"
address Mandatory	Object
country Mandatory	String Country code of shareholder address Sample value – "US"
addressLine1 Mandatory	String First line of shareholder address Sample value – "BLOCK 8"
addressLine2 Optional	String Second line of shareholder address Sample value – "103,MainRoad,Kansas,USA"
city Mandatory	String Second line of shareholder address Sample value – "Kansas"
state Mandatory	String State or region name of shareholder address Sample value – "AZ"
zip Mandatory	String Zip code of shareholder address Sample value – "63810"
Status Optional	Enum Status of the shareholder Valid values: ENABLED DISABLED Sample value: "ENABLED"
ownershipPercent Optional	String Business ownership percentage of shareholder Sample value – "14.6"
DOB Optional	String Date of Birth of shareholder in YYYYMMDD format Sample value – "19830119"

cURL

curl --location --globoff --request GET '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"method":"CustomerService.UpdateShareHolder","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}","apiKey":"{{ApiKey}}"},"payload":{"id":"2574004","customerId":"100000000007001","name":"John","identification":{"type":"SSN","value":"334134545"},"contact":{"email":"john@gmail.com","phoneNumber":"87559855"},"address":{"country":"US","addressLine1":"BLOCK 8,","addressLine2":"103,MainRoad,Kansas,USA","city":"Kansas","state":"AZ","zip":"63810"},"Status":"ENABLED","ownershipPercent":"14.6","DOB":"19830119"}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""CustomerService.UpdateShareHolder"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"            ""credential"": ""{{Credential}}"",
" + "\n" +
@"            ""apiKey"": ""{{ApiKey}}""
" + "\n" +
@"        },
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""id"": ""2574004"",
" + "\n" +
@"            ""customerId"": ""100000000007001"",
" + "\n" +
@"            ""name"": ""John"",
" + "\n" +
@"            ""identification"": {
" + "\n" +
@"                ""type"": ""SSN"",
" + "\n" +
@"                ""value"": ""334134545""
" + "\n" +
@"            },
" + "\n" +
@"            ""contact"": {
" + "\n" +
@"                ""email"": ""john@gmail.com"",
" + "\n" +
@"                ""phoneNumber"": ""87559855""
" + "\n" +
@"            },
" + "\n" +
@"            ""address"": {
" + "\n" +
@"                ""country"": ""US"",
" + "\n" +
@"                ""addressLine1"": ""BLOCK 8,"",
" + "\n" +
@"                ""addressLine2"": ""103,MainRoad,Kansas,USA"",
" + "\n" +
@"                ""city"": ""Kansas"",
" + "\n" +
@"                ""state"": ""AZ"",
" + "\n" +
@"                ""zip"": ""63810""
" + "\n" +
@"            },
" + "\n" +
@"            ""Status"": ""ENABLED"",
" + "\n" +
@"            ""ownershipPercent"": ""14.6"",
" + "\n" +
@"            ""DOB"": ""19830119""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "GET"

  payload := strings.NewReader(`{`+"
"+`
    "method": "CustomerService.UpdateShareHolder",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "keyId": "{{ApplicationKeyId}}",`+"
"+`
            "credential": "{{Credential}}",`+"
"+`
            "apiKey": "{{ApiKey}}"`+"
"+`
        },`+"
"+`
        "payload": {`+"
"+`
            "id": "2574004",`+"
"+`
            "customerId": "100000000007001",`+"
"+`
            "name": "John",`+"
"+`
            "identification": {`+"
"+`
                "type": "SSN",`+"
"+`
                "value": "334134545"`+"
"+`
            },`+"
"+`
            "contact": {`+"
"+`
                "email": "john@gmail.com",`+"
"+`
                "phoneNumber": "87559855"`+"
"+`
            },`+"
"+`
            "address": {`+"
"+`
                "country": "US",`+"
"+`
                "addressLine1": "BLOCK 8,",`+"
"+`
                "addressLine2": "103,MainRoad,Kansas,USA",`+"
"+`
                "city": "Kansas",`+"
"+`
                "state": "AZ",`+"
"+`
                "zip": "63810"`+"
"+`
            },`+"
"+`
            "Status": "ENABLED",`+"
"+`
            "ownershipPercent": "14.6",`+"
"+`
            "DOB": "19830119"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJS

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "CustomerService.UpdateShareHolder",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}",
      "apiKey": "{{ApiKey}}"
    },
    "payload": {
      "id": "2574004",
      "customerId": "100000000007001",
      "name": "John",
      "identification": {
        "type": "SSN",
        "value": "334134545"
      },
      "contact": {
        "email": "john@gmail.com",
        "phoneNumber": "87559855"
      },
      "address": {
        "country": "US",
        "addressLine1": "BLOCK 8,",
        "addressLine2": "103,MainRoad,Kansas,USA",
        "city": "Kansas",
        "state": "AZ",
        "zip": "63810"
      },
      "Status": "ENABLED",
      "ownershipPercent": "14.6",
      "DOB": "19830119"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "CustomerService.UpdateShareHolder",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}",
      "apiKey": "{{ApiKey}}"
    },
    "payload": {
      "id": "2574004",
      "customerId": "100000000007001",
      "name": "John",
      "identification": {
        "type": "SSN",
        "value": "334134545"
      },
      "contact": {
        "email": "john@gmail.com",
        "phoneNumber": "87559855"
      },
      "address": {
        "country": "US",
        "addressLine1": "BLOCK 8,",
        "addressLine2": "103,MainRoad,Kansas,USA",
        "city": "Kansas",
        "state": "AZ",
        "zip": "63810"
      },
      "Status": "ENABLED",
      "ownershipPercent": "14.6",
      "DOB": "19830119"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String ID of the request Sample value – "b7e6d712-1e0e-4f40-9660-2c6d7216447a"
result	Object
Id	String System generated ID assigned to the shareholder Sample value – "2574004"
CustomerId	String Unique ID of the customer whose shareholder details are updated Sample value – "100000000007001"
Name	String Name of the shareholder for whom the details are updated Sample value – "John"
EmailID	String Contact email ID of the shareholder Sample value – "john@gmail.com"
Status	Enum Status of the shareholder Valid values: ENABLED DISABLED Sample value: "ENABLED"
jsonrpc	String JSON-RPC version used for the API Constant value – "2.0"

{
  "id": "1",
  "result": {
    "Id": "2574004",
    "CustomerId": "100000000007001",
    "Name": "John",
    "EmailID": "john@gmail.com",
    "Status": "ENABLED"
  },
  "jsonrpc": "2.0"
}