# 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

<mark style="color:green;">`POST`</mark> `https://secctrl.tutelar.io/api/v1/onboarding-protect/web-crawling`

### Post parameters description is given below

<table><thead><tr><th width="171">Parameter</th><th width="86">Type</th><th width="133">Is Mandatory</th><th width="355">Description</th></tr></thead><tbody><tr><td>merchant_ref_id</td><td>String</td><td>Yes</td><td>It should be <em>unique</em>. It helps to identify the new  merchant that comes from which client.</td></tr><tr><td>email</td><td>String</td><td>Yes</td><td>It provides the response of the individuals official email id or the entities email ID legally involved</td></tr><tr><td>phone</td><td>String</td><td>Yes</td><td>It provides the response of the individuals official phone number or the entities</td></tr><tr><td>name</td><td>String</td><td>Yes</td><td></td></tr><tr><td>reseller_trade_name</td><td>String</td><td>No</td><td></td></tr><tr><td>entity_type</td><td>Object</td><td>Yes</td><td></td></tr><tr><td>client_type</td><td>Object</td><td>No</td><td></td></tr><tr><td>business</td><td>Object</td><td>Optional<br><strong>Except</strong> (Website_url and address)</td><td>If field verification is purchased, address field is mandatory</td></tr><tr><td>is_field_verify</td><td>Boolean</td><td>Optional</td><td></td></tr><tr><td>crawling</td><td>Object</td><td>Yes</td><td></td></tr><tr><td>mcc</td><td>Object</td><td>Yes</td><td></td></tr><tr><td>source_from</td><td>String</td><td>Yes</td><td>It can contain one of the following values: <strong>APP</strong>, <strong>DIRECT</strong>, <strong>WEBSITE</strong>, or <strong>RESELLER</strong>.</td></tr></tbody></table>

### Sample Post Parameters

```json
{
    "merchant_ref_id": "TUTMALA00007",
    "source_from": "RESELLER",
    "email": "gowtham@gmail.com",
    "phone": "8710308721",
    "name": "Gowtham",
    "reseller_ref_id": "RESTUT01",
    "client_type": {
        "code": "O96ty9TSb",
        "name": "Airlines"
    },
    "entity_type": {
        "code": "Vmtpxzpct",
        "name": "Public Limited"
    },
    "business": {
        "name": "Tutelar",
        "trade_name": "Fintech",
        "date_of_registration": "11-12-1999",
        "website_url": "https://docs.tutelar.io/",
        "address": "CHENNAI",
        "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"
            }
          ]
    },
    "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
}
```

{% tabs %}
{% tab title="200: Success Response " %}

```json
{
  "success": true,
  "message": "Merchant created successfully",
  "data": {
    "merchant_ref_id": "TUTMALA00007",
    "email": "gowtham@gmail.com",
    "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
  }
}
```

{% endtab %}

{% tab title="401: Permission denied " %}

```json
{
    "message": "Invalid authentication credentials"
}
```

{% endtab %}

{% tab title="Failure Response" %}

```json
{
    "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"
}
```

{% endtab %}
{% endtabs %}