Page Comparison

Table of Contents

...

Table of Contents

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.

...

An access token is a key to the gateway to access any other API. The API will return the access token if the user is successfully authenticated and have the authorization to access these services. Every access token is tagged with validity and the expiry duration is echoed in the response for the calling application to manage the state accordingly. Token if used after its validity period restrict access to any services and a new token to be generated in this case.

API

https://{{baseUrl}}/auth/realms/cdp/protocol/openid-connect/token

Method

POST

Headers

Content-Type : application/x-www-form-urlencoded

Access Token Payload

Code Block

language	json

--data-urlencode 'grant_type=password' \
--data-urlencode 'scope=api://3a3f52a1-1b64-4c27-81f0-50a6ca01324d/customer' \
--data-urlencode 'client_id=<<client_id>>' \
--data-urlencode 'client_secret=<<secret>>' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=<<username>>' \
--data-urlencode 'password=<<password>>'

Refresh Token Payload

Code Block

--data-urlencode 'grant_type=password' \
--data-urlencode 'client_id=<<client_id>>' \
--data-urlencode 'client_secret=<<secret>>' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'refresh_token=<<refreshToken>>' \

Response

Code Block

language	json

{
    "token_type": "bearer",
    "access_token": "<<access_token_value>>",
    "expires_in": 7199,
    "refresh_expires_in": 7199,
    "refresh_token": "<<refresh_token_value>>",
    "scope": "----",
    "not-before-policy": 0,
    "session_state": "<<session_state>>"
}

...

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

API

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

Authorization

Bearer Token

Method

POST

Headers

Content-Type:application/json

Payload

Code Block

language	json

{
    "idNumber": "784199554586091",
    "idType": "4"
}

Success Response

HttpStatusCode : 200

Code Block

language	json

