> For the complete documentation index, see [llms.txt](https://docs.tutelar.io/tutelar-api-document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tutelar.io/tutelar-api-document/merchant-onboarding/onboarding-ndi.md). # Onboarding - NDI Onboarding refers to the process of bringing a new merchant or business onto a payment processing platform or network. It typically involves gathering information about the merchant such as Business name, Client type, Entity type, Address, Bank details and so on. With the help of onboarding , we can conclude whether the merchants are legitimate, financially stable, and pose an acceptable level of risk to the payment platform. ## Onboarding - NDI `POST` `https://secctrl.tutelar.io/api/v1/onboarding-protect/ndi-analysis` ### Post parameters description is given below
ParameterTypeIs MandatoryDescription
merchant_ref_idStringYesIt should be unique. It helps to identify the new merchant that comes from which client.
emailStringYes
phoneStringYes
nameStringYes
reseller_trade_nameStringNo
businessObjectOptional
Except (name and address)		If field verification is purchased, address field is mandatory
entity_typeObjectYes
client_typeObjectNo
bank_infoObjectNo
is_field_verifyBooleanOptional
bank_verification_statusBooleanYes
mccObjectYes
source_fromStringYesIt can contain one of the following values: APP, DIRECT, WEBSITE, or RESELLER.
### Sample Post Parameters ```json { "merchant_ref_id": "TUTSYED000001", "source_from": "RESELLER", "email": "syed@gmail.com", "phone": "7904694204", "name": "Syed", "reseller_ref_id": "RESTUT01", "client_type": { "code": "O96ty9TSb", "name": "Airlines" }, "entity_type": { "code": "YjbIvfvqr", "name": "Sole Proprietorship" }, "business": { "name": "PLAYO", "trade_name": "PLAYO", "registration_number": "0952598", "date_of_registration": "11-12-1999", "website_url": "https://nadinitradde.com", "pan": "ABCDE6689E", "address": "CHENNAI", "gst": "33AAHCP1478L1Z6", "authorized": [ { "name": "Rohit Sharma", "authorizer_type": "signatory", "panNumber": "CWKMR2647X", "dateOfBirth": "02-12-2000", "fathersName": "Siva Raj", "address": "11/116, Anna Nagar, Mumbai", "kycType": { "name": "Aadhaar Card", "code": "ind_aadhaar" }, "kycNumber": "345644563456" }, { "name": "Amit Verma", "authorizer_type": "director" }, { "name": "Neha Kapoor", "authorizer_type": "signatory_director" } ] }, "bank_info": { "account_number": "1234567894563", "iban": "DE234342352343", "account_holder_name": "syed", "ifsc_code": "IFSC0423423", "bank_name": "kotak" }, "mcc": { "mcc_id": "2zYroPJ75", "mcc_code": "1520", "mcc_desc": "General Contractors – Residential and Commercial", "risk_type": "low" }, "is_field_verify": false, "bank_verification_status": true } ``` {% tabs %} {% tab title="200: Success Response " %} ```json { "success": true, "message": "Merchant created successfully", "data": { "link_analysis_report": { "link_analysis_score": { "active_link": 20, "reject_link": 50, "search_link": 20 }, "search_instances": { "email": 38, "address": 38, "account_number": 38, "company_name": 38, "website_url": 28, "phone": 38, "pan": 38, "gst": 39, "registration_number": 38, "authorized_signatory_3": 38, "account_holder_name": 38, "authorized_signatory_1": 38, "authorized_signatory_2": 38 }, "reject_link": { "address": 2, "pan": 2, "account_holder_name": 2, "website_url": 2, "company_name": 2, "phone": 2, "email": 2, "gst": 2, "registration_number": 2, "account_number": 2, "authorized_signatory_1": 2, "authorized_signatory_2": 2, "authorized_signatory_3": 2 }, "active_link": { "company_name": 2, "phone": 2, "email": 2, "address": 2, "gst": 2, "pan": 2, "account_number": 2, "registration_number": 2, "authorized_signatory_1": 2, "account_holder_name": 2, "authorized_signatory_2": 2, "authorized_signatory_3": 2, "website_url": 1 } }, "negative_data_report": {}, "merchant_ref_id": "FLIPKART22200", "consolidate_score": { "score": 90, "status": "high" }, "priority_action": "reject", "searches": { "registration_number": { "search_id": "ZVVfsh0R0", "search_field_name": "registration_number", "search_field_value": "924355876577894334240", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "address": { "search_id": "PHGMxvij7", "search_field_name": "address", "search_field_value": "No. 2A, Annapoorni nagar, Ponniammanmedu, Chennai 600110. ", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "authorized_signatory_2": { "search_id": "P0yzBoxKe", "search_field_name": "authorized_signatory_2", "search_field_value": "Hari Prasad", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "pan": { "search_id": "PHLCoUIXD", "search_field_name": "pan", "search_field_value": "ABCDR1232F", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "authorized_signatory_1": { "search_id": "2f1kFfb1h", "search_field_name": "authorized_signatory_1", "search_field_value": "Sanjays Kumar", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "authorized_signatory_3": { "search_id": "YsoutjP2n", "search_field_name": "authorized_signatory_3", "search_field_value": "Farid E", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "account_number": { "search_id": "3icvbS5r5", "search_field_name": "account_number", "search_field_value": "833483423", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "website_url": { "search_id": "GfUVdB8gd", "search_field_name": "website_url", "search_field_value": "www.flipkart.com", "no_of_search": 29, "merchant_count": 3, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTDINE00002", "merchant_ref_id": "FLIPKART90400", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 16, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "email": { "search_id": "jaqTlDFwg", "search_field_name": "email", "search_field_value": "flipkarts@gmail.com", "no_of_search": 40, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 6, "tag": "PA" } ] }, "account_holder_name": { "search_id": "Ta54UrZDz", "search_field_name": "account_holder_name", "search_field_value": "FlipKart Pvt Ltd", "no_of_search": 39, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-09T17:59:37.440Z", "no_of_search": 4, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] }, "gst": { "search_id": "KkQ1GYM0K", "search_field_name": "gst", "search_field_value": "27AAPFU0939F2ZV", "no_of_search": 40, "merchant_count": 4, "last_search": "2023-03-23T06:50:41.592Z", "merchants": [ { "merchant_id": "TUTFRON00001", "merchant_ref_id": "FLIPKART96450", "name": "Frontend Vinay", "last_search": "2023-03-10T04:54:36.363Z", "no_of_search": 5, "tag": "PA" }, { "merchant_id": "TUTDINE00002", "name": "Dinesh", "last_search": "2023-03-17T10:45:54.012Z", "no_of_search": 22, "tag": "PA" }, { "merchant_id": "TUTFARM00022", "name": "FARM FRESH MEATS", "last_search": "2023-03-17T10:54:51.637Z", "no_of_search": 8, "tag": "PA" }, { "merchant_id": "TUTFIVE00017", "name": "Five Star Mobiles", "last_search": "2023-03-23T06:50:41.592Z", "no_of_search": 5, "tag": "PA" } ] } } } } ``` {% endtab %} {% tab title="401: Permission denied " %} ```json { "message": "Invalid authentication credentials" } ``` {% endtab %} {% tab title="Failure Response" %} ```json { "success": false, "message": "NDI Analysis product not subscribed!", "code": "failure" } { "success": false, "message": "Merchant reference id already exist", "code": "failure" } ``` {% endtab %} {% endtabs %}