# Account Screening

## Introduction

Account screening is an endpoint that can be used for many use cases. It’s an **all-in-one** API that helps you onboard more good users, comply with government regulations, and reduce fraud rates.

{% embed url="<https://youtu.be/9ZaijdqxxqE>" %}

## 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) |

## Custom Config and Rules

To start using custom config and rules, you need to [create a config](https://docs.kredibel.io/system/scoring-engine#create-new-config). Then, after you create a config and get `configId` you can use it by defining `configId` like the code below supplied in Account Screening.

![Config List](https://2870805980-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-McrRQevDqT_jniFcAiY%2F-Mfyt8TEdbcrPL0AK2cs%2F-Mfyxr5gbJwp4L-yC0v2%2Fimage.png?alt=media\&token=89d2e4b2-3c2c-4b6b-a20f-135a1c138f22)

```
{
	"configId": "<YOUR_CONFIG_ID>",
	...
}
```

## General Response

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

| Field  | Type                                                           | Description                                      |
| ------ | -------------------------------------------------------------- | ------------------------------------------------ |
| id     | String                                                         | Unique identifier.                               |
| score  | Float                                                          | The accumulated value of all credibility scores. |
| status | <p>String</p><p><code>\["pass", "review", "reject"]</code></p> | <p><strong>Pass</strong>: Everything is alright. |

</p><p><strong>Review</strong>: There is something to be suspected. You have to check it manually.</p><p><strong>Reject</strong>: Potentially of high risk account. </p> |
{% endtab %}

{% tab title="Example" %}

```
{
    "message": "Account Screening - Single.",
    "data": {
        "id": "28b78927-8546-45fd-ba9f-17239bf366a9",
        "score": -15,
        "status": "review",
        ...
    }
```

{% endtab %}
{% endtabs %}

## Modules

To start using Account Screening Service, you must define at least **one or more** modules that you want to use.

* [Bank Account](https://docs.kredibel.io/api-references/account-screening/bank-account)
* [Phone Number&#x20;  ](https://docs.kredibel.io/api-references/account-screening/phone-number)
* [Email Address  ](https://docs.kredibel.io/api-references/account-screening/email-address)
* [IP Address  ](https://docs.kredibel.io/api-references/account-screening/ip-address)
* [AML ](https://docs.kredibel.io/api-references/account-screening/watchlist-screening)[Screening](https://docs.kredibel.io/api-references/account-screening/watchlist-screening)
* [KYC Identity Module  ](https://docs.kredibel.io/api-references/broken-reference)
* [KYC Face Module  ](https://docs.kredibel.io/api-references/broken-reference)
