Email Address

You can use the Email module by defining the emailAddress that you want to check to your request.

Endpoints

Method	URL
POST	$synapses/v1/account/screening

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer YOUR_API_KEY

Request

Description

Field	Type	Description
emailAddress (required)	String (Email)	Email address used for transaction
verifyEmail	Boolean	If true, system will verify email address validity

Example

{
	  "emailAddress": "[e-mail]",
    "verifyEmail": true
}

Response

Description

Field	Type	Description
fullName	String	Full name
emailAddress	String	Email address
validity	String ["valid", "risky", "invalid", "not_sure"]	valid: Email address is exist and its safe to send mail risky: Email address is exist but its risky to send mail invalid: Email address not exist not_sure: Our system failed to verify the email address
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	Boolean	Return true when it’s a public email address (e.g. @gmail.com)
isHighRiskHost	Boolean	Return true when it’s a high risk email host (e.g. @gmail.my.id)
isWhitelist	Boolean	Define whether you have whitelisted this account number or not
isBlacklist	Boolean	Define whether you have blacklisted this account number or not
score	Float	Total accumulated credibility score of the Email Address

Example

{
    "message": "Account Screening - Single.",
    "data": {
        "id": "49220c90-d83d-4c12-8fbc-55527bbcf40a",
        "score": 0,
        "status": "pass",
        "emailDetails": {
            "fullName": null,
            "emailAddress": "[e-mail]",
            "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
        }
    }
}