Versions Compared

Old Version 16

changes.mady.by.user Ajaimoan Antony

Saved on

compared with

New Version Current

changes.mady.by.user Ajaimoan Antony

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Version History:

Version

Description

Author

Date

(dd/mm/yyyy)

 1.0.0

 DRAP Onboarding Service (without eKYC flow) Document

 Ajai Antony

07/06/2024

 1.0.1

 Customer updation failure response

Ajai Antony

14/06/2024

1.0.2

AML Alert Closure CallBack API updates

Ajai Antony

15/10/2024

CLASSIFICATION: PUBLIC

The partner will conduct e-KYC or KYC procedures autonomously and employ the listed APIs to enroll customers onto the Customer Data Platform (CDP). They will supply essential customer details obtained from a trusted data source (such as an e-KYC provider or government database), additional information based on country requirements, along with customer documents, including front and back images of the customer's ID, a facial image, and any e-KYC verification or confirmation reports if applicable using the customer onboard API.

...

API to be used to look up customer information by ID type and ID number.

...

Authorization

...

String

...

Status
colourGreen
titleMANDATORY

...

Authorization Token

Payload

Name

Data Type

Max Length

Mandatory

Description

idType

String

3

API

https://{{baseUrl}}/caas/api/v2/customer/validate

Authorization

 Bearer Token

Method

POST

Headers

Content-Type:application/json

Payload

Code Block
languagejson
{
    "idNumber": "784199554586091",
    "idType": "4"
}

Success Response

HttpStatusCode : 200

Code Block
languagejson
{
    "status": "success",
    "statusCode": 200,
    "message": "Successfully Processed",
    "data": {
        "ecrn": "10580212351615417841003233051516",
        "first_name": "IRFAN MANAKKAT THEKKEZAFARBASHIR",
        "middle_name": "PURAYIL ISMAIL",
        "last_name": "NANGARATH MUNDACHIBASHIRMASIH",
        "agent_location_id": "784101",
        "primary_mobile_number": "+971502106707971554747002",
        "email_id": "irfanmtp1@gmailBASHIRMASIH@GMAIL.comCOM",
        "customer_status": "ACTIVE",
        "aml_scan_status": "Accepted",
        "id_status": "Active",
        "id_date_of_expiry": "20232030-0812-08T0010T00:00:00.000+00:00"
    }
}

Customer Not Found

HttpStatusCode : 200

Code Block
languagejson
{
    "status": "failure",
    "statusCode": 404,
    "errorCode": 45001,
    "message": "Customer not found"
}

Subscription Pending Response

HttpStatusCode : 200

Code Block
languagejson
{
    "status": "failure",
    "statusCode": 404,
    "errorCode": 45003,
    "message": "Customer not Subscribed" 
}

Bad Request

HttpStatusCode : 200

Code Block
languagejson
{
    "status": "failure",
    "statusCode": 400,
    "errorCode": 4500540001,
    "message": "Invalid Lookupformat requestinput"
}

Internal Server Error

HttpStatusCode : 200

Code Block
languagejson
{		
    "status": "failure",		
    "statusCode": 404500,		
    "errorCode": 45006,		
    "message": "Error while searching customer!"		
}

Authentication Validation Failure Response - Customer Under Compliance Investigation

HttpStatusCode : 401200

Code Block
languagejson
{
    "timestampstatus": "2023-12-22T06:04:30.477+00:00failure",
    "statusstatusCode": 401500,
    "errorerrorCode": "Unauthorized"45013,
    "pathmessage": "/api/v2/customer/validateCustomer under Compliance investigation!"
}

Header

...

Name

...

Data Type

...

Max Length

...

Mandatory

...

Description

...

Content-Type

...

String

...

36

...

Status
colourGreen
titleMANDATORY

...

Content type

Validation Failure Response - Blocked Customer

HttpStatusCode : 200

Code Block
languagejson
{
    "status": "failure",
    "statusCode": 404,
    "errorCode": 45051,
    "message": "Customer can not be Accepted"
}

Authentication Failure Response

HttpStatusCode : 401

Code Block
languagejson
{
    "timestamp": "2023-12-22T06:04:30.477+00:00",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/v2/customer/validate"
}

Header

Name

Data Type

Max Length

Mandatory

Description

Content-Type

String

36

Status
colourGreen
titleMANDATORY