{
    "status": "success",
    "statusCode": 200,
    "messagedata": "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

language	json

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

Subscription Pending Response

HttpStatusCode : 200

Code Block

language	json

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

Bad Request

HttpStatusCode : 200

Code Block

language	json

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

Internal Server Error

HttpStatusCode : 200

Code Block

language	json

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

Authentication Validation Failure Response - Customer Under Compliance Investigation

HttpStatusCode : 401200

Code Block

language	json

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

Validation Failure Response - Blocked Customer

HttpStatusCode : 200

Code Block

language	json

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

Authentication Failure Response

HttpStatusCode : 401

Code Block

language	json

{
    "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

colour	Green
title	MANDATORY

Content type

Authorization

String

Status

colour	Green
title	MANDATORY

Authorization Token

...

API

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

Authorization

Bearer Token

Method

POST

Headers

Content-Type:application/json

Payload

Code Block

language	json

{
    "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

language	json

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

Validation Failure Response - Customer Under Compliance Investigation

HttpStatusCode : 406

Code Block

language	json

{
    "request_id": "ce94bf27c6bd28b958a18544650075969dff05c2a18e6e73964c0c91f75f463b",
    "status": "failed",
    "status_code": "406 NOT_ACCEPTABLE",
    "error_code": "45013",
    "message": "Customer 78410032374936787841003236577331 Under Compliance Investigation"
}

Validation Failure Response - Blocked Customer

HttpStatusCode : 406

Code Block

language	json

{
    "request_id": "dee033942cdce475bfbd55c0a6c26ffad0f7edcbb91abefa58f3fc9672711e1b",
    "status": "failed",
    "status_code": "406 NOT_ACCEPTABLE",
    "error_code": "45051",
    "message": "Customer 78410032306896451074023185717024 CanCannot not be Accepted"
}

Validation Failure Response - Invalid Master Data

HttpStatusCode : 400

Code Block

language	json

{
    "request_id": "2a8d49903fd6782a955ee22258cd314ccb3bc0a37334c4eacdbea088f926b7ab",
    "status": "failed",
    "status_code": "406 NOT_ACCEPTABLE",
    "error_code": "45053",
    "message": " Invalid Nationality AqINN!"
}

Validation Failure Response - Mandatory Field Missing

HttpStatusCode : 400

Code Block

language	json

{
    "status": "failure",
    "status_code": 400,
    "error_code": 40002,
    "message": "Invalid format or missing mandatory request",
    "details": {
        "firstName": "Invalid first name"
    },
    "request_id": "729d5085e553f3830277d0cb5372f2b2"
}

Authentication Failure Response

HttpStatusCode : 401

Code Block

language	json

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

Internal Server Error

HttpStatusCode : 502

Code Block

language	json

{
    "status": "failed",
    "message": "Backend Technical Problem",
    "status_code": "502",
    "error_code": "40001",
    "request_id": "a700be42dcbb3c71f36c1bcea42f41fa"
}

...

{

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

language	json

GET

Headers

Content-Type: application/json

Payload

Code Block
None

Success Response

HttpStatusCode: 200

Code Block

language	json

{
    "status": "success",
    "statusCode": 200,
    "data": {
        "dateUpdated": "2024-03-26T07:51:57.909545Z",
        "registrationDate": "2024-03-26 07:09:24",
        "ecrn": "10580212351615417841003247752409",
        "first_name": "VINOTH"IRFAN,
  MANAKKAT THEKKE",     "salutation": null,
        "middle_name": "PURAYIL ISMAIL",
        "last_name": "NANGARATH MUNDACHI",
        "preferred_name": "IRFAN M MANAKKATT THEKKEP",
        "nationality": "IN",
        "second_nationality": "GB",
        "native_region": 1,
        "date_of_birth": "19951973-07-28",
        "country_of_birth": "IN",
        "place_of_birth": "INDIA",
        "resident_type_id": 101,: 101,
        "country_of_residence": "AE",
        "gender": "Male",
        "mothers_maiden_name": null,
  "maiden Name",     "primary_mobile_number": "+971502106707971502106709",
        "secondary_mobile_number": "+971502106706971502106708",
        "email_id": "irfanmtp1@gmailIRFANMTP1@GMAIL.comCOM",
        "phone_number": "+971502106705",null,
        "occupation_id": 2856,
        "political_exposed_person": false,
     "aml_scan_status   "channel": "AcceptedBRANCH",
    "customer_iban": "AE083141058021235161541",     "customeraml_scan_status": "ACTIVEAccepted",
    "aml_category": 5,
    "additionalcustomer_docsiban": ["AE253147841003247752409",
        {
   "agent_location_id": "784101",
        "contentTypecustomer_status": "image/jpegACTIVE",
 
          "fileaml_namecategory": "customer/additionalDoc/1058021235161541_1.jpeg"2,
        }
"additional_docs": [],
   ],     "address_list": [
            {
                "dateUpdated": "20232024-03-15T1426T07:3409:0724.849554Z605116Z",
                "address_type_id": "1",
                "building_name": "MANKHOOL  BUILDING 2",
                "street_name": "GHG",
                "landmark": "AL NAHDA",
                "city": "EMIRATE OF DUBAI",": "EMIRATE OF DUBAI",
                "district": "HGJH",
                "districtstate": "JGHFHG",
                "statecountry": " AE",
                "countryzip": "AE"0,
            "zip    "po_box": 0null,
                "mobile_number": null
            }
        ],
        "id_details": [
            {
                "dateUpdated": "20232024-03-15T1426T07:3409:0724.849554Z605116Z",
                "id_type": 21,
                "id_number": "P4006315126657",
                "visa_number": "0TRF45",
                "visa_expiry_date": null"2025-08-08",
                "name_as_per_id": " ",
                "issued_country": "IN",AE",
                "issued_by": "INDIAEIDA Govt.GOVT",
                "issued_at": null,
                "issued_on": "20162020-08-08",
                "date_of_expiry": "20262025-08-08",
                "default_status": truefalse,
                "active_status": truefalse,
                "id_front": null, {
                    "idbase64_backdata": null "",
                     },
"file_name": "customer/id/7841003247752409_ID_FR_1_126657.jpg",
       {             "dateUpdatedcontent_type": "2023-03-15T14:34:07.849554Z",image/jpg"
               "id_type": 4, },
                "id_numberback": "784199554586091", {
                    "visabase64_numberdata": "0",
                    "visafile_expiry_datename": null,"customer/id/7841003247752409_ID_BK_1_126657.jpg",
             "name_as_per_id       "content_type": " ",image/jpg"
                }
   "issued_country": "AE",        }
    "issued_by": "EIDA",    ],
        "issuedcustomer_atclassification": null,{
            "issued_ondateUpdated": "20202024-08-0803-26T07:51:57.909545Z",
            "datecustomer_oftype_expiryid": "2023-08-08"2,
            "default_statusannual_income_range_id": true15,
            "active_statusannual_income_currency_code": truenull,
            "idsocial_security_frontnumber": {null,
                "base64_data"tax_registration_number": ""null,

               "file_name": "customer/id/1058021235161541_ID_FR_4_784199554586091.jpeg",
   "txn_issued_country": null,
            "contentemployer_typename": "image/jpegEMKE",
            }"employer_address": "null",
            "idemployer_backphone": " null",
        }     ]"employer_ecrn": "",
    "customer_classification": {         "dateUpdatedemployer_establishment_id": "2023-02-14T10:28:03.762012Z",
            "customerrisk_typerating_id": 23,
            "annuallast_incomereview_range_iddate": 15"2024-03-26",
            "annualnext_incomereview_currency_codedate": null,"2025-03-26",
            "socialpep_security_numbercategory": null,
            "taxgroup_registration_numbercompanies": null,
            "txngroup_issuedemployer_countrycode": " null",
         "employer_name   "personal_mohre_id": "EMKE",
            "employerincome_addresstype": "UAE",1,
            "employerprofession_phonecategory": " ",
            "employerreason_for_ecrnacc": " ",
            "employerreferred_establishment_idby": "1058021235161541",
            "riskreferred_ratingby_idtype": 31,
            "lasttxn_reviewvol_datemonth": null1,
            "nexttxn_reviewcount_date": null,month": 1,
            "pep_categoryshow_remarks_on_txn": nullfalse,
            "groupcustomer_companiesremarks": null"JHGJG",
            "groupagent_employerref_codeno": " ",null,
            "personalekyc_mohre_idprovider": ""null,
         "income_type   "ekyc_ref_no": 1null,
            "professioncustomer_categorycards": "",null,
            "reasoncard_for_accnumber": " ",null,
            "referredsocial_bylinks": "1058021235161541"[],
        "referred_by_type    "subscriptions": 1,
[
       "txn_vol_month": 1,         "txn_count_month": 1,{
          "show_remarks_on_txn": false,         "customersubsciption_remarkstype": "Digital Channel",
         "agent_ref_no": null,           "ekycsubscription_providerid": null"LULUMONEY",
          "ekyc_ref_no": null,         "customer_cardsstatus": null,"active"
        "card_number": null,         "social_links": []},
        "subscriptions": [       {
     {                 "subsciption_type": "PREMIUM",
                    "subscription_id": "GOLD CARD",
                    "status": "active"
                }
            ],
            "first_language": "",null,
            "marital_status": null,
            "dnfbp": false,
            "dpms": false,
            "profile_category": 1,
            "profile_photo_file_name": null
        },
        "customer_relations": [],
        "communication_consents": [": [
            {
                "communication_type": 1,
                "allow": true
            },
  {          {
  "allow": true,             "communication_type": 2,
1         },       "allow": true
  {          }
   "allow": true,    ],
        "communication_typeupdated_agent_location_id": 2"784101",
         }"updated_channel": "BRANCH"
    ]}
}

Authentication Failure Response

HttpStatusCode: 401

Code Block

language	json

{
        "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

language	json

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

Customer not found Failure Response

HttpStatusCode: 200

Code Block

language	json

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

...

Versions Compared

Old Version 19

New Version 20

Key

Header