post https://in.staging.decentro.tech/v2/kyc/identities/employment-verification/email
Important Note
Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
API Endpoints
Environment | Host |
---|---|
Staging | in.staging.decentro.tech |
Production | in.decentro.tech |
Response Parameters
Key | Description | Datatype |
---|---|---|
decentroTxnId | Unique identifier for the transaction | String |
status | Status of the verification process | String |
responseCode | Response code indicating the result of the verification | String |
message | Message providing additional information about the verification process | String |
data | An object containing detailed information about the email address and associated account | Object |
data.isDisposable | Indicates whether the email address is disposable (temporary) or not | Boolean |
data.domainAge | Indicates the age of the domain | String |
data.domainRegistrationDate | Indicates the date of the registration of the email domain in YYYY-MM-DD format | String |
data.companyDetails | Array containing a list of objects with details about the company associated with the email address | Array |
data.companyDetails.* (various keys under companyDetails) | Various details about the company such the name and the CIN number | String |
data.account | An object containing information about the associated account | Object |
data.account.username | Username associated with the account | String |
data.account.isGibberish | Indicates whether the username appears to be random or nonsensical | Boolean |
responseKey | Key indicating the type of response | String |
Response Keys and Scenarios
The following list contains the various response keys along with 1 sample response JSON corresponding to each of them.
success_employment_email_verification
-> HTTP 200 Success (A private email was found)
{
"decentroTxnId": "3D03FE7181C34E92ACDFD249A79ED618",
"status": "SUCCESS",
"responseCode": "S00000",
"message": "The email address was verified successfully.",
"data": {
"domainRegistrationDate": "2018-01-10",
"domainAgeInDays": 2576,
"isDisposable": false,
"isPublic": false,
"companyDetails": [
{
"company": "IDFC FIRST BANK LIMITED",
"cin": "L65110TN2014PLC097792"
}
],
"account": {
"username": "shabnum.zaman",
"isGibberish": false
}
},
"responseKey": "success_employment_email_verification"
}
success_public_email_found
-> HTTP 200 Success (A public email was found)
{
"decentroTxnId": "DFDD9350B1724B09A9B82E8F0B670CB1",
"status": "FAILURE",
"responseCode": "S00000",
"message": "The email address was verified successfully.",
"data": {
"isDisposable": false,
"isPublic": true,
"account": {
"username": "sample",
"isGibberish": false
}
},
"responseKey": "success_public_email_found"
}
error_invalid_email
-> HTTP 400 Bad Request (For an invalid email)
{
"decentroTxnId": "2E25C80903DF437289F210CF04D67529",
"status": "FAILURE",
"responseCode": "E00009",
"message": "Invalid email. Please pass a valid email.",
"responseKey": "error_invalid_email"
}
error_duplicate_reference_id
-> HTTP 400 Bad Request (For duplicate reference ID)
{
"decentroTxnId": "B30A2E575F4B463C81F04A0DB549B122",
"status": "FAILURE",
"responseCode": "E00019",
"message": "Duplicate Request Reference ID",
"responseKey": "error_duplicate_reference_id"
}