Customer id

Content type

code

idNumber

Authorization

String

30

Status
colourGreen
titleMANDATORY

Customer id Number

...

Authorization Token

Payload

Name

Data Type

Max Length

Mandatory

Description

status

idType

String

255

3

Status

description

colour

statusCode

Green

Integer

title

 -

Status

MANDATORY

Customer id type code

errorCode

idNumber

Integer

String

-

Error

30

Status
colourGreen
titleMANDATORY

Customer id Number

Response

Name

Data Type

Max Length

Description

status

String

255

status description

statusCode

Integer

 -

Status code

errorCode

Integer

-

Error code if any error encountered.

message

String

255

Message

data

Object

-

Data object

ecrn

String

20

Customer unique identification number

first_name

String

100

Customer first name

middle_name

String

60

Customer middle name

last_name

String

60

Customer last name

agent_location_id

String

10

Onboarded Agent

primary_mobile_number

String

20

Customer mobile no

email_id

String

255

Customer email

customer_status

String

20

Customer Status

Status
colourGreen
titleACTIVE
/
Status
colourYellow
titleKYC_PENDING
/
Status
colourYellow
titleINACTIVE
/
Status
colourRed
titleREJECTED
/
Status
colourRed
titleBLOCKED

aml_scan_status

String

20

AML Scanned Status

“Accepted” / “Rejected“ / “Under Investigation”/ “Failed”

id_status

String

20

Possible values : "Active", "Expired",”Inactive”

id_date_of_expiry

String

 50

YYYY-MM-DD format

...

API to be used to onboard a customer.

Name

Data Type

Max Length

Mandatory

Description

Content-Type

String

 

Status

API

https://{{baseUrl}}/caas-lcm/api/v1/CAAS/onBoarding/customer

Authorization

Bearer Token

Method

POST

Headers

Content-Type:application/json

Payload

Code Block
languagejson
{
    "channel": "WEB",
    "first_name": "IRFAN MANAKKAT THEKKE",
    "salutation": "Mr",
    "middle_name": "PURAYIL ISMAIL",
    "last_name": "NANGARATH MUNDACHI",
    "preferred_name": "IRFAN MANAKKAT THEKKE",
    "nationality": "IN",
    "second_nationality": "GB",
    "native_region": 1,
    "date_of_birth": "1995-07-28",
    "country_of_birth": "IN",
    "place_of_birth": "INDIA",
    "resident_type_id": 101,
    "country_of_residence": "AE",
    "gender": "Male",
    "mothers_maiden_name": "SAFIYA",
    "primary_mobile_number": "+971502106707",
    "secondary_mobile_number": "+971502412378",
    "email_id": "irfanmtp1@gmail.com",
    "phone_number": "+971502106707",
    "occupation_id": 2856,
    "political_exposed_person": false,
    "updated_by": "784irfan",
    "additional_docs": [
        {
            "base64_data": "<<base64Data>>",
            "content_type": "image/jpeg",
            "document_id": "1"
        },
        {
            "base64_data": "<<base64Data>>",
            "content_type": "image/jpeg",
            "document_id": "2"
        }
    ],
    "address_list": [
        {
            "address_type_id": "1",
            "building_name": "MANKHOOL BUILDING",
            "street_name": "Electra Street",
            "landmark": "HOT Bread",
            "city": "Electra Street",
            "district": "Abu Dhabi",
            "state": "Abu Dhabi",
            "country": "AE",
            "zip": 0,
            "po_box": null,
            "mobile_number": "+971502106707"
        },
        {
            "address_type_id": "2",
            "building_name": "ABC House",
            "street_name": "Kaikottukadavu",
            "landmark": "ABC School",
            "city": "Thrikkaripur",
            "district": "Kasaragod",
            "state": "kerala",
            "country": "IN",
            "zip": 13345,
            "mobile_number": "+971502106707"
        }
    ],
    "id_details": [
        {
            "id_type": 4,
            "id_number": "784199554586091",
            "name_as_per_id": "Irfan Manakkat Thekke Purayil",
            "issued_country": "AE",
            "issued_by": "EIDA",
            "issued_at": "AE Govt.",
            "issued_on": "2020-08-08",
            "date_of_expiry": "2023-08-08",
            "default_status": true,
            "active_status": true,
            "id_front": {
                "base64_data": "<<base64Data>>",
                "content_type": "image/jpeg"
            },
            "id_back": {
                "base64_data": "<<base64Data>>",
                "content_type": "image/jpeg"
            }
        },
        {
            "id_type": 2,
            "id_number": "P4006315",
            "visa_number": "VISA123",
            "visa_expiry_date": "2024-06-30",
            "name_as_per_id": "IRFAN M T P",
            "issued_country": "IN",
            "issued_by": "India Govt.",
            "issued_at": "Kozhikkode",
            "issued_on": "2016-04-28",
            "date_of_expiry": "2026-04-27",
            "default_status": true,
            "active_status": true,
            "id_front": {
                "base64_data": "<<base64Data>>",
                "content_type": "image/jpeg"
            },
            "id_back": {
                "base64_data": "<<base64Data>>",
                "content_type": "image/jpeg"
            }
        }
    ],
    "customer_classification": {
        "customer_type_id": 2,
        "annual_income_range_id": 15,
        "annual_income_currency_code": "AED",
        "social_security_number": "SSN123",
        "tax_registration_number": 123,
        "txn_issued_country": "AE",
        "employer_name": "EMKE",
        "employer_address": "UAE",
        "employer_phone": "+971502106101",
        "employer_ecrn": "",
        "employer_establishment_id": "LULUEXCHANGE123",
        "risk_rating_id": 3,
        "pep_category": 1,
        "personal_mohre_id": "IRFAN786",
        "income_type": 1,
        "profession_category": "PC1",
        "reason_for_acc": "Remittance",
        "txn_vol_month": 1,
        "txn_count_month": 1,
        "show_remarks_on_txn": false,
        "customer_remarks": "Test Remarks",
        "agent_ref_no": "786000786",
        "social_links": [
            {
                "social_links_id": 2,
                "text_field": "insta.com"
            },
            {
                "social_links_id": 1,
                "text_field": "fb.com"
            }
        ],
        "first_language": "en",
        "marital_status": 2,
        "dnfbp": false,
        "dpms": false,
        "profile_category": 1,
        "profile_photo": {
            "base64_data": "<<bas64data>>",
            "content_type": "image/jpeg"
        }
    }
}

