• Register

Client Update

Client Update service is used to update client details, below are the detailed specifications of this API.

Download

Request Parameters:

Node Child Node Type Length Description Remarks
header msg_id A/N 12 Unique Source Message ID Mandatory
msg_type String 12 Request Type Default: "TRANSACTION" Mandatory
msg_function String 50 Function name to be used Default: "REQ_CLIENT_UPDATE" Mandatory
src_application String 10 Source requesting channel Ex: IVR Mandatory
target_application String 10 Target application name Ex. : "PCMS" Mandatory
timestamp String 30 Timestamp of the request Format  “DD/MM/YYYY HH:MM:SS” Mandatory
tracking_id String 15 Transaction Tracking Id Optional
bank_id String 4 Source Bank Id Ex: bankID Mandatory
body customer_id String 20 CIF ID Mandatory
bank_code String 3 Bank code Mandatory
external_client_number String 20 Client Number Optional
card_name String 21

Card embossing name defined on client level (Upper case)

Ex: JOHN DOE

 Mandatory
card_type String 7

Values are restricted

PREPAID

CREDIT

DEBIT

 Mandatory
personal_details gender String 6 Gender Optional
title String 4 Title: MR etc Optional
first_name String 255 First Name Mandatory
last_name String 255 Last Name Mandatory
middle_name String 255 Middle Name Optional
citizenship String 3 Citizenship Optional
marital_status String 18 Marital status Optional
date_of_birth Date  10 Birth Date Mandatory
place_of_birth String 255 Birth place Optional
language String 18 Language Optional
security_name String 255 This field is used by Fraud monitoring agents to validate cardholder verification on call. This is not mandatory for issuers not using Fraud monitoring service. Conditional
contact_details home_phone String 32 Home phone Optional
work_phone String 32 Work phone Optional
mobile_phone String 32 Mobile phone Mandatory
email String 255 Email Optional
addresses address_type String 20 PERMANENT/PRESENT/WORK Mandatory
address_line_1 String 255 Address Mandatory
address_line_2 String 255 Address Optional
address_line_3 String 255 Address Optional
address_line_4 String 255 Address Optional
email String 255   Email Optional
phone String 32 Phone Optional
city String 255 City Mandatory
country String 255

Country

Refer Appendix1

 Mandatory
zip String 32 This field is used by Fraud monitoring agents to validate cardholder verification on call. This is not mandatory for issuers not using Fraud monitoring service.  Conditional
state String 32 State Optional
identity_proof_document number String 20 Doc Number Optional
type String 20 Type of doc Optional
expiry_date Date  10 Expry date of doc
YYYY-MM-DD		 Optional
supplementary_documents number String 20 Doc Number Optional
type String 20 Type of doc Optional
expiry_date Date  10 Expry date of doc
YYYY-MM-DD		 Optional
employment_details employer_name String 64 Employer Name Optional
income String 64  Income Optional
occupation String 64 Occupation Optional
custom_fields key String 20 Refer to Appendix 4 Refer to Appendix 4
value String 128 Refer to Appendix 4 Refer to Appendix 4
Request JSON
{
  "NISrvRequest":{
    "request_client_update":{
      "header":{
        "msg_id":"218001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CLIENT_UPDATE",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"16/07/2020 11:04:51",
        "tracking_id":"218001",
        "bank_id":"bsnkID"
      },
      "body":{
        "customer_id":"000003548435901",
        "bank_code":"982",
        "client_number":"000003548435901", 
        "reg_number":"000003548435901", 
        "card_name":"IVAN IVANOVV",
        "personal_details":{
          "gender":"Male",
          "title":"MR",
          "first_name":"IVAN",
          "last_name":"IVANOVV",
          "middle_name":"IVICH",
          "citizenship":"AUS",
          "marital_status":"M",
          "date_of_birth":"1980-01-21",
          "place_of_birth", 
          "language":"ENG", 
          "security_name":"IvanSecur", 
        },
        "contact_details": {  
            "home_phone":,
            "work_phone":,
            "mobile_phone":,
            "email":
        },
        "addresses":[ 
          {
            "address_type":"PERMANENT/RESIDENT",
            "address_line_1":"Building one",
            "address_line_2":"LandLord", 
            "address_line_3":"House 45", 
            "address_line_4":"Busy Street", 
            "email":"emailtest@test.net", 
            "phone": "", 
            "city":"Riyadh",
            "country":"SAU",
            "zip":"24537",
            "state":"Riyadh"
          }
        ],
        "identity_proof_document": { 
            "number":,
            "type": ,(passport, national_id, etc)
            "expiry_date":  #YYYY-MM-DD
        },
        "supplementary_documents": 
            "number":,
            "type":, (passport, national_id, etc)
            "expiry_date":  #YYYY-MM-DD
        ],
        "employment_details":{
          "employer_name":"NewCompanyName",
          "income":,
          "occupation":
        },
        "custom_fields": 
            {
                "key":,
                "value":
            }
        ]
      }
    }
  }
}

Response parameters:

 

Node

Child Node

Type 

Max

Description

Remarks

header

msg_id

 

String

 

12

The msg_id sent in the request will be sent back in response in this field.

Unique Source Message ID e.g. “ada123456fdsf”

Mandatory

msg_type

String

12

msg_type sent in the request will be sent back in response in this field.

Mandatory

msg_function

String

50

Default: “REP_CLIENT_UPDATE”

Mandatory

src_application

 

String

 

10

The src_application sent in the request will be sent back in response in this field.

Mandatory

target_application 

 

String

 

10

