> For the complete documentation index, see [llms.txt](https://docs.kredibel.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kredibel.io/api-references/account-screening.md).

# 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`](/authentication-1.md) |

## Custom Config and Rules

To start using custom config and rules, you need to [create a config](/system/scoring-engine.md#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](/files/-Mfyxr5gbJwp4L-yC0v2)

```
{
	"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](/api-references/account-screening/bank-account.md)
* [Phone Number&#x20;
  ](/api-references/account-screening/phone-number.md)
* [Email Address
  ](/api-references/account-screening/email-address.md)
* [IP Address
  ](/api-references/account-screening/ip-address.md)
* [AML ](/api-references/account-screening/watchlist-screening.md)[Screening](/api-references/account-screening/watchlist-screening.md)
* [KYC Identity Module
  ](broken://pages/-McxZGFzhvdQORS_ppAI)
* [KYC Face Module
  ](broken://pages/-McxZGcKxisa1ekZdky-)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kredibel.io/api-references/account-screening.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.