Success Response

HttpStatusCode : 200

Code Block
languagejson
{
    "status": "success",
    "data": {
        "aml_scan_status": "Accepted",
        "ecrn": "78410032331125907841003247752409",
        "customer_status": "ACTIVE",
        "pep": false,
        "aml_category": 2
    },
    "requestIdstatus_code": "9ec8ed6c9f52a83b12a2373665b899de"200,
    "statusrequest_codeid": "200 OK4138e3038999d41b7534ce12a18a6031"
}

Validation Failure Response - Customer Under Compliance Investigation

HttpStatusCode : 406

Code Block
languagejson
{
    "requestIdrequest_id": "8d0e88958b3572ed17f4e859f1fce1079dff05c2a18e6e73964c0c91f75f463b",
    "status": "failed",
    "status_code": "406 NOT_ACCEPTABLE",
    "error_code": null45013,
    "message": "Customer 78410032306896457841003236577331 Under Compliance Investigation"
}

Validation Failure Response - Blocked Customer

HttpStatusCode : 406

Code Block
languagejson
{
    "requestIdrequest_id": "dee033942cdce475bfbd55c0a6c26ffad0f7edcbb91abefa58f3fc9672711e1b",
    "status": "failed",
    "status_code": "406 NOT_ACCEPTABLE",
    "error_code": null45051,
    "message": "Customer 78410032306896451074023185717024 Can notCannot be Accepted"
}

Validation Failure Response - Invalid Master Data

HttpStatusCode : 400

Code Block
languagejson
{
    "requestIdrequest_id": "7ec2c7830fa6446ecebe1e9a7b80f8facb3bc0a37334c4eacdbea088f926b7ab",
    "status": "failed",
    "status_code": "406 NOT_ACCEPTABLE",7841003230626451
    "error_code": null45053,
    "message": " Invalid Nationality aeINN!"
}

Validation Failure Response - Mandatory Field Missing

HttpStatusCode : 400

Code Block
languagejson
{
    "status": "failure",
    "statusCodestatus_code": 400,
    "errorCodeerror_code": 40002,
    "message": "Invalid format or missing mandatory request",
    "details": {
        "firstName": "Invalid first name"
    },
    "requestId"request_id": "729d5085e553f3830277d0cb5372f2b2"
}

