Verify a single email address
Overview
Verify a single email address.
This operation will initially mark 1 credit as pending. If the email address cannot be validated and marked as unknown ("result": "unknown"
)
by our system, the credit will be reimbursed. Otherwise, if the email address is marked either as valid, invalid or catch-all, the credit will be deducted.
This can be integrated within your application as a separate feature for your customers or as part of your registration process.
Example Request
# GET 'http://api.removebounce.com/v1/verify'
curl --location --request GET 'http://api.removebounce.com/v1/verify?email=<EMAIL_ADDRESS_TO_BE_VERIFIED>' \
--header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>'
Parameters
email: string
- Email address to be verified
Example Response
# Single Email Verified object example
{
"email": "test.email@test.com"
"result": "valid"
}
Fields
Field | Type | Description |
---|---|---|
string | Email address that has been verified | |
result | enum | Verification result can be one of the following strings: "valid", "invalid", "unknown", "catch_all" |
Error codes
Code | Type | Message | Reason |
---|---|---|---|
400 | bad_request | X-RB-API-KEY header is missing. | Occurs due to the absence of the X-RB-API-KEY header from the request. |
401 | authentication_error | No valid API key provided. | Occurs due to providing an invalid API key. If you don't have a valid API key or if it expired, go to Dashboard and generate a new key. |
400 | bad_request | X-RB-API-KEY header and email query parameter are missing. | Occurs due to the absence of the X-RB-API-KEY header and email query parameter from the request. |
400 | bad_request | Email query parameter is missing. | Occurs due to the absence of the email query parameter from the request. |
400 | bad_request | The query parameter supplied is in the wrong format. | Occurs due to the wrong format of the email query parameter. |
5xx | N/A | N/A | Occurs when the API is down. |