> For the complete documentation index, see [llms.txt](https://docs.mfilterit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mfilterit.com/api-integrations/mfilterit-referer-status-api.md).

# mFilterIt Referer Status API

This api is for getting status of the referrer data using api provided by mFilterIt

## Version 1.0

## Overview

To allow a deeper and automated integration between the mFilterIt solution and the app developer’s in house systems for referral events, mFilterIt provides an endpoint to get the status of referrer data from mFilterIt backend system.

#### Backend API Schema

| Parameter Name     | Type   | Description                                                                                                            |
| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------- |
| **adid**           | string | The unique Google Advertising ID associated with the app user/ device. example: "0a946c9e-6df1-4d63-8fb0-679bfba3c2c9" |
| **installed\_app** | string | The android package name of the app. example: "com.mfilterit.android"                                                  |
| **secret\_key**    | string | The unique referral code for a customer . example: "abXms5rk87wkgf"                                                    |
| **device\_id**     | string | The unique device identifier associated with the android device. example: "4f36d627af4ab545"                           |
| **user\_id**       | string | The user\_id associated with a user, example: "12345mftest"                                                            |

### Note:

device\_id, installed\_app, secret\_key and user\_id are mandatory fields, other fields are optional.

### Backend API

An HTTP GET on the data collection endpoint is supported.

**GET /**

The Data Collection API receives data from third party servers. The parameters described above are received as Query String parameters. Result will be sent back in the response body.

{% tabs %}
{% tab title="Produces" %}
`application/json`
{% endtab %}

{% tab title="Response Body" %}

```http
{
            "FraudCategory":"Duplicate User",
            "FraudRiskScore":40,
            "EventTransactionId":"ASD294DG568659",
            "Device_Id":adid,
            "PhoneNumber":"1100234567",
            "EmailID":"abc@gmail.com",
            "MfilteritEventId":"MF12345678905678",
            "RegistrationId":user_id,
            "ReferralCode":"AHDYRF34565",
            "installed_app":installed_app
}
```

{% endtab %}
{% endtabs %}

### Endpoint:

```
https://referralstatus.mfilterit.net/
```