Customer Updation Failure Responce

Code Block
languagejson
{
  "request_id": "6212f1084eb59c5d88b34078c8330a0c",
  "status": "failed",
  "status_code": 404,
  "error_code": 45032,
  "message": "117b2b47732057ce9f495ca215ad6366Customer update failed"
}

Authentication Failure Response

HttpStatusCode : 401

Code Block
languagejson
{
    "timestamp": "2023-03-15T14:26:24.292+00:00",
    "status": 401,
    "error": "Unauthorized",
    "message": "",
    "path": "/api/v1/CAAS/onBoarding/customer"
}

Bad Request

Http Staus Code:400Internal Server Error

HttpStatusCode : 502

Code Block
languagejson
{
    "status": "failure",
    "statusCode": 400,
    "errorCode": 40002failed",
    "message": "InvalidBackend format or missing mandatory requestTechnical Problem",
    "detailsstatus_code": {502,
        "firstName"error_code": "Invalid first name"
    }40001,
    "requestIdrequest_id": "9cee167abbdde1612fcb67ec452b881ba700be42dcbb3c71f36c1bcea42f41fa"
}

Internal Server Error

HttpStatusCode : 502

Code Block
languagejson
{
    "status": "failed",
    "errorCode": "50203",
    "message": "Backend Technical Problem",
    "requestId": "f91a4fb9d062eb26181da69bf61ca644",
    "status_code": "502"
}

Header

Header
Name
Data Type
Max Length
Mandatory
Description
Content-Type
String
 
 Status
colourGreen
titleMANDATORY
Content Type
Authorization
String
 
 Status
