# Email Address

## Endpoints

| Method | URL                                  |
| ------ | ------------------------------------ |
| POST   | `$synapses`**/v1/account/screening** |

### Headers

| Header          | Value                                                                |
| --------------- | -------------------------------------------------------------------- |
| `Content-Type`  | `application/json`                                                   |
| `Authorization` | `Bearer` [`YOUR_API_KEY`](https://docs.kredibel.io/authentication-1) |

### **Request**

{% tabs %}
{% tab title="Description" %}

| Field                                                              | Type                                                                    | Description                                        |
| ------------------------------------------------------------------ | ----------------------------------------------------------------------- | -------------------------------------------------- |
| <p>emailAddress</p><p><strong><code>(required)</code></strong></p> | <p><code>String</code> </p><p><strong><code>(Email)</code></strong></p> | Email address used for transaction                 |
| verifyEmail                                                        | `Boolean`                                                               | If true, system will verify email address validity |
| {% endtab %}                                                       |                                                                         |                                                    |

{% tab title="Example" %}

```
{
	  "emailAddress": "contoh@gmail.com",
    "verifyEmail": true
}
```

{% endtab %}
{% endtabs %}

### **Response**

{% tabs %}
{% tab title="Description" %}

| Field               | Type                                                                                                        | Description                                                                                                                                                                                                                                                                                                                                                 |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fullName&#xD;       | `String`&#xD;                                                                                               | Full name                                                                                                                                                                                                                                                                                                                                                   |
| emailAddress        | `String`&#xD;                                                                                               | Email address                                                                                                                                                                                                                                                                                                                                               |
| validity            | <p><code>String</code> </p><p><strong><code>\["valid", "risky", "invalid", "not\_sure"]</code></strong></p> | <p><strong><code>valid</code></strong>: Email address is exist and its safe to send mail</p><p><strong><code>risky</code></strong>: Email address is exist but its risky to send mail</p><p><strong><code>invalid</code></strong>: Email address not exist</p><p><strong><code>not\_sure</code></strong>: Our system failed to verify the email address</p> |
| isDisposable        | `Boolean`                                                                                                   | Define whether the email is disposable                                                                                                                                                                                                                                                                                                                      |
| smtp.isConnected    | `Boolean`                                                                                                   | Define can we connected to the domain of the email?                                                                                                                                                                                                                                                                                                         |
| smtp.isFull         | `Boolean`                                                                                                   | Define whether the email address mailbox is full                                                                                                                                                                                                                                                                                                            |
| smtp.isDeliverable  | `Boolean`                                                                                                   | Define whether an email sent to this address is deliverable                                                                                                                                                                                                                                                                                                 |
| smtp.records        | `List`                                                                                                      | MX records of the email address                                                                                                                                                                                                                                                                                                                             |
| images              | `List`                                                                                                      | Images of the email                                                                                                                                                                                                                                                                                                                                         |
| breaches            | `List`                                                                                                      | Is the email appear in the breach list                                                                                                                                                                                                                                                                                                                      |
| isPrivateHost       | `Boolean`                                                                                                   | Return true when it's a private email address (e.g. @google.com)                                                                                                                                                                                                                                                                                            |
| isPublicHost&#xD;   | `Boolean`                                                                                                   | Return true when it’s a public email address (e.g. @gmail.com)&#xD;                                                                                                                                                                                                                                                                                         |
| isHighRiskHost&#xD; | `Boolean`                                                                                                   | Return true when it’s a high risk email host (e.g. @gmail.my.id)&#xD;                                                                                                                                                                                                                                                                                       |
| isWhitelist&#xD;    | `Boolean`                                                                                                   | Define whether you have whitelisted this account number or not&#xD;                                                                                                                                                                                                                                                                                         |
| isBlacklist&#xD;    | `Boolean`                                                                                                   | Define whether you have blacklisted this account number or not                                                                                                                                                                                                                                                                                              |
| score               | `Float`&#xD;                                                                                                | Total accumulated credibility score of the Email Address                                                                                                                                                                                                                                                                                                    |
| {% endtab %}        |                                                                                                             |                                                                                                                                                                                                                                                                                                                                                             |

{% tab title="Example" %}

```
{
    "message": "Account Screening - Single.",
    "data": {
        "id": "49220c90-d83d-4c12-8fbc-55527bbcf40a",
        "score": 0,
        "status": "pass",
        "emailDetails": {
            "fullName": null,
            "emailAddress": "contoh@gmail.com",
            "validity": "valid",
            "isDisposable": false,
            "smtp": {
                "isConnected": true,
                "isFull": false,
                "isDeliverable": true,
                "records": [
                    "alt2.gmail-smtp-in.l.google.com.",
                    "alt1.gmail-smtp-in.l.google.com.",
                    "gmail-smtp-in.l.google.com.",
                    "alt3.gmail-smtp-in.l.google.com.",
                    "alt4.gmail-smtp-in.l.google.com."
                ]
            },
            "images": [],
            "breaches": [
                {
                    "name": "Bukalapak"
                },
                {
                    "name": "Cit0day"
                },
                {
                    "name": "Collection1"
                },
                {
                    "name": "Dailymotion"
                },
                {
                    "name": "Dropbox"
                },
                {
                    "name": "Edmodo"
                },
                {
                    "name": "Leet"
                },
                {
                    "name": "Lifeboat"
                },
                {
                    "name": "Nitro"
                },
                {
                    "name": "ShopBack"
                },
                {
                    "name": "Tamodo"
                },
                {
                    "name": "Tokopedia"
                },
                {
                    "name": "Wattpad"
                }
            ],
            "isBreached": true,
            "isPrivateHost": false,
            "isPublicHost": true,
            "isHighRiskHost": false,
            "isBlacklist": false,
            "isWhitelist": false,
            "score": 0
        }
    }
}
```

{% endtab %}
{% endtabs %}