Kredibel API
  • Home
  • Knowledge Base
    • Security
    • Scoring Engine
    • Blacklist & Whitelist
    • Team Management
  • API Guide
  • Getting Started
  • Environment
  • Authorization
  • Responses & Errors
  • API References
    • Account Screening
      • Watchlist Screening
      • Bank Account
      • Phone Number
      • Email Address
      • IP Address
    • Electronic Certificate
      • Certificate Issuance
    • Identity Verification [Deprecated]
      • Biometric Verification
      • Demography Verification
      • Full Verification
    • Text Recognition
      • National Identity
      • Driver License
      • Passport
    • Face Recognition
      • Face Comparison
    • Billing
      • Credit
Powered by GitBook
On this page
  • Introduction
  • Endpoints
  • Headers
  • Custom Config and Rules
  • General Response
  • Modules

Was this helpful?

  1. API References

Account Screening

PreviousResponses & ErrorsNextWatchlist Screening

Last updated 10 months ago

Was this helpful?

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/screening

Headers

Header

Value

Content-Type

application/json

Authorization

Custom Config and Rules

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

General Response

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.

  • KYC Identity Module

  • KYC Face Module

Bearer

To start using custom config and rules, you need to . Then, after you create a config and get configId you can use it by defining configId like the code below supplied in Account Screening.

Bank Account
Phone Number
Email Address
IP Address
AML
Screening
YOUR_API_KEY
create a config
Config List