colourGreen
titleMANDATORY
Authorization Token
...
{
    "ecrn": "1058021235161541",
Response
HttpStatusCode: 200
API
https://{{baseUrl}}/caas/api/v2/customer/{{ecrn}}
Authorization
 Bearer Token
Method
GET
Headers
Content-Type: application/json
Payload
 Code Block
None
Success Response
HttpStatusCode: 200
 Code Block
languagejson
 Code Block
languagejson
{
    "status": "success",
    "statusCode": 200,
    "data": {
        "dateUpdated": "2024-03-26T07:51:57.909545Z",
        "registrationDate": "2024-03-26 07:09:24",
        "ecrn": "7841003247752409",
        "first_name": "VINOTH",
        "salutation": null,
        "middle_name": "PURAYIL ISMAIL",
        "last_name": "NANGARATH MUNDACHI",
        "preferred_name": "IRFAN M T P",
        "nationality": "IN",
        "second_nationality": "GB",
        "native_region": 1,
        "date_of_birth": "1973-07-28",
        "country_of_birth": "IN",
        "place_of_birth": "INDIA",
        "resident_type_id": 101,
        "country_of_residence": "AE",
        "gender": "Male",
        "mothers_maiden_name": null,
        "primary_mobile_number": "+971502106709",
        "secondary_mobile_number": "+971502106708",
        "email_id": "IRFANMTP1@GMAIL.COM",
        "phone_number": null,
        "occupation_id": 2856,
        "political_exposed_person": false,
        "channel": "BRANCH",
        "aml_scan_status": "Accepted",
        "customer_iban": "AE253147841003247752409",
        "agent_location_id": "784101",
        "customer_status": "ACTIVE",
        "aml_category": 2,
        "additional_docs": [],
        "address_list": [
            {
                "dateUpdated": "2024-03-26T07:09:24.605116Z",
                "address_type_id": "1",
                "firstbuilding_name": "IRFANMANKHOOL  MANAKKATBUILDING THEKKE2",
      "salutation": null,          "middlestreet_name": "PURAYIL ISMAILGHG",
                "last_namelandmark": "NANGARATHAL MUNDACHINAHDA",
         "preferred_name": "IRFAN MANAKKAT THEKKE",       "city": "EMIRATE OF DUBAI",
          "nationality": "IN",     "second_nationalitydistrict": "GBHGJH",
    "native_region": 1,     "date_of_birth": "1995-07-28",     "country_of_birthstate": "INJGHFHG",
    "place_of_birth": "INDIA",     "resident_type_id": 101,     "country_of_residence": "AE",
    "gender": "Male",     "mothers_maiden_name": "maiden Name",     "primary_mobile_numberzip": "+971502106707"0,
    "secondary_mobile_number": "+971502106706",     "email_id": "irfanmtp1@gmail.com",     "phonepo_numberbox": "+971502106705"null,
    "occupation_id": 2856,     "political_exposed_person": false,     "amlmobile_scan_statusnumber": "Accepted", null
        "customer_iban": "AE083141058021235161541",   }
 "customer_status": "ACTIVE",     "aml_category": 5 ],
        "additionalid_docsdetails": [
            {
                "contentTypedateUpdated": "image/jpeg",2024-03-26T07:09:24.605116Z",
                "fileid_nametype": "customer/additionalDoc/1058021235161541_1.jpeg"
1,
       }     ],     "addressid_listnumber": [
   "126657",
    {             "dateUpdatedvisa_number": "2023-03-15T14:34:07.849554ZTRF45",
                "addressvisa_typeexpiry_iddate": "12025-08-08",
                "building_namename_as_per_id": "MANKHOOL  BUILDING",
                "streetissued_namecountry": "AE",
                "landmarkissued_by": "ALEIDA NAHDAGOVT",
             "city   "issued_at": null,
 "EMIRATE OF DUBAI",             "districtissued_on": "2020-08-08",
                "statedate_of_expiry": " 2025-08-08",
                "countrydefault_status": "AE",false,
                "zipactive_status": 0false,
                "mobileid_numberfront": {
 null         }     ],     "idbase64_detailsdata": [
"",
       {             "dateUpdatedfile_name": "2023-03-15T14:34:07.849554Z",
     customer/id/7841003247752409_ID_FR_1_126657.jpg",
      "id_type": 2,             "idcontent_numbertype": "P4006315image/jpg",
            "visa_number": "0",   },
         "visa_expiry_date": null,      "id_back": {
     "name_as_per_id": " ",             "issuedbase64_countrydata": "IN",
            "issued_by        "file_name": "INDIA Govt.customer/id/7841003247752409_ID_BK_1_126657.jpg",
            "issued_at": null,
            "issuedcontent_ontype": "2016-08-08",
     image/jpg"
      "date_of_expiry": "2026-08-08",          }
  "default_status": true,         }
   "active_status": true,    ],
        "idcustomer_frontclassification": null,{
            "id_backdateUpdated": null"2024-03-26T07:51:57.909545Z",
        },         {"customer_type_id": 2,
            "dateUpdatedannual_income_range_id": "2023-03-15T14:34:07.849554Z"15,
            "id_typeannual_income_currency_code": 4null,
            "idsocial_security_number": "784199554586091"null,
            "visatax_registration_number": "0"null,
            "visatxn_expiryissued_datecountry": null,
            "name_as_per_idemployer_name": " EMKE",
            "issuedemployer_countryaddress": "AEnull",
            "issuedemployer_byphone": "EIDA ",
            "issuedemployer_atecrn": null"",
            "issuedemployer_establishment_onid": "2020-08-08",
            "daterisk_ofrating_expiryid": "2023-08-08"3,
            "defaultlast_review_statusdate": true"2024-03-26",
            "activenext_review_statusdate": true"2025-03-26",
            "idpep_frontcategory": {null,
                "base64group_datacompanies": "",
   null,
            "filegroup_employer_namecode": "customer/id/1058021235161541_ID_FR_4_784199554586091.jpeg ",
                "content_type"personal_mohre_id": "image/jpeg",
            }"income_type": 1,
            "idprofession_backcategory": null"",
        }     ],
"reason_for_acc": " ",
   "customer_classification": {         "dateUpdatedreferred_by": "2023-02-14T10:28:03.762012Z1058021235161541",
            "customerreferred_by_type_id": 21,
        "annual_income_range_id": 15,         "annualtxn_incomevol_currency_codemonth": null1,
            "socialtxn_securitycount_numbermonth": null1,
            "taxshow_remarks_registrationon_numbertxn": nullfalse,
            "txncustomer_issued_countryremarks": null"JHGJG",
        "employer_name    "agent_ref_no": "EMKE"null,
            "employerekyc_addressprovider": "UAE",null,
            "employerekyc_ref_phoneno": " ",null,
            "employercustomer_ecrncards": ""null,
            "employercard_establishment_idnumber": "", null,
            "risksocial_rating_idlinks": 3,[],
            "last_review_datesubscriptions": null,
[
       "next_review_date": null,        {
"pep_category": null,         "group_companies": null,         "groupsubsciption_employer_codetype": "Digital Channel",
              "personal_mohre      "subscription_id": "LULUMONEY",
          "income_type": 1,         "profession_categorystatus": "active",
        "reason_for_acc": " ",         "referred_by": "1058021235161541"},
        "referred_by_type": 1,         "txn_vol_month": 1,{
          "txn_count_month": 1,         "show_remarks_on_txnsubsciption_type": false"PREMIUM",
          "customer_remarks": "",         "agentsubscription_ref_noid": "GOLD nullCARD",
        "ekyc_provider": null,            "ekyc_ref_nostatus": null,"active"
        "customer_cards": null,       }
 "card_number": null,         "social_links": [],
            "subscriptionsfirst_language": [null,
            {
   "marital_status": null,
            "subsciption_typednfbp": "PREMIUM"false,
 
              "subscription_iddpms": "GOLD CARD"false,
                "status"profile_category": "active"1,
            }"profile_photo_file_name": null
        ]},
        "firstcustomer_languagerelations": ""[],
        "maritalcommunication_statusconsents": [
null,         "dnfbp": false,  {
      "dpms": false,         "profilecommunication_categorytype": 1,
        "profile_photo_file_name": null
    },     "customer_relationsallow": true
[],     "communication_consents": [      },
  {          {
  "allow": true,             "communication_type": 12,
            },    "allow": true
   {         }
   "allow": true,    ],
        "communication_typeupdated_agent_location_id": 2"784101",
        }"updated_channel": "BRANCH"
    ]}
}
Authentication Failure Response
HttpStatusCode: 401
 Code Block
