Customer Details

Node

Child Node

Type 

 Max

Description

Remarks

header

msg_id

String

12

Unique Source Message ID

Mandatory

msg_type

String

12

Request Type

Default: "ENQUIRY"

Mandatory

msg_function

String

50

Function name to be used

Default: "REQ_GENERIC_CUSTOMER_DETAILS"

Mandatory

src_application

String

10

Source requesting channel

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

N/A

Optional

bank_id

String

4

Source Bank Id Ex: bankID

Mandatory

instance_id

String

10

N/A

Optional

body

card_identifier_id

String

32

Value of card number, Token number, Ext_number ..

Mandatory

CIF ID

000003548435901

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_GENERIC_CUSTOMER_DETAILS”

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

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

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

Mandatory

email

String

20

Email address

Mandatory

# 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

Mandatory

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

Custom Field

Mandatory

value

String

20

Custom field value

Mandatory