Skip to main content

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

Example​

Request Parameters
ParameterDescription
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
apiObject
API credentials and metadata.
credential

Mandatory		String
Basic (space) [("<Username>:<apiKey>") as Base64 encoded value] to be provided
Sample Value: "Basic bmF2eWEubitlbXBAbmV0eGQuY29tOmY1OWIwY2NlOTU4ZTQ1YTc4MGVhZWIzYWVjOWVjZDAx"
signature

Mandatory		String
Sign the request payload (params.payload) using private key.
Sample Value: "MEQCIAbpxHpdOyBEVlmxPYv7m4Z1OvWJJYw7g7u3GE3T9nmvAiBjKHckSvb1M6O4t7FeWsn2z9Y3dMeYn3HyX/k28ek/Dw=="
keyId

Mandatory		String
Key ID is provided at the time of device registration.
Sample Value : "348076"
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
Regex Pattern : ^[a-zA-Z0-9,\-./#&'@% ]{1,100}$
Sample value: "77 HOIT RD"
city
Mandatory		String
City of the shareholder address
Regex Pattern : ^[a-zA-Z-. ]{0,40}$
Sample value: "EPSOM"
state
Mandatory		String
State of the shareholder address
Regex Pattern : ^(AL|AK|AZ|AR|CA|CO|CT|DE|DC|FL|GA|HI|ID|IL|IN|IA|KS|KY|LA|ME|MD|MA|MI|MN|MS|MO|MT|NE|NV|NH|NJ|NM|NY|NC|ND|OH|OK|OR|PA|RI|SC|SD|TN|TX|UT|VT|VA|WA|WV|WI|WY|AS|GU|MP|PR|VI)$
Sample value: "NH"
country
Mandatory		String
Country code of the shareholder address
Regex Pattern : US
Sample value: "BH"
zip
Mandatory		String
ZIP code of the shareholder address
Regex Pattern : ^[0-9]{5}$
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
Mandatory		String
Contact email address of shareholder
Regex Pattern : ^[_A-Za-z0-9+-]{1,75}(\.[_A-Za-z0-9+-]+)@[A-Za-z0-9-]+(\.[A-Za-z0-9]+)(\.[A-Za-z]{2,})$
Sample value: "john+77@finwisebank.com"
phoneNumber
Mandatory		String
Contact phone number of shareholder.
Regex Pattern : ^[0-9 -+]{1,}$
Sample value: "87089855"

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@finwisebank.com","phoneNumber":"87089855"}}}}'

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@finwisebank.com",
        "phoneNumber": "87089855"
      }
    }
  }
}

Response: 200​

Response Parameters
ParameterDescription

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@finwisebank.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@finwisebank.com",
    "Status": "ENABLED"
  }
}