languagejson
{
        "timestamp":  "20232024-0304-15T1403T06:2639:2436.292337+00:00",
        "status": 401 401,
        "error":  "Unauthorized",
    "message": "",
    
    "path":  "/api/v1v2/customer/7841001228796988"
}
Customer Not Subscribed Failure Response
HttpStatusCode: 200
 Code Block
languagejson
{
    "status": "failure",
    "statusCode": 404,
    "errorCode": 45003,
    "message": "Customer not Subscribed"
}
Customer not found Failure Response
HttpStatusCode: 200
 Code Block
languagejson
{
    "status": "failure",
    "statusCode": 404,
    "errorCode": 45001,
    "message": "Customer not found"
}
...
Name
Data Type
Max Length
Description
agent_location_id
String
30
Agent Location Id
channel
String
30
Channel
salutation
String
3
Salutation(Mr, Ms)
first_name
String
100
First Name
middle_name
String
60
Middle Name
last_name
String
60
Last Name
preferred_name
String
255
Preferred Name
nationality
String
2
Nationality
second_nationality
String
2
Second Nationality of Customer
native_region
Integer
 
Native Region
date_of_birth
Date
 
Date of Birth
country_of_birth
String
2
Country of Birth
place_of_birth
String
100
Place of Birth
resident_type_id
Long
 
Resident Type Id
country_of_residence
String
2
Country of Residence
gender
Male
12
Gender
mothers_maiden_name
String
30
Mothers Name
primary_mobile_number
String
20
Primary Mobile Number
secondary_mobile_number
String
20
Secondary Mobile Number
email_id
String
30
Email Id
phone_number
String
20
Phone Number
occupation_id
Long
 
Occupation Id
political_exposed_person
Boolean
 
Political Exposed Person
additional_docs
Object
 
Data Object
idNameId
String
 
Id name id
base64_data
String
 
 
content_type
String
 
Content Type
id_details
Object
 
Data Object
id_type
Long
 
Id Type
id_number
String
30
Id Number
name_as_per_id
String
30
Name as per Id
issued_country
String
2
Issued Country
issued_by
String
30
Issued By
issued_at
String
30
Issued At
issued_on
Date
 
Issued On
date_of_expiry
Date
 
Date of Expiry
visa_number
String
30
Visa Number
visa_expiry_date
Date
 
Visa Expiry Date
default_status
String
30
Default Status
active_status
String
30
Active Status
id_front
Object
 
Data Object
base64_data
String
 
Base 64 Data
content_type
String
 
Content Type
id_back
Object
 