The target_application sent in the request will be sent back in response in this field.

Mandatory

timestamp

 

String

 

30

Timestamp of the response

Date & time. Format  “DD/MM/YYYY HH:MM:SS”

Mandatory

tracking_id

 

String

 

15

N/A

Optional

bank_id

 

String

4

The bank_id sent in the request will be sent back in response in this field. 

Mandatory

instance_id

String

10

N/A

Optional

Exception_details

application_name

String

20

Application Name

Mandatory

date_time

 

String

30

Timestamp of the response

Format “DD/MM/YYYY HH:MM:SS”

Mandatory

status

 

String

1

Status of the request (S/F)

Success- S,  Failure - F

Mandatory

error_code

String

4

EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)

Mandatory

error_description

String

100

Error Description (Check error codes section for the complete list of error codes and error code descriptions)

Mandatory

transaction_ref_id

String

20

The tracking_id sent in the request will be sent back in response in this field.

Optional

body

customer_id

String

20

CIF Id Ex:000003548435901

Mandatory

bank_code

String

5

Bank specific code Ex:928

Mandatory

client_number

String

20

Client number Ex: 000003548435901

Optional

reg_number

String

20

Registration number Ex: 000003548435901

Optional

card_name

String

50

Card Holder's Name IVAN IVANOVV

Mandatory

# personal_details#

personal_details

gender

 

String

20

Gender ex: Male

Optional

title

String

5

Title ex: Mr

Optional

first_name

String

20

First Name ex: Ivan

Mandatory

last_name

String

20

Last Name ex: Ivanov

Mandatory

middle_name

String

20

Middle Name ex: Ivich

Optional

citizenship

String

10

Appendix 1 

Mandatory

marital_status

String

10

 Marital Status

 

Optional

date_of_birth

String

20

Date of birth ex:1980-01-21

Mandatory

place_of_birth

String

50

Place of birth

Optional

language

String

5

language eg: ENG

Optional

security_name

String

20

Security Name

Optional

# ADDR_TYPE: SMS

contact_details

home_phone

String

20

Home Phone Number

Optional

work_phone

String

20

Work Phone Number

Optional

mobile_phone

String

20

Mobile Number

Optional

email

String

20

Email address

Optional

# Array of Address Entity

addresses

address_type

String

20

PERMANENT/RESIDENT

Mandatory

address_line_1

String

20

Building one

Mandatory

address_line_2

String

20

LandLord

Optional

address_line_3

String

20

House 45

Optional

address_line_4

String

20

Busy Street

Optional

email

String

20

emailtest@test.net

Optional

phone

String

20

Phone number

optional

city

String

20

Ex: Riyadh

Mandatory

country

String

20

Ex: SAU Appendix 1 

Mandatory

zip

String

20

ZIP code ex: 36756

Optional

state

String

20

State ex: Riyadh

Optional

# Document Entity #

identity_proof_document

number

String

20

ID Number

Optional

type

String

20

passport, national_id, etc

Optional

expiry_date

String

10

YYYY-MM-DD

Optional

# Array of Document Entity#

supplementary_documents

number

String

20

ID Number

Optional

type

String

20

passport, national_id, etc

Optional

expiry_date

String

10

YYYY-MM-DD

Optional

# employment_details #

employment_details

employer_name

String

20

NewCompanyName

Optional

income

String

20

Income

Optional

occupation

String

20

Occupation

Optional

# Array of Custom Field entity

custom_fields

key

String

20

Appendix 4

Mandatory

value

String

20

Appendix 4

Mandatory

Json Response

{
  "NISrvResponse":{
    "response_client_update":{
      "header":{
        "msg_id":"218001",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_CLIENT_UPDATE",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"16/07/2020 11:04:51",
        "tracking_id":"218001",
        "bank_id":"bankID"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SSP_1",
        "date_time":"2020-07-16T11:03:23.628+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      },
      "body":{
        "customer_id":"000003548435901",
        "bank_code":"982",
        "client_number":"000003548435901", 
        "reg_number":"000003548435901", 
        "card_name":"IVAN IVANOVV",
        "personal_details":{
          "gender":"Male",
          "title":"MR",
          "first_name":"IVAN",
          "last_name":"IVANOVV",
          "middle_name":"IVICH",
          "citizenship":"AUS",
          "marital_status":"M",
          "date_of_birth":"1980-01-21",
          "place_of_birth", 
          "language":"ENG", 
          "security_name":"IvanSecur", 
        },
        "contact_details": {  
            "home_phone":,
            "work_phone":,
            "mobile_phone":,
            "email":
        },
        "addresses":[ 
          {
            "address_type":"PERMANENT/RESIDENT",
            "address_line_1":"Building one",
            "address_line_2":"LandLord", 
            "address_line_3":"House 45", 
            "address_line_4":"Busy Street", 
            "email":"emailtest@test.net", 
            "phone": "", 
            "city":"Riyadh",
            "country":"SAU",
            "zip":"24537",
            "state":"Riyadh"
          }
        ],
        "identity_proof_document": { 
            "number":,
            "type": ,(passport, national_id, etc)
            "expiry_date":  #YYYY-MM-DD
        },
        "supplementary_documents": 
            "number":,
            "type":, (passport, national_id, etc)
            "expiry_date":  #YYYY-MM-DD
        ],
        "employment_details":{
          "employer_name":"NewCompanyName",
          "income":,
          "occupation":
        },
        "custom_fields": 
            {
                "key":,
                "value":
            }
        ]
      }
    }
  }
}

version 11 as of 10 months ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation