This is our API offering and is the default for all developers.
\nVisit Our Website: RevenueBase.
\nAPI Key: If you do not have a key, please reach out to sales@revenuebase.ai.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39687385","collectionId":"5ba9aa63-62f9-4f3f-b47b-e30a20b52e87","publishedId":"2sAYBPnap4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-18T05:45:19.000Z"},"item":[{"name":"RevenueBase Email Verification","item":[{"name":"Check Credits","id":"7142aeb4-955b-450d-8209-a25b6bb8081a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.revenuebase.ai/v1/credits","description":"Easily monitor your account’s credit balance to keep your operations running smoothly.
\nEndpoint: GET /v1/credits
\nDescription: The Check Credits endpoint retrieves the number of credits remaining on your account, helping you manage your verification usage effectively.
\nKnowing your available credits allows you to manage your campaigns proactively and plan your email verification activities without interruption.
\n","urlObject":{"protocol":"https","path":["v1","credits"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"0d632f8a-5015-4a45-b382-1e501f4dd139","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"x-key","value":"Need to refresh your API key?
\nEndpoint: GET https://api.revenuebase.ai/v1/new-api-key
\nDescription: Use the New API Key endpoint to obtain a new API key when your current key needs replacement. Keep your integration secure by regularly updating your keys.
\n","urlObject":{"protocol":"https","path":["v1","new-api-key"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"c89ad550-4b8a-434c-8ffd-077425d466ea","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"x-key","value":"The Real-Time Email Verification endpoint is your solution for ensuring the accuracy and deliverability of single emails. Verify an email address instantly and receive detailed feedback on its validity.
\nThere is a limit of 1 concurrent requests. For more requests, use the Batch Email Submission endpoint.
\nThe status in response is one of teh following string literals - \"Valid\", \"Invalid\", or \"Unknown\"
\n","urlObject":{"protocol":"https","path":["v1","process-email"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"1fb53e61-42a0-4232-ab92-3b898b904d40","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-key","value":"The Batch Email Submission endpoint allows for efficient submission and verification of large volumes (up to 250,000 per file) of email addresses. Designed for high-volume workflows, this endpoint ensures that your email verification processes are scalable and reliable.
\nThe complete filename should be less than 120 characters.
\nSubmission File Format:
\nAdd the file to the s3 inpuit folder assigned by the administrator. Files can be uploaded to the folder in JSON or CSV format.
\nJSON Files:
\nThe JSON file should contain a list (or array) of objects. Each object in this list corresponds to a unique email record that REVS will verify.
\nRequired and Optional Fields
\nEmail Field: The key for email addresses must be “email” (case-insensitive). REVS recognizes this key and uses it to extract and verify the email addresses.
\nAdditional Fields: Objects may include other fields, such as internal IDs or metadata. While REVS will not process these additional fields, they will be included in the output file as-is, preserving your original data structure.
\n[
{
\"id\": \"rb-paclhnmz5-rb-oadi3b57g\",
\"email\": \"email@somedomain.com\"
},
{
\"id\": \"rb-pacn7d3xp-rb-oac4kdroi\",
\"email\": \"email@somedomain.org\"
}
]
CSV Files:
\nTo use a CSV file for email verification, follow these formatting guidelines:
\nHeader Row: The CSV file should start with a header row that clearly labels each column. The header is required to help identify the content of each field.
\nEmail Column: The CSV file must contain a column with email addresses. This column should be clearly labeled, with the header “email” (case-insensitive). REVS will use this column to extract and verify email addresses.
\nAdditional Columns: You can include other columns in the CSV, such as your internal ID or any other metadata. REVS will not process these extra fields but will include them in the output file.
\nSample CSV file format:
\nid,email,first_name,last_name
123,email@domain.com,John,Doe
456,test@domain.org,Jane,Smith
Workflow Overview
\nFile Upload to S3: upload your file to your dedicated S3 bucket input folder assigned to you by RevenueBase (Note: Make sure the filename only includes alphanumeric characters, period and hyphen, and the length of filename including the sub-directories is upto 120 characters).
\nSubmit batch email file processing request via API endpoint: the value for filename should be the file's name, or the Amazon URN. Upon submission, the file is queued for processing.
\nStatus Update: The file status is initially set to “PROCESSING QUEUED,” indicating that it’s awaiting execution. The API response includes both the process_id and the filename for reference.
\nQueue Management: Each user has a dedicated queue, ensuring that tasks are handled in the order they are received.
\nResult Retrieval: Validated email files can be found in the output folder of s3 bucket after the processing is completed or cancelled.
\nNote: Users can track the status of their batch processing tasks by querying the process_id with the Batch Email Processing Status endpoint. This provides real-time updates on whether the file is currently processing, completed, or encountered any issues.
\nSuccessful Response
\nUpon successful submission, the API returns a JSON object containing the process_id, filename, and the initial status.
\nUsage Notes
\n\"filename\" value : The filename value should represent the unique resource name of your file (file name, or URN), ensuring proper identification in the queue.
\nDedicated Queues: Every user operates in their own dedicated task queue, preventing delays and ensuring efficient processing.
\nTechnical Insight: This endpoint is optimized for asynchronous operations, making it ideal for handling extensive email lists. Users can focus on other tasks while the API processes files in the background.
\n","urlObject":{"protocol":"https","path":["v1","batch-process-email"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"480ecba0-11a2-48e8-aa69-32443b30ac73","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-key","value":"Similar to the Batch Email Submission endpoint, the Batch Email Upload endpoint also allows for efficient submission and verification of large volumes (up to 250,000 per file) of email addresses. This endpoint removes the requirement for accessing S3 bucket directly, and instead it directly uploads the file in the request to S3, and queues it for processing. Designed for high-volume workflows, this endpoint ensures that your email verification processes are scalable and reliable.
\nThe complete filename should be less than 120 characters. The file should have a size smaller than 25 MB.
\nSubmission File Format:
\nAdd the file to the request. Files can be uploaded in JSON or CSV format.
\nJSON Files:
\nThe JSON file should contain a list (or array) of objects. Each object in this list corresponds to a unique email record that REVS will verify.
\nRequired and Optional Fields
\nEmail Field: The key for email addresses must be “email” (case-insensitive). REVS recognizes this key and uses it to extract and verify the email addresses.
\nAdditional Fields: Objects may include other fields, such as internal IDs or metadata. While REVS will not process these additional fields, they will be included in the output file as-is, preserving your original data structure.
\n[
{
\"id\": \"rb-paclhnmz5-rb-oadi3b57g\",
\"email\": \"email@somedomain.com\"
},
{
\"id\": \"rb-pacn7d3xp-rb-oac4kdroi\",
\"email\": \"email@somedomain.org\"
}
]
CSV Files:
\nTo use a CSV file for email verification, follow these formatting guidelines:
\nHeader Row: The CSV file should start with a header row that clearly labels each column. The header is required to help identify the content of each field.
\nEmail Column: The CSV file must contain a column with email addresses. This column should be clearly labeled, with the header “email” (case-insensitive). REVS will use this column to extract and verify email addresses.
\nAdditional Columns: You can include other columns in the CSV, such as your internal ID or any other metadata. REVS will not process these extra fields but will include them in the output file.
\nSample CSV file format:
\nid,email,first_name,last_name
123,email@domain.com,John,Doe
456,test@domain.org,Jane,Smith
Workflow Overview
\nRequest the batch email upload endpoint with uploaded file: upload your file to the request (Note: Make sure the filename only includes alphanumeric characters, period and hyphen, and the length of filename including the sub-directories is upto 120 characters). Upon request, the file is queued for processing.
\nStatus Update: The file status is initially set to “PROCESSING QUEUED,” indicating that it’s awaiting execution. The API response includes both the process_id and the filename for reference.
\nQueue Management: Each user has a dedicated queue, ensuring that tasks are handled in the order they are received.
\nResult Retrieval: Use the Batch Email Download endpoint to download the resulting output file once the processing ends.
\nNote: Users can track the status of their batch processing tasks by querying the process_id with the Batch Email Processing Status endpoint. This provides real-time updates on whether the file is currently processing, completed, or encountered any issues.
\nSuccessful Response
\nUpon successful submission, the API returns a JSON object containing the process_id, filename, and the initial status.
\nUsage Notes
\nfilename : The filename value should represent the unique resource name of your file, ensuring proper identification in the queue.
\nDedicated Queues: Every user operates in their own dedicated task queue, preventing delays and ensuring efficient processing.
\nTechnical Insight: This endpoint is optimized for asynchronous operations, making it ideal for handling extensive email lists. Users can focus on other tasks while the API processes files in the background.
\n","urlObject":{"protocol":"https","path":["v1","batch-upload"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"256abfc6-bb00-4ff3-adf8-f9efee0dda70","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-key","value":"The Batch Email Processing Status endpoint provides real-time updates on the status of an email batch job. Users can query the status of a previously submitted batch email file by specifying the process_id. This is essential for tracking the progress of large email verification requests.
\nThis endpoint allows users to check the current status of a previously submitted batch email processing request. By providing a process_id, users can query the queue for details about the file being processed, including the filename, current status, and any relevant messages. Only the user who submitted the request can access the status of their specific job. If the process_id is invalid or not associated with the user, an error message is returned.
\nDescription
\nThis endpoint retrieves the status of a batch email processing request. It returns details such as the filename, current_status, and any associated messages. Only the user who submitted the original request can view the status, ensuring data privacy and security.
\nRequest Body
\nThe body must include the process_id of the batch job you wish to check.
\nSuccessful Response
\nThe API returns a JSON object with the details of the batch job.
\nStatus Details
\ncurrent_status: This field indicates the processing state of your file, which could be one of the following:
\nQUEUED: The file is waiting to be processed.
\nPROCESSING: The file is currently being processed.
\nCOMPLETED: The file has been successfully processed.
\nERROR: An error occurred during processing.
\nCANCELLED: The file has been cancelled.
\nCANCELLING: The file was queued and will be cancelled on it's turn.
\nmessage: Provides additional context or information related to the current status.
\nError Handling
\nIf the process_id is invalid or does not belong to the user making the request, an error message is returned. Ensure that you are using the correct process_id and that you have the necessary permissions.
\nUsage Notes
\nSecurity: Only the user who submitted the batch job can access the status, safeguarding sensitive information.
\nEfficient Tracking: Regularly checking the status of your batch job helps you manage your workflow and respond promptly to completed or failed jobs.
\nDeveloper Tip: Use this endpoint to programmatically monitor the status of large-scale email verification requests and automate subsequent actions based on the results.
\n","urlObject":{"protocol":"https","path":["v1","batch-process-email-status"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"ed99021c-9014-42bd-b32c-82a24617dcf3","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-key","value":"The Process Queue endpoint provides a real-time overview of all active and queued email batch processing jobs for the authenticated user. This is particularly useful for monitoring and managing multiple batch jobs simultaneously.
\nDescription
\nThis endpoint returns a list of all email batch processes currently in the queue or being processed. Each process includes metadata such as the process_id, filename, current status, a message, and the last_updated timestamp.
\nSuccessful Response
\nIf the request is successful, the API returns a list of processes in JSON format.
\nResponse Fields
\nprocess_id: A unique identifier for the batch process.
\nfilename: The name of the file submitted for email verification.
\nstatus: The current status of the job, which could be:
\nQUEUED: The job is waiting to be processed.
\nPROCESSING: The job is currently being executed.
\nCOMPLETED: The job has finished processing.
\nFAILED: There was an error during processing.
\nmessage: Additional information or status messages related to the job.
\nlast_updated: The date and time when the status was last updated, formatted as an ISO 8601 string.
\nUsage Notes
\nMonitoring: Use this endpoint to keep track of all ongoing or queued processes, helping you allocate resources effectively or trigger automated workflows.
\nStatus Updates: The last_updated field is helpful for understanding the timing and progression of your batch jobs.
\nDeveloper Insight: Integrate this endpoint into your monitoring dashboard to provide visibility into all queued and processing tasks in real-time, optimizing your system’s efficiency.
\n","urlObject":{"protocol":"https","path":["v1","queued-process"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"5faefe15-d48d-4baf-84c3-fd1f01dc4fe7","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"x-key","value":"Batch Email Download endpoint allows downloading the resulting output files after the bulk validation processing for that file completes. The request takes the process_id of the file, and results with
\nNote: Users can track the status of their batch processing tasks by querying the process_id with the Batch Email Processing Status endpoint. This provides real-time updates on whether the file is currently processing, completed, or encountered any issues.
\nSuccessful Response
\nUpon successful request, the API returns a file response (as string) that can be downloaded or saved.
\n","urlObject":{"protocol":"https","path":["v1","batch-download"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"16658a9f-0a44-497c-80c9-4cd0ebaf97e8","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-key","value":"The Cancel Process endpoint allows you to cancel an ongoing or queued batch email processing job. This is particularly useful if you need to stop a job due to changes in requirements, incorrect file submissions, or any other reason that necessitates halting the verification process.
\nDescription
\nBy providing the process_id of the job you wish to cancel, you can stop an email batch processing job that is either in progress or waiting in the queue. The API will return the process_id, filename, the updated current_status, and a descriptive message about the action taken.
\nRequest Body
\nThe body must include the process_id of the job you wish to cancel.
\nSuccessful Response
\nIf the cancellation request is successful, the API returns a JSON object containing details about the job and its updated status
\n","urlObject":{"protocol":"https","path":["v1","cancel-process"],"host":["api","revenuebase","ai"],"query":[],"variable":[]}},"response":[{"id":"628bd577-4bb5-4001-9de7-647200135e9f","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-key","value":"Welcome to the RevenueBase email verification (REVS) API your solution for high-precision, on-demand email verification. Designed to streamline your workflow and safeguard your sender reputation, the REVS API integrates seamlessly into your tech stack, offering unbeatable accuracy.
\nWhy Choose RevenueBase’s Email Verification API?
\nUnmatched Accuracy: Benefit from near-100% accuracy rates, even for challenging catch-all domains and those protected by advanced firewalls.
\nReal-Time Verification: Instant results with response times under 10 seconds ensure your data stays fresh and reliable.
\nCost-Efficiency: Reduce your email marketing expenses by cleaning your email lists, saving both time and money.
\nWith RevenueBase, you can ensure your outreach campaigns are efficient, cost-effective, and impactful. Our cutting-edge email verification technology, the same that powers our internal data factory, is now available to you for your high-volume needs.
\nAPI Overview
\nOur API is intuitive and developer-friendly, built to integrate effortlessly into your existing systems. Here’s a quick guide to get started.
\nAuthorization
\nTo use the REVS API, you need an API key. This key authenticates your requests and ensures secure data transmission.
\nAuthorization Type: API Key
\nHeader Key: x-key
\nValue: {{apiKey}}
\n