API Reference
中文

International Email Pro

API Format

Base URL

API

URLRequest MethodsContent-TypeOutput FormatCharacter Set
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

example: <https://sg.apitd.net/verification/persona/email/pro/v1?partner_code=test_code&partner_key=test_key>

Authentication
ParameterTypeDescriptionRequired/OptionalNotes
partner_codeStringPartner Coderequiredassigned by TD
partner_keyStringPartner Keyrequiredassigned by TD

Request

ParameterTypeDescriptionRequired/OptionalNotes
emailStringEmail Addressrequired

Request Example

{
    "email": "[email protected]"
}

Response Parameter

[block:parameters]

{
  "data": {
    "h-0": "**Parameter**",
    "h-1": "**Type**",
    "h-2": "**Description**",
    "h-3": "**Notes**",
    "0-0": "code",
    "0-1": "Integer",
    "0-2": "API Status Code",
    "0-3": "",
    "1-0": "message",
    "1-1": "String",
    "1-2": "Status Message",
    "1-3": "specific abnormal reasons will be provided if the API is abnormal",
    "2-0": "sequence_id",
    "2-1": "String",
    "2-2": "Unique ID of Response",
    "2-3": "A unique ID used to mark each request",
    "3-0": "status",
    "3-1": "String",
    "3-2": "Email Status",
    "3-3": "enumeration: valid, invalid, abuse, unknown",
    "4-0": "risk_labels",
    "4-1": "Array",
    "4-2": "Risk Label",
    "4-3": "suspicious, temporary, random, similar",
    "5-0": "free_mail",
    "5-1": "String",
    "5-2": "Free Mail Status",
    "5-3": "enumeration: free, paid, unknown",
    "6-0": "risk_score",
    "6-1": "Integer",
    "6-2": "Risk Score",
    "6-3": "range: 0 - 100"
  },
  "cols": 4,
  "rows": 7,
  "align": [null, null, null, null]
}

[/block]

API Status Code

codeDescription
200Success
301Service not purchased
302Traffic blocked
303Traffic insufficient
304Service expired
305Daily maximum volume reached
9600System error
9606Illegal parameter

Response Example

{
  "code": 200,
  "message": "",
  "sequence_id": "1648777165770866F82AC7F326307055",
  "status": "invalid",
  "risk_labels": ["suspicious"],
  "free_mail": "free",
  "risk_score": 100
}