Onboarding - Web Crawling

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 - Web Crawling

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

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	It provides the response of the individuals official email id or the entities email ID legally involved
phone	String	Yes	It provides the response of the individuals official phone number or the entities
name	String	Yes
reseller_trade_name	String	No
entity_type	Object	Yes
client_type	Object	No
business	Object	Optional Except (Website_url and address)	If field verification is purchased, address field is mandatory
is_field_verify	Boolean	Optional
crawling	Object	Yes
mcc	Object	Yes

Sample Post Parameters

{
    "merchant_ref_id": "TUTMALA00007",
    "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",
        "trade_name": "Fintech",
        "website_url": "https://docs.tutelar.io/",
        "address": "CHENNAI"
    },
    "mcc": {
        "mcc_id": "2zYroPJ75",
        "mcc_code": "1520",
        "mcc_desc": "General Contractors – Residential and Commercial",
        "risk_type": "low"
    },
    "crawling": {
        "is_checked": true,
        "type": "basic",
    },
    "is_field_verify": false
}

200: Success Response

{
  "success": true,
  "message": "Merchant created successfully",
  "data": {
    "merchant_ref_id": "TUTMALA00007",
    "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",
      "trade_name": "Fintech",
      "website_url": "https://docs.tutelar.io/",
      "address": "CHENNAI"
    },
    "mcc": {
        "mcc_id": "2zYroPJ75",
        "mcc_code": "1520",
        "mcc_desc": "General Contractors – Residential and Commercial",
        "risk_type": "low"
    },
    "is_field_verify": true
  }
}

401: Permission denied

{
    "message": "Invalid authentication credentials"
}

Failure Response

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

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

{
    "success": false,
    "message": "Website url should not be empty",
    "code": "failure"
}

{
    "success": false,
    "message": "Trade Name should not be empty",
    "code": "failure"
}

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