Version: 1.0.2

Update Customer - Consumer

'UpdateCustomer - Consumer' API enables to update the required details of a individual customer

Bank or financial institution can update required details of individual customer that are allowed to be changed with fresh inputs. On providing the required details to be changed in respective fields as request, the individual customer information is updated with created and updated date details.

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 update customer details through customer service Constant value – "CustomerService.UpdateCustomer"
Id Mandatory	String Unique ID of API request Sample value – "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value – "signature"
keyId Mandatory	String API key used for request authentication Sample value – "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value – "Credential"
apiKey Mandatory	String Unique API key of the customer Sample value – "ApiKey"
payload Mandatory	Object
ID Mandatory	String Unique ID of the customer Sample value – "100000000001001"
type Optional	String Type of customer Constant value – "INDIVIDUAL"
DOB Optional	String Date of birth of individual customer in YYYYMMDD format Sample value – "19991209"
title Optional	Enum Salutation of the individual customer Valid values: Mr Ms Mrs Sample value – "Mr"
address Optional	Object
addressLine1 Optional	String First line of customer address Sample value – "1000 PEACHTREE ST N.E."
city Optional	String City of customer address Sample value – "ATLANTA"
state Optional	String State of customer address Sample value – "US"
country Optional	String Country code of customer address Sample value – "US"
zip Optional	String ZIP code of customer address Sample value – "12345"
contact Optional	Object
phoneNumber Optional	String Contact phone number of the customer Sample value – "1274563211"
email Optional	String Contact email ID of the customer Sample value – "customersample@gmail.com"
gender Optional	Enum Gender of the customer Valid values: MALE FEMALE Sample value – ""
firstName Mandatory	String First name of the customer Sample value – "Mark"
lastName Mandatory	String Last name of the customer Sample value – "Antony"
institutionName Optional	String Name of the bank or financial institution where the customer holds account Sample value – "Bank"
institutionId Optional	String Unique ID or routing number of the bank or financial institution where the customer holds account Sample value – "1234"

Parameter

Description

method

Mandatory

String

API method that is being called to update customer details through customer service

Constant value – "CustomerService.UpdateCustomer"

Mandatory

String

Unique ID of API request

Sample value – "1"

params

Mandatory

Object

api

Mandatory

Object

signature

Mandatory

String

Signature for request validation

Sample value – "signature"

keyId

Mandatory

String

API key used for request authentication

Sample value – "ApplicationKeyId"

credential

Mandatory

String

API credential provided by NetXD

Sample value – "Credential"

apiKey

Mandatory

String

Unique API key of the customer

Sample value – "ApiKey"

payload

Mandatory

Object

Mandatory

String

Unique ID of the customer

Sample value – "100000000001001"

type

Optional

String

Type of customer

Constant value – "INDIVIDUAL"

DOB

Optional

String

Date of birth of individual customer in YYYYMMDD format

Sample value – "19991209"

title

Optional

Enum

Salutation of the individual customer

Valid values:

Sample value – "Mr"

address

Optional

Object

addressLine1

Optional

String

First line of customer address

Sample value – "1000 PEACHTREE ST N.E."

city

Optional

String

City of customer address

Sample value – "ATLANTA"

state

Optional

String

State of customer address

Sample value – "US"

country

Optional

String

Country code of customer address

Sample value – "US"

zip

Optional

String

ZIP code of customer address

Sample value – "12345"

contact

Optional

Object

phoneNumber

Optional

String

Contact phone number of the customer

Sample value – "1274563211"

Optional

String

Contact email ID of the customer

Sample value – "customersample@gmail.com"

gender

Optional

Enum

Gender of the customer

Valid values:

MALE
FEMALE

Sample value – ""

firstName

Mandatory

String

First name of the customer

Sample value – "Mark"

lastName

Mandatory

String

Last name of the customer

Sample value – "Antony"

institutionName

Optional

String

Name of the bank or financial institution where the customer holds account

Sample value – "Bank"

institutionId

Optional

String

Unique ID or routing number of the bank or financial institution where the customer holds account

Sample value – "1234"

