Comment on page

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.
Endpoints
Method
URL
POST
$synapses/v1/account/scan/single
Headers
Header
Value
Content-Type
application/json
Authorization
Bearer YOUR_API_KEY​
Custom Config and Rules
To start using custom config and rules, you need to create a 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
{
	"configId": "<YOUR_CONFIG_ID>",
	...
}
General Response
Description
Example
Field
Type
Description
id
String
Unique identifier.
score
Float
The accumulated value of all credibility scores.
status
String
["pass", "review", "reject"]
Pass: Everything is alright.
Review: There is something to be suspected. You have to check it manually.
Reject: Potentially of high risk account. 
{
    "message": "Account Screening - Single.",
    "data": {
        "id": "28b78927-8546-45fd-ba9f-17239bf366a9",
        "score": -15,
        "status": "review",
        ...
    }
Modules
To start using Account Screening Service, you must define at least one or more modules that you want to use.
​Bank Account​
​Phone Number 
​
​Email Address
​
​IP Address
​
​AML ​Screening​
​KYC Identity Module
​
​KYC Face Module
​
​

Responses & Errors

Watchlist Screening

Last modified 3mo ago

Header	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer` `YOUR_API_KEY`

Field	Type	Description
id	String	Unique identifier.
score	Float	The accumulated value of all credibility scores.
status	String `["pass", "review", "reject"]`	Pass: Everything is alright. Review: There is something to be suspected. You have to check it manually. Reject: Potentially of high risk account.