Add Shareholder

'AddShareHolder' API enables to add shareholders of the business customer

Shareholder - An individual or an entity that owns a percentage of share in the business

Bank or financial institution can add shareholders of a business to the respective business customer for KYC purpose. On providing the shareholder details as request, the shareholder is added to the business customer with the generation of unique shareholder ID and the status is enabled.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to add shareholder through customer service Constant value: "CustomerService.AddShareHolder"
id Mandatory	String Unique ID of API Request Sample value: "1" (Only number)
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature code"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object
customerId Mandatory	String Unique ID of the customer Sample value: "100000000025001"
name Mandatory	String Name of the shareholder Sample value: "John deo"
DOB Optional	String Date of birth of the shareholder Sample value: "19830119"
identification Mandatory	Object
type Mandatory	String Type of identification provided for the shareholder Sample value: "SSN"
value Mandatory	String Value of respective identification Sample value: "334134545"
address Mandatory	Object
addressLine1 Mandatory	String First line of shareholder address Sample value: "77 HOIT RD"
city Mandatory	String City of the shareholder address Sample value: "EPSOM"
state Mandatory	String State of the shareholder address Sample value: " NH"
country Mandatory	String Country code of the shareholder address Sample value: "BH"
zip Mandatory	String ZIP code of the shareholder address Sample value: "34354"
notes Optional	String Notes for reference on adding the shareholder Sample value: "Legal user"
OwnershipPercent Optional	String Business ownership percentage of shareholder Sample value: "14.6" (Only number with decimal)
contact Optional	Object
email Optional	String Contact email address of shareholder Sample value: "john+77@netxd.com"
phoneNumber Optional	String Contact phone number of shareholder Sample value: "87089855"

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"method":"CustomerService.AddShareHolder","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"customerId":"100000000025001","name":"John deo","DOB":"19830119","identification":{"type":"SSN","value":"334134545"},"address":{"addressLine1":"77 HOIT RD","city":"EPSOM","state":"NH","country":"BH","zip":"34354"},"notes":"Legal user","OwnershipPercent":"14.6","contact":{"email":"john+77@netxd.com","phoneNumber":"87089855"}}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""CustomerService.AddShareHolder"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"            ""credential"": ""{{Credential}}""
" + "\n" +
@"        },
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""customerId"": ""100000000025001"",
" + "\n" +
@"            ""name"": ""John deo"",
" + "\n" +
@"            ""DOB"": ""19830119"",
" + "\n" +
@"            ""identification"": {
" + "\n" +
@"                ""type"": ""SSN"",
" + "\n" +
@"                ""value"": ""334134545""
" + "\n" +
@"            },
" + "\n" +
@"            ""address"": {
" + "\n" +
@"                ""addressLine1"": ""77 HOIT RD"",
" + "\n" +
@"                ""city"": ""EPSOM"",
" + "\n" +
@"                ""state"": ""NH"",
" + "\n" +
@"                ""country"": ""BH"",
" + "\n" +
@"                ""zip"": ""34354""
" + "\n" +
@"            },
" + "\n" +
@"            ""notes"": ""Legal user"",
" + "\n" +
@"            ""OwnershipPercent"": ""14.6"",
" + "\n" +
@"            ""contact"": {
" + "\n" +
@"                ""email"": ""john+77@netxd.com"",
" + "\n" +
@"                ""phoneNumber"": ""87089855""
" + "\n" +
@"            }
" + "\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 := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "method": "CustomerService.AddShareHolder",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "keyId": "{{ApplicationKeyId}}",`+"
"+`
            "credential": "{{Credential}}"`+"
"+`
        },`+"
"+`
        "payload": {`+"
"+`
            "customerId": "100000000025001",`+"
"+`
            "name": "John deo",`+"
"+`
            "DOB": "19830119",`+"
"+`
            "identification": {`+"
"+`
                "type": "SSN",`+"
"+`
                "value": "334134545"`+"
"+`
            },`+"
"+`
            "address": {`+"
"+`
                "addressLine1": "77 HOIT RD",`+"
"+`
                "city": "EPSOM",`+"
"+`
                "state": "NH",`+"
"+`
                "country": "BH",`+"
"+`
                "zip": "34354"`+"
"+`
            },`+"
"+`
            "notes": "Legal user",`+"
"+`
            "OwnershipPercent": "14.6",`+"
"+`
            "contact": {`+"
"+`
                "email": "john+77@netxd.com",`+"
"+`
                "phoneNumber": "87089855"`+"
"+`
            }`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  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': 'POST',
  '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.AddShareHolder",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "customerId": "100000000025001",
      "name": "John deo",
      "DOB": "19830119",
      "identification": {
        "type": "SSN",
        "value": "334134545"
      },
      "address": {
        "addressLine1": "77 HOIT RD",
        "city": "EPSOM",
        "state": "NH",
        "country": "BH",
        "zip": "34354"
      },
      "notes": "Legal user",
      "OwnershipPercent": "14.6",
      "contact": {
        "email": "john+77@netxd.com",
        "phoneNumber": "87089855"
      }
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "CustomerService.AddShareHolder",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "customerId": "100000000025001",
      "name": "John deo",
      "DOB": "19830119",
      "identification": {
        "type": "SSN",
        "value": "334134545"
      },
      "address": {
        "addressLine1": "77 HOIT RD",
        "city": "EPSOM",
        "state": "NH",
        "country": "BH",
        "zip": "34354"
      },
      "notes": "Legal user",
      "OwnershipPercent": "14.6",
      "contact": {
        "email": "john+77@netxd.com",
        "phoneNumber": "87089855"
      }
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value: "1" (Only number)
result	Object
Id	String Unique Id assigned for the shareholder Sample value: "53451"
CustomerId	String Unique number of customer for whom the shareholder is to be added Sample value: "100000000025001"
Name	String Name of the shareholder Sample value: "John deo"
EmailID	String Contact email address of the shareholder Sample value: "john+77@netxd.com"
status	Enum Status of the newly added shareholder Valid values: ENABLED DISABLED Sample value: "ENABLED"

{
  "id": "1",
  "result": {
    "Id": "53451",
    "CustomerId": "100000000025001",
    "Name": "John deo",
    "EmailID": "john+77@netxd.com",
    "Status": "ENABLED"
  }
}