Data Object
base64_data
String
 
Base 64 Data
content_type
String
 
Content Type
addressList
Object
 
Data Object
address_type_id
Long
 
Address Type Id
building_name
String
255
Building Name
street_name
String
255
Street Name
landmark
String
255
Landmark
country
String
2
Country
state
String
255
State
district
String
255
District
city
String
60
City
zip
Long
 
Zip
mobile_number
String
20
Mobile Number
status
String
30
Disable
customer_classification
Object
 
Data Object
customer_type_id
Long
 
Customer Type Id
annual_income_range_id
Long
 
Annual Income Range
annual_income_currency_code
String
30
Annual Income Currency Code
social_security_number
String
30
Social Security Number
tax_registration_number
Long
 
Tax Registration Number
txn_issued_country
String
2
Tax Issued Country
employer_name
String
30
Employer Name
employer_address
String
30
Employer Address
employer_phone
String
20
Employer Phone
employer_ecrn
String
16
Employer ECRN
employer_establishment_id
String
30
Employer Establishment ID
risk_rating_id
Long
 
Risk Rating ID
compliance_category_id
Long
 
Compliance Category ID
last_review_date
Date
 
Last review Date
next_review_date
Date
 
Next Review Date
pep_category
Integer
 
Pep Category
group_companies
Integer
 
Group Company
group_employer_code
String
30
Group Employee Code
personal_mohre_id
String
30
Personal Mohre Id
customer_cards
String
30
Customer Cards
card_number
String
30
Card Number
income_type
String
30
Income Type
profession_category
String
30
Profession Category
reason_for_acc
String
30
Reason for ACC
referred_by_type
Integer
 
Referred By Type
referred_by
String
30
Reffered By
txn_vol_month
String
30
Transaction Volume Month
txn_count_month
String
30
Transaction Count Month
show_remarks_on_txn
Boolean
 
show Remarks on transaction
customer_remarks
String
30
Remarks on Transaction
agent_ref_no
String
30
Agent reference number
ekyc_provider
String
30
ekyc provider
ekyc_ref_no
String
30
ekyc ref number
social_links
Object
 
Data Object
social_links_id
Long
 
Social Link Id
text_field
String
30
Text Field
subscriptions
Object
 
Data Object
subsciption_type
String
30
Subscription Type
subscription_id
String
30
Subscription Id
status
String
30
Status
first_language
String
3
Customer Preferred Language
marital_status
Integer
 
Marital Status
profile_category
Integer
 
Profile Category
dnfbp
Boolean
 
Designated Non-Financial Business and Professions
dpms
Boolean
 
Dealers in Precious Metals and Stones
 
AML Alert Closure CallBack Api
We will be calling partner API to update the customer status and AML status.
Payload
...
languagejson
...
ref number
social_links
Object
 
Data Object
social_links_id
Long
 
Social Link Id
text_field
String
30
Text Field
subscriptions
Object
 
Data Object
subsciption_type
String
30
Subscription Type
subscription_id
String
30
Subscription Id
status
String
30
Status
first_language
String
3
Customer Preferred Language
marital_status
Integer
 
Marital Status
profile_category
Integer
 
Profile Category
dnfbp
Boolean
 
Designated Non-Financial Business and Professions
dpms
Boolean
 
Dealers in Precious Metals and Stones
 
AML Alert Closure CallBack Api
We will be calling partner API to update the customer status and AML status.
Payload
 Code Block
{
   "aml_scan_status": "Accepted",
   "ecrn": "1058021235161541",
   "customer_status": "ACTIVE"
 }
Name
Data Type
Max Length
Description
ecrn
String
20
CDP Customer Unique Identification Number will be present if customer is onboarded to CDP
aml_scan_status
String
20
AML Scanned Status will be p[resent if customer is onboarded to CDP
“Accepted” / “Rejected“ / “Under Investigation”/ “Failed” / “N/A” (not available when screening not done)
customer_status
String
20
Customer Status will be present if customer is onboarded to CDP
 Status
colourGreen
titleACTIVE
 / 
 Status
colourYellow
titleKYC PENDING
 / 
 Status
colourYellow
titleINACTIVE
 / 
 Status
colourRed
titleREJECTED
 / 
 Status
colourRed
titleBLOCKED
Master Data
 View file
nameCDP-Master Values.xlsx
...