Onboarding - KYC

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 - KYC

POST https://secctrl.tutelar.io/api/v1/onboarding-protect/kyc

Post parameters description is given below

Parameter	Type	Is Mandatory	Description
merchant_ref_id	String	Yes	It should be unique. It helps to identify the new merchant that comes from which client.
email	String	Yes
phone	String	Yes
name	String	Yes
reseller_trade_name	String	No
business	Object	Optional Except (name and address)	If field verification is purchased, address field is mandatory
entity_type	Object	Yes
client_type	Object	No
kyc_checks	Object	Yes
mcc	Object	Yes
is_field_verify	Boolean	Optional
bank_verification_status	Boolean	Yes

Sample Post Parameters

{
    "merchant_ref_id": "TUTMALA00006",
    "email": "[e-mail]",
    "phone": "8710308721",
    "name": "Gowtham",
    "reseller_trade_name": "Deepak Trade",
    "client_type": {
        "code": "O96ty9TSb",
        "name": "Airlines"
    },
    "entity_type": {
        "code": "Vmtpxzpct",
        "name": "Public Limited"
    },
    "business": {
        "name": "Tutelar",
        "pan": "CUTTY0987H",
        "address": "Chennai",
        "gst": "33AAHCV5397D1U8",
        "aadhar": "909088183490"
    },
    "mcc": {
        "mcc_id": "2zYroPJ75",
        "mcc_code": "1520",
        "mcc_desc": "General Contractors – Residential and Commercial",
        "risk_type": "low"
    },
    "kyc_checks": {
        "name": "simplified"
    },
    "is_field_verify": false
}

200: Success Response

{
  "success": true,
  "message": "Merchant created successfully",
  "data": {
    "merchant_ref_id": "TUTMALA00006",
    "email": "[e-mail]",
    "phone": "8710308721",
    "name": "Gowtham",
    "reseller_trade_name": "Deepak Trade",
    "client_type": {
      "code": "O96ty9TSb",
      "name": "Airlines"
    },
    "entity_type": {
      "code": "Vmtpxzpct",
      "name": "Public Limited"
    },
    "business": {
      "name": "Tutelar",
      "pan": "CUTTY0987H",
      "address": "Chennai",
      "gst": "33AAHCV5397D1U8",
      "aadhar": "909088183490"
    },
    "mcc": {},
    "kyc_checks": {
      "name": "simplified"
    },
    "is_field_verify": true
  }
}

401: Permission denied

{
    "message": "Invalid authentication credentials"
}

Failure Response

{
    "success": false,
    "message": "KYC product not subscribed!",
    "code": "failure"
}

{
    "success": false,
    "message": "Merchant reference id already exist",
    "code": "failure"
}

{
    "success": false,
    "message": "kyc checks should not be empty/invalid",
    "code": "failure"
}