Subscribe on AWS Marketplace
Code samples
API endpoint: email-address
API endpoint: phone-number
API endpoint: usage
Troubleshooting
Navigate to our product listing on the AWS Marketplace. Select the "View purchase options" button to proceed.
On the following page, click the "Subscribe" button to initiate the subscription process.
After subscribing, you will need to set up your account on our platform. Do this by clicking the "Set up your account" link provided.
You will be directed to the registration page. Here, fill in your account details in the provided fields. Once you have entered all necessary information, click the 'Subscribe' button to proceed.
Upon successful registration, your unique API key will be displayed. It is crucial to store this key in a secure location for future use.
The following code sample calls the email address validation endpoint with "support@silverlining.cloud". Replace <YourApiKey> with the actual API Key you received during the sign-up process:
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://validation-aws.silverlining.cloud/email-address");
request.Headers.Add("x-api-key", "<YourApiKey>");
var content = new StringContent("{\n \"emailAddress\": \"support@silverlining.cloud\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
The following code sample calls the phone number validation endpoint with "+43 670 5509930":
var client = new RestClient("https://validation-aws.silverlining.cloud/phone-number");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<YourApiKey>");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@" ""phoneNumber"": ""+43 670 5509930""" + "\n" +
@"}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);This API Playground for our Validation API lets you test the service in real-time. Simply input the email address you wish to validate, and you’ll receive an immediate response directly from the API. Whether you’re looking to integrate email validation into your application or just experimenting with the service, the playground provides a straightforward interface to view responses instantly.
"To see the result, please send a request to the API."
URL endpoint: https://validation-aws.silverlining.cloud/email-address
Method: POST
"header": {
"x-api-key": STRING,
"Content-Type": "application/json"
}
"body": {
"emailAddress": STRING,
}
Required
"emailAddress": The email address to be validated.
Response:
"body": {
"validationResult": {
"provided_email_address": STRING,
"status": STRING
}
}
"status": Returns one of the following values:
URL endpoint: https://validation-aws.silverlining.cloud/phone-number
Method: POST
"header": {
"x-api-key": STRING,
"Content-Type": "application/json"
}
"body": {
"phoneNumber": STRING,
}
Required
"phoneNumber": The phone number to be validated. The provided phone number can be in any common format, including "+", "(", ")", and "-" characters.
Response:
"body": {
"validationResult": {
"provided_phone_number": STRING,
"formatted_phone_number": {
"country_code": NUMBER,
"national_number": NUMBER
},
"is_valid": BOOLEAN,
"area_description": STRING,
"carrier": STRING,
"timezone": STRING
}
}
"area_description", "carrier" and "timezone" are only available if this information can be retrieved from the phone number. Otherwise, these fields are empty.
URL endpoint: https://validation-aws.silverlining.cloud/usage
Method: POST
"header": {
"x-api-key": STRING,
"Content-Type": "application/json"
}Required
You must include the API key in the x-api-key header. The body parameters can be left empty.
Response:
"body": {
"reportUrl": STRING,
"downloadLink": STRING,
"description": STRING
}"reportUrl": A URL linking to a web-based report that displays all requests made to the API. Note that this report is only accessible if the total number of requests is below 100,000.
"downloadLink": A URL to download a .CSV file containing all requests made to our API using the specified API key.
"description": You can access usage statistics either by visiting the website using the 'reportUrl' or by downloading the usage data as a .csv file using the 'downloadLink'. Please note that, depending on the number of requests you have previously sent to our API, these links may become available up to 10 minutes after the request is made.
"message": "Invalid Input: The request contains incorrectly formatted parameters"
This error message means that the body parameters you have passed are malformed. Please follow the instructions given in the endpoint descriptions. Common issues include forgetting to add a comma (',') after every parameter line or missing a parenthesis somewhere.
"message": "Endpoint request timed out"
You receive this error message when the code execution exceeds the maximum timeout (usually 29 seconds).
How can I cancel my subscription?
To cancel your subscription, follow these steps:
For more detailed instructions, visit the AWS Marketplace Buyer Guide at https://docs.aws.amazon.com/marketplace/latest/buyerguide/cancel-subscription.html.