cURL
C#
Go
NodeJS

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"method":"CustomerService.UpdateCustomer","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}","apiKey":"{{ApiKey}}"},"payload":{"ID":"100000000001001","type":"INDIVIDUAL","DOB":"19991209","title":"Mr","address":{"addressLine1":"1000 PEACHTREE ST N.E.","city":"ATLANTA","state":"US","country":"US","zip":"12345"},"contact":{"phoneNumber":"1274563211","email":"customersample@gmail.com"},"gender":"","firstName":"Mark","lastName":"Antony","institutionName":"Bank","institutionId":"1234"}}}'

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.UpdateCustomer"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}"",
" + "\n" +
@"      ""apiKey"": ""{{ApiKey}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""ID"": ""100000000001001"",
" + "\n" +
@"      ""type"": ""INDIVIDUAL"",
" + "\n" +
@"      ""DOB"": ""19991209"",
" + "\n" +
@"      ""title"": ""Mr"",
" + "\n" +
@"      ""address"": {
" + "\n" +
@"        ""addressLine1"": ""1000 PEACHTREE ST N.E."",
" + "\n" +
@"        ""city"": ""ATLANTA"",
" + "\n" +
@"        ""state"": ""US"",
" + "\n" +
@"        ""country"": ""US"",
" + "\n" +
@"        ""zip"": ""12345""
" + "\n" +
@"      },
" + "\n" +
@"      ""contact"": {
" + "\n" +
@"        ""phoneNumber"": ""1274563211"",
" + "\n" +
@"        ""email"": ""customersample@gmail.com""
" + "\n" +
@"      },
" + "\n" +
@"      ""gender"": """",
" + "\n" +
@"      ""firstName"": ""Mark"",
" + "\n" +
@"      ""lastName"": ""Antony"",
" + "\n" +
@"      ""institutionName"": ""Bank"",
" + "\n" +
@"      ""institutionId"": ""1234""
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

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

func main() {

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

  payload := strings.NewReader(`{`+"
"+`
  "method": "CustomerService.UpdateCustomer",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}",`+"
"+`
      "apiKey": "{{ApiKey}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "ID": "100000000001001",`+"
"+`
      "type": "INDIVIDUAL",`+"
"+`
      "DOB": "19991209",`+"
"+`
      "title": "Mr",`+"
"+`
      "address": {`+"
"+`
        "addressLine1": "1000 PEACHTREE ST N.E.",`+"
"+`
        "city": "ATLANTA",`+"
"+`
        "state": "US",`+"
"+`
        "country": "US",`+"
"+`
        "zip": "12345"`+"
"+`
      },`+"
"+`
      "contact": {`+"
"+`
        "phoneNumber": "1274563211",`+"
"+`
        "email": "customersample@gmail.com"`+"
"+`
      },`+"
"+`
      "gender": "",`+"
"+`
      "firstName": "Mark",`+"
"+`
      "lastName": "Antony",`+"
"+`
      "institutionName": "Bank",`+"
"+`
      "institutionId": "1234"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  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))
}

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.UpdateCustomer",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}",
      "apiKey": "{{ApiKey}}"
    },
    "payload": {
      "ID": "100000000001001",
      "type": "INDIVIDUAL",
      "DOB": "19991209",
      "title": "Mr",
      "address": {
        "addressLine1": "1000 PEACHTREE ST N.E.",
        "city": "ATLANTA",
        "state": "US",
        "country": "US",
        "zip": "12345"
      },
      "contact": {
        "phoneNumber": "1274563211",
        "email": "customersample@gmail.com"
      },
      "gender": "",
      "firstName": "Mark",
      "lastName": "Antony",
      "institutionName": "Bank",
      "institutionId": "1234"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "CustomerService.UpdateCustomer",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}",
      "apiKey": "{{ApiKey}}"
    },
    "payload": {
      "ID": "100000000001001",
      "type": "INDIVIDUAL",
      "DOB": "19991209",
      "title": "Mr",
      "address": {
        "addressLine1": "1000 PEACHTREE ST N.E.",
        "city": "ATLANTA",
        "state": "US",
        "country": "US",
        "zip": "12345"
      },
      "contact": {
        "phoneNumber": "1274563211",
        "email": "customersample@gmail.com"
      },
      "gender": "",
      "firstName": "Mark",
      "lastName": "Antony",
      "institutionName": "Bank",
      "institutionId": "1234"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
Id	String Response ID echoed from the request ID Sample value – "1"
result	Object
ID	String Unique ID of the customer Sample value – "100000000001001"
type	String Type of customer Constant value – "INDIVIDUAL"
identification	Array
type	String Type of identification provided by the customer Constant value – "SSN"
value	String Value of respective identification Sample value – "987456220"
contact	Object
email	String Contact email ID of the customer Sample value – "customersample@gmail.com"
phoneNumber	String Contact phone number of the customer Sample value – "1274563211"
address	Object
addressLine1	String First line of customer address Sample value – "1000 PEACHTREE ST N.E."
city	String City of customer address Sample value – "ATLANTA"
state	String State of customer address Sample value – "US"
country	String Country code of customer address Sample value – "US"
zip	String ZIP code of customer address Sample value – "12345"
DOB	String Date of birth of individual customer in YYYYMMDD format Sample value – "19991209"
title	Enum Salutation of the individual customer Valid values: Mr Ms Mrs Sample value – "Mr"
firstName	String First name of the customer Sample value – "Mark"
lastName	String Last name of the customer Sample value – "Antony"
createdDate	String Date and time when the customer was created Sample value – "2024-05-22T07:24:36.881Z"
updatedDate	String Date and time when the customer was last updated Sample value – "2024-05-22T10:25:18.079Z"
status	Enum Status of the customer Valid values: ACTIVE - Currently active and can perform all defined activities IN_ACTIVE - Not currently active DORMANT - Inactive for specific period SUSPENDED - Temporarily disabled BLOCKED - Restricted to perform all defined activities BLACK_LISTED - Permanently banned Sample value – "ACTIVE"
jsonrpc	String JSON RPC version Constant value – "2.0"

{
  "id": "1",
  "result": {
    "ID": "100000000001001",
    "type": "INDIVIDUAL",
    "identification": [
      {
        "type": "SSN",
        "value": "987456220"
      }
    ],
    "contact": {
      "email": "customersample@gmail.com",
      "phoneNumber": "1274563211"
    },
    "address": {
      "addressLine1": "1000 PEACHTREE ST N.E.",
      "city": "ATLANTA",
      "state": "US",
      "country": "US",
      "zip": "12345"
    },
    "DOB": "19991209",
    "title": "Mr",
    "firstName": "Mark",
    "lastName": "Antony",
    "createdDate": "2024-05-22T07:24:36.881Z",
    "updatedDate": "2024-05-22T10:25:18.079Z",
    "status": "ACTIVE"
  },
  "jsonrpc": "2.0"
}

Update Customer - Consumer

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200