Get Customer

'GetCustomer' API enables to fetch the details of a customer

Bank or financial institution can fetch all the available details of a customer, if required. On providing the specific identification type and respective value as request, all the available details of a required customer can be fetched out.

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 get customer details through customer service Constant value: "CustomerService.GetCustomer"
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 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
Identification Mandatory	Object Note: customerID/customerNumber/contact.email/contact.phoneNumber/Identification - Any one of the inputs can be provided to fetch the customer details
type Mandatory	Enum Identification type of the required customer Valid values: TIN SSN Sample value: "TIN"
value Mandatory	String Value of the identification type Sample value: "764949831"

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"CustomerService.GetCustomer","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"Identification":{"type":"TIN","value":"764949831"}}}}'

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.GetCustomer"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"            ""credential"": ""{{Credential}}""
" + "\n" +
@"        },
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""Identification"": {
" + "\n" +
@"                ""type"": ""TIN"",
" + "\n" +
@"                ""value"": ""764949831""
" + "\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.GetCustomer",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "keyId": "{{ApplicationKeyId}}",`+"
"+`
            "credential": "{{Credential}}"`+"
"+`
        },`+"
"+`
        "payload": {`+"
"+`
            "Identification": {`+"
"+`
                "type": "TIN",`+"
"+`
                "value": "764949831"`+"
"+`
            }`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  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.GetCustomer",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "Identification": {
        "type": "TIN",
        "value": "764949831"
      }
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "CustomerService.GetCustomer",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "Identification": { // customerID/customerNumber/contact.email/contact.phoneNumber/Identification - Any one of the inputs can be provided to fetch the customer details
        "type": "TIN",
        "value": "764949831"
      }
    }
  }
}

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 – "13345"
Type	Enum Type of customer Valid values: INDIVIDUAL BUSINESS Sample value – "INDIVIDUAL"
DOB	String Date of birth of individual customer in YYYYMMDD format Sample value – "2020-07-10"
Title	Enum Salutation of the individual customer Valid values: Mr Ms Mrs Sample value – "Mr"
FirstName	String First name of the individual customer Sample value – "John"
LastName	String Last name of the individual customer Sample value – "Deo"
Gender	Enum Gender of the individual customer Valid values: MALE FEMALE Sample value – "MALE"
MonthlyProjection	Object
Amount	String Volume of transaction that can be done for a month Sample value – "10"
Currency	String Type of currency used for transaction Sample value – "USD"
Identification	Object
Type	Enum Type of identification provided by the customer Valid values: SSN TIN Sample value – "SSN"
Value	String Value of identification type Sample value – "324345435"
Contact	Object
PhoneNumber	String Contact of individual customer Sample value – "6037364437"
Email	String Email ID of individual customer Sample value – "johndeo@testbank.com"
Address	Object
AddressLine1	String First line of customer address Sample value – "77 HOIT RD"
City	String City of customer address Sample value – "EPSOM"
State	String State of customer address Sample value – "NH"
Country	String Country code of customer address Sample value – "US"
Zip	String ZIP code of customer address Sample value – "34354"
Status	Enum Current 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"
Accounts	Array
AccountNumber	String Account number of the customer Sample value – "70000000001"
AccountType	Enum Account type of the customer's account Valid values: SAVINGS - To deposit for saving purpose CHECKING - For daily use WALLET - To store pre-paid money for daily usage MONEY_MARKET - Interest bearing account (based on interest rates) CREDIT_CARD - To track only the credit card transactions GL - General Ledger for accounting record CUSTODIAL - For the benefit of other financial institution Sample value – "WALLET"
RoutingNumber	String Routing number of the customer's bank or financial institution Sample value – "101115302"
Status	Enum Current status of the customer account Valid values: CREATED - Account has been newly created ACTIVE - Account is currently active and can be used for transactions CURTAILED - Account functionalities are limited DORMANT - Account is inactive for a specific period SUSPENDED - Account is Temporarily disabled BLOCKED - Account is restricted from performing any transactions CLOSED - Account is permanently terminated and can no longer be used DISABLED - Account is inactive and unusable, either temporarily or permanently Sample value – "ACTIVE"
Balance	String Current balance amount of the customer account Sample value – "1000"
LastBalanceUpdatedTime	String Date and time of the balance was last updated Sample value – "2021-02-12 12:58:00.092Z"
CustomerData	Object
Name	String Name of the customer Sample value – "John Deo"

{
  "id": "1",
  "result": {
    "Id": "13345",
    "Type": "INDIVIDUAL",
    "DOB": "2020-07-10",
    "Title": "Mr",
    "FirstName": "John",
    "LastName": "Deo",
    "Gender": "MALE",
    "MonthlyProjection": {
      "Amount": 10,
      "Currency": "USD"
    },
    "Identification": {
      "Type": "SSN",
      "Value": "324345435"
    },
    "Contact": {
      "PhoneNumber": "6037364437",
      "Email": "johndeo@testbank.com"
    },
    "Address": {
      "AddressLine1": "77 HOIT RD",
      "City": "EPSOM",
      "State": "NH",
      "Country": "US",
      "Zip": "34354"
    },
    "Status": "ACTIVE",
    "Accounts": [
      {
        "AccountNumber": "70000000001",
        "AccountType": "WALLET",
        "RoutingNumber": "101115302",
        "Status": "ACTIVE",
        "Balance": "1000",
        "LastBalanceUpdatedTime": "2021-02-12 12:58:00.092Z"
      },
      {
        "AccountNumber": "70000000002",
        "AccountType": "WALLET",
        "RoutingNumber": "101115302",
        "Status": "ACTIVE",
        "Balance": "2000",
        "LastBalanceUpdatedTime": "2021-02-18 10:55:00.092Z"
      }
    ],
    "CustomerData": {
      "Name": "John Deo"
    }
  }
}