KYC Risk Assessment Individual

2. Copy only the Authorization token that you got from the Authentication request.

4. Enter KEY as a Authorization and Description as a bearer (Authorization token) <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>.

5. Send a request using the POST method. The request must be in the following format:

You will get a response as an integer value (for example, Application ID": "IND282021", "Request ID": 28) which has to be passed in the GET Real-time KYC Prospect Feedback API {requestID}.

Real-Time KYC Risk Assessment Parameters

Request JSON Parameters

String

Unique Application ID generated by the onboarding system for each request.

String

The person/process (ID/Name) who is sending the onboarding request to KYC system.

String

The jurisdiction where account is opened.

String

The unique relationship code of the team.

String

The corresponding business domain of the applicant.

String

Captures source system details responsible for onboarding requests.

String

To invoke the API synchronous or asynchronous manner. The output of the onboarding API changes based on the SynchAPIFlag. The expected values are Y or N. If the field is not provided, the value will be considered N.

String

Unique identification of the applicant that needs to process.

String

The jurisdiction of the prospect.

String

Format - Y, N

The flag indicates prospect as primary.

String

The type of the prospect.

String

Captures the first name of the prospect.

String

Captures the middle name of the prospect.

String

Captures the last name of the prospect.

String

Captures the name suffix of the prospect.

String

Captures any titles of the prospect.

String Array

Captures all aliases of the prospect. Can hold multiple aliases.

String

Captures the display name of the prospect.

String

Format -DD/MM/YYYY

Date of birth of an individual.

String

Social Security Number or Tax Identification Number.

Number

Captures the age of the prospect.

String

Gender of the prospect.

String

Captures the marital status of the prospect.

String

Captures the number of the dependents of the prospect.

String Array

Primary citizenship of the prospect. This field can hold multiple values.

String Array

Secondary citizenship of the prospect. This field can hold multiple values.

String

Captures the citizenship status of the prospect.

String

Country of birth of the prospect.

String Array

Country of residence of the candidate.

String Array

Captures the self-reported source of wealth of the prospect.

String Array

Captures the occupation of the prospect.

String

Captures the job title of the prospect. For example, where the prospect is employed.

String

Captures the employment type of the prospect.

For example, student, employed, or retired

String

Captures the employment type of the prospect.

For example, student, employed, or retired

String

Name of the prospect's employer.

String

Industry of the prospect's employer.

Number

Format : YYYY

The retirement age of the prospect.

String

The Customer Identification Procedures (CIP) status of the prospect.

String

The flag indicates if this prospect can be exempted from identity verification.

String

The flag indicates whether identity verification is done.

String Array

The flag indicates whether this prospect is politically exposed person (PEP).

String

The flag indicates whether this prospect belongs to a politically exposed person (PEP) family.

String

Prospect identifier who is an existing customer of the institution.

String

The account type of the prospect.

String

The account opening method of the prospect.

Number

Risk associated with the length of relationship a prospect has with the bank or FI.

String

Industry of the prospect's employer.

o Address Purpose Code*

o Street

o Area

o City*

o State

o Region*

o Country*

o Postal Code*

o Relationship Type

o Country

o Credit Rating

o Credit Rating Source

o Credit Score

o Email Purpose

o Email Sequence Number

o Email Address*

o Stated Total Annual Income Base

o Stated Total Liquid Net Worth Base

o Income Currency

o Stated Total Net Worth Base

o Phone Purpose

o Phone Sequence Number

o Country Code Of Phone Number

o Machine Readable Zone 1

o Machine Readable Zone 2

o Relationship Effective Date

o Relationship Expiration Date

Response JSON Parameters

The following parameter explains the Response field for /kycob-prospect-service/prospect/v1/add

String

Unique application ID, For example, "APP18948970808"

Integer

System generated unique request identification number. For example, “254697908”l.

String

Request ID generated for an individual.

String

The status of the request whether successful or failure.

String

The unique case identification if case is created in Case Investigation service. For example, “CA1004”

String

The unique application identification.

String

Indicates onboarding flag whether Yes or No.

KYC decision to onboard or reject the prospect. For example, “N”

Note: Not mandatory, if the process failure.

§ Risk Assessment ID

§ Applicant ID

§ Risk Score

§ Risk Category

Request and Response JSON Sample

This section contains a request JSON sample for the onboarding JSON. The entries in this sample are only for reference purposes.

Request JSON Sample

{

"Application ID":"IND9 IND10",

"Request User ID":"1234",

"Data Origin": "KYC_OB",

"Account Opening Jurisdiction":"AMEA",

"Business Domain":"A",

"Relationship Team Code":"INV",

"SynchAPIFlag":"Y",

"Prospect": [

{

"Applicant ID":"IND9",

"Primary Prospect Flag":"Y",

"Prospect Type":"IND",

"First Name":"MAHRI",

"Middle Name":"Mohamed Ben",

"Last Name":"Ahmed",

"Name Suffix":"Jr",

"Title":"Mr",

"Alias": ["MAHRI Mohamed Ben Ahmed"],

"Display Name":"MAHRI Mohamed Ben Ahmed",

"Date Of Birth":"01/01/1999",

"SSN/TIN":"123456",

"Age": 0,

"Gender":"M",

"Marital Status":"MA",

"Number Of Dependents": 5,

"Primary Citizenship": "PK",

"Secondary Citizenship": ["AF"],

"Citizenship Status":"C",

"Country Of Birth":"Spn",

"Country Of Residence": ["TO"],

"Source Of Wealth": ["D"],

"Occupation": ["AA"],

"Job Title":"CEO",

"Employment Type":"Official",

"Employment Status":"EMP",

"Employer Name":"Jeni Inc",

"Employer Industry":"Casino",

"Retirement Year": "",

"CIP Verified Status":"CIPV",

"CIP Exempt Flag":"N",

"CIP Verified Flag":"Y",

"PEP Flag": ["Y"],

"Family PEP Flag":"Y",

"Existing Internal ID":"",

"Account Type":"CH",

"Type Of Account Opening":"PER",

"Length Of Relationship": 50,

"Industry":["INS", "OG", "APR" ],

"Address": [

{

"Address Purpose Code":"B",

"Building Number":"123",

"Building Name":"ATLAS TOWER",

"Street":"JAMAL ABDUD NASIR RD.",

"Street Line 1":"JAMAL RD.",

"Street Line 2":"ABDUD RD.",

"Street Line 3":"NASIR RD.",

"Street Line 4":"JAMAL ABDUD RD.",

"Street Line 5":"ABDUD NASIR RD.",

"Street Line 6":"JAMAL NASIR RD.",

"Area":"North",

"City":"Bangalore",

"State":"Karnataka",

"Region":"Karnataka",

"Country":"BM",

"Postal Code":"560066"

}

"Country": [

{

"Relationship Type":"C",

"Country":"AE"

}

"Credit Rating": [

{

"Credit Rating":"AAA",

"Credit Rating Source":"MOODY",

"Credit Rating Score": 580

}

"Email Address": [

{

"Email Purpose":"P",

"Email Sequence Number": 1,

"Email Address":"jamal@yahoo.co.in"

}

"Financials": {

"Stated Total Annual Income Base": 1000.234,

"Stated Total Liquid Net Worth Base": 1222,

"Income Currency":"USD",

"Stated Total Net Worth Base": 1222.098

"Phone": [

{

"Phone Purpose":"B",

"Phone Sequence Number": 1,

"Country Code Of Phone Number":"001",

"Phone Number":"9878798-9877-9876",

"Phone Extension":"621"

}

"Identification Document": [

{

"Document Purpose":"CID",

"Document Number":"12",

"Document Name":"1234",

"Machine Readable Zone 1":"P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",

"Machine Readable Zone 2":"L898902C<3UTO6908061F9406236ZE184226B<<<<<14",

"Issuing District":"Phil",

"Issuing Province":"North",

"Issuing City":"California",

"Issuing State":"Kansas",

"Issuing County":"Texas",

"Issuing Country":"USA",

"Issuing Date":"01/01/2020",

"Expiry Date":"01/01/2099",

"Issuing Authority":"Passport Office"

}

]

{

"Applicant ID":"IND10",

"Primary Prospect Flag":"N",

"Prospect Type":"IND",

"First Name":"BASTARDO",

"Middle Name":"MENDOZA",

"Last Name":"RAFAEL",

"Name Suffix":"Jr",

"Title":"Mr",

"Alias": ["Osama Bin Laden"],

"Display Name":"Osama Bin Laden",

"Date Of Birth":"01/01/1999",

"SSN/TIN":"123456",

"Age": 0,

"Gender":"M",

"Marital Status":"MA",

"Number Of Dependents": 5,

"Primary Citizenship": "BZ",

"Secondary Citizenship": ["AM"],

"Citizenship Status":"C",

"Country Of Birth":"Spn",

"Country Of Residence": ["TO"],

"Source Of Wealth": ["D"],

"Occupation": ["AA"],

"Job Title":"CEO",

"Employment Type":"Official",

"Employment Status":"EMP",

"Employer Name":"Jeni Inc",

"Employer Industry":"Casino",

"Retirement Year": "",

"CIP Verified Status":"CIPV",

"CIP Exempt Flag":"N",

"CIP Verified Flag":"Y",

"PEP Flag": ["Y"],

"Family PEP Flag":"Y",

"Existing Internal ID":"",

"Account Type":"CH",

"Type Of Account Opening":"PER",

"Length Of Relationship": 50,

"Industry":["INS", "OG", "APR" ],

"Address": [

{

"Address Purpose Code":"B",

"Building Number":"123",

"Building Name":"ATLAS TOWER",

"Street":"JAMAL ABDUD NASIR RD.",

"Street Line 1":"JAMAL RD.",

"Street Line 2":"ABDUD RD.",

"Street Line 3":"NASIR RD.",

"Street Line 4":"JAMAL ABDUD RD.",

"Street Line 5":"ABDUD NASIR RD.",

"Street Line 6":"JAMAL NASIR RD.",

"Area":"North",

"City":"Bangalore",

"State":"Karnataka",

"Region":"Karnataka",

"Country":"BG",

"Postal Code":"560066"

}

"Country": [

{

"Relationship Type":"C",

"Country":"AE"

}

"Credit Rating": [

{

"Credit Rating":"AAA",

"Credit Rating Source":"MOODY",

"Credit Rating Score": 580

}

"Email Address": [

{

"Email Purpose":"P",

"Email Sequence Number": 1,

"Email Address":"jamal@yahoo.co.in"

}

"Financials": {

"Stated Total Annual Income Base": 1000.234,

"Stated Total Liquid Net Worth Base": 1222,

"Income Currency":"USD",

"Stated Total Net Worth Base": 1222.098

"Phone": [

{

"Phone Purpose":"B",

"Phone Sequence Number": 1,

"Country Code Of Phone Number":"001",

"Phone Number":"9878798-9877-9876",

"Phone Extension":"621"

}

"Identification Document": [

{

"Document Purpose":"CID",

"Document Number":"12",

"Document Name":"1234",

"Machine Readable Zone 1":"P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",

"Machine Readable Zone 2":"L898902C<3UTO6908061F9406236ZE184226B<<<<<14",

"Issuing District":"Phil",

"Issuing Province":"North",

"Issuing City":"California",

"Issuing State":"Kansas",

"Issuing County":"Texas",

"Issuing Country":"USA",

"Issuing Date":"01/01/2020",

"Expiry Date":"01/01/2099",

"Issuing Authority":"Passport Office"

}

"Relationship":[{"Relationship Code":"SIS"}]

}

]

}

Response JSON Sample

{

"Application ID": "IND282021",

"Request ID": 28

}

{

"Status": "SUCCESSFUL",

"Case ID": "CA756",

"Application ID": "IND282021",

"Onboarding Flag": "N",

"Request ID": 28,

"Risk Assessments": [

{

"Risk Assessment ID": 42,

"Applicant ID": "IND282021",

"Risk Assessment Score": "84",

"Risk Assessment Category": "High",

{

"Risk Assessment ID": 41,

"Applicant ID": "IND282022",

"Risk Assessment Score": "20",

"Risk Assessment Category": "Low",

}

]

}

Using GET Real-Time KYC Prospect Feedback

End point Details

· HTTP Link -http://<hostname>:<port>/kycob-prospect-service/prospect/v1/getFeedbackByRequestID/{requestID}

Executing Real-time KYC Prospect Feedback

2. Copy only the Authorization token that you got from the Authentication request.

4. Enter KEY as an Authorization and Description as a bearer (Authorization token) <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>. .

5. Send a request using the GET method. The request must be in the following format:

§ Path : /kycob-prospect-service/prospect/v1/getFeedbackByRequestID/{requestID}

You will get a response as Real-time KYC Prospect Feedback for the particular request ID.

Real-time KYC Prospect Feedback Parameters

Request Parameters

The following parameter explains the Response field for csxe-real-time/executeRealTime.

Integer

System generated unique request identification number. For example, “254697908”l.

Response Parameters

The following list explains the Response fields for individual - /kycob-prospect-service/prospect/v1/getFeedbackByRequestID/{requestID}

Real-Time KYC Risk Assessment (Individual)

Using Real-Time KYC Risk Assessment

End Point Details

Executing Real-Time KYC Risk Assessment

Real-Time KYC Risk Assessment Parameters

Request JSON Parameters

Response JSON Parameters

Request and Response JSON Sample

Request JSON Sample

Response JSON Sample

Using GET Real-Time KYC Prospect Feedback

End point Details

Executing Real-time KYC Prospect Feedback

Real-time KYC Prospect Feedback Parameters

Request Parameters

Response Parameters

Request and Response JSON Sample

Request JSON Sample

Response JSON Sample