Email Scraper

Email Scraper - Fetch

Introduction:
Sample Curl:
preproduction
production
curl --location 'https://api.signzy.app/api/v3/email-search/fetch' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth-token>' \
--data '{
    "subject": "Credit Card Statement",
    "requestId": "1ce18125-7200-439e-bb2e-0d95dd66b52c",
    "date": "1d",
    "sender": ["user1", "user2", "user3"]
    "hasAttachment": "false",
    "keyWordInMailBody": "Credit Card",
    "dateFrom": "01/07/2024",
    "dateTo": "31/07/2024",
    "data": {
        "name": "John Doe",
        "dob": "02/12/1963"
    }
}'
curl --location 'https://api.signzy.app/api/v3/email-search/fetch' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth-token>' \
--data '{
    "subject": "Credit Card Statement",
    "requestId": "1ce18125-7200-439e-bb2e-0d95dd66b52c",
    "date": "1d",
    "sender": ["user1", "user2", "user3"]
    "hasAttachment": "false",
    "keyWordInMailBody": "Credit Card",
    "dateFrom": "01/07/2024",
    "dateTo": "31/07/2024",
    "data": {
        "name": "John Doe",
        "dob": "02/12/1963"
    }
}'
﻿
Input Parameters:
Parameter
Type
Description
Mandatory/Optional
subject
String
Represents the subject of the email to be searched for. In this case, it is "Credit Card Statement" indicating that the system will search for emails related to a credit card with that name.
Mandatory
requestId
String/UUID
Represents a unique identifier generated for the user's consent request. This ID is obtained from the "consent" endpoint and is used to link the user's consent authorization with subsequent data retrieval requests.
Mandatory
date
String
Specifies the time range for email search. "1m" signifies the last month's emails. Options include:
1d (day)
1m (month)
1y (year)
The default is 1m (1 month).
Optional
sender
Array
Sender email can be passed to filter the output data
Optional
hasAttachment
Boolean
Indicates whether the emails retrieved should have attachments. If set to "true," the system will only retrieve emails with attachments. If set to "false," emails without attachments will also be included in the search results.
Optional
keyWordInMailBody
String
Specific keywords can be passed to filter the email
Optional
dateFrom
String
Date from which the data has to be extracted
Optional
dateTo
String
Date till which the data has to be extracted
Optional
data
Object
Object contains personal data that will be used to unlock the password-protected pdfs.
Optional
data.name
String
Represents the user's name. In this case, it is "John Doe."
Optional
data.dob
String
Represents the user's date of birth. In this case, it is "02/12/1963".
Optional
﻿
Sample Output:
JSON
{
    "result": {
        "emails": [
            {
                "from": "HDFC Bank <[email protected]>",
                "to": "John Doe <[email protected]>",
                "subject": "HDFC Bank Credit Card Statement - Important Information",
                "date": "23/04/2024",
                "body": "Dear Customer, We hope you had a wonderful experience with your HDFC Bank Credit Card. Your statement for the month of April 2024 is now available for viewing. For instant payment, pay via the HDFC Bank Mobile App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for banking with us. For any queries, please contact our customer service at 1800 123 4567. Regards, HDFC Bank",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            },
            {
                "from": "State Bank of India <[email protected]>",
                "to": "John Doe <[email protected]>",
                "subject": "SBI Credit Card Statement - Important Update",
                "date": "22/04/2024",
                "body": "Dear Cardholder, We trust you are well. Your SBI Credit Card statement for the month of April 2024 is now available for viewing. For instant payment, pay via the SBI Anywhere App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for choosing SBI. For any assistance, please call our customer service at 1800 456 7890. Regards, State Bank of India",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            },
            {
                "from": "Axis Bank <[email protected]>",
                "to": "John Doe <[email protected]>",
                "subject": "Axis Bank Credit Card Statement - Important Notice",
                "date": "21/04/2024",
                "body": "Dear Customer, We hope this message finds you well. Your Axis Bank Credit Card statement for April 2024 is now available for viewing. For instant payment, pay via the Axis Mobile App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for banking with us. For any queries, please contact our customer service at 1800 789 0123. Regards, Axis Bank",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            },
            {
                "from": "IDFC First Bank <[email protected]>",
                "to": "John Doe <[email protected]>",
                "subject": "IDFC First Bank Credit Card Statement - Important Update",
                "date": "20/04/2024",
                "body": "Dear Customer, We hope you had a wonderful experience with your IDFC First Bank Credit Card. Your statement for the month of April 2024 is now available for viewing. For instant payment, pay via the IDFC First Bank Mobile App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for banking with us. For any assistance, please call our customer service at 1800 10 888. Regards, IDFC First Bank",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            }
        ]
    }
}

{
    "result": {
        "emails": [
            {
                "from": "HDFC Bank <statement@hdfcbank.com>",
                "to": "John Doe <john.doe@gmail.com>",
                "subject": "HDFC Bank Credit Card Statement - Important Information",
                "date": "23/04/2024",
                "body": "Dear Customer, We hope you had a wonderful experience with your HDFC Bank Credit Card. Your statement for the month of April 2024 is now available for viewing. For instant payment, pay via the HDFC Bank Mobile App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for banking with us. For any queries, please contact our customer service at 1800 123 4567. Regards, HDFC Bank",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            },
            {
                "from": "State Bank of India <statement@sbi.co.in>",
                "to": "John Doe <john.doe@gmail.com>",
                "subject": "SBI Credit Card Statement - Important Update",
                "date": "22/04/2024",
                "body": "Dear Cardholder, We trust you are well. Your SBI Credit Card statement for the month of April 2024 is now available for viewing. For instant payment, pay via the SBI Anywhere App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for choosing SBI. For any assistance, please call our customer service at 1800 456 7890. Regards, State Bank of India",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            },
            {
                "from": "Axis Bank <statement@axisbank.com>",
                "to": "John Doe <john.doe@gmail.com>",
                "subject": "Axis Bank Credit Card Statement - Important Notice",
                "date": "21/04/2024",
                "body": "Dear Customer, We hope this message finds you well. Your Axis Bank Credit Card statement for April 2024 is now available for viewing. For instant payment, pay via the Axis Mobile App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for banking with us. For any queries, please contact our customer service at 1800 789 0123. Regards, Axis Bank",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            },
            {
                "from": "IDFC First Bank <statement@idfcfirstbank.com>",
                "to": "John Doe <john.doe@gmail.com>",
                "subject": "IDFC First Bank Credit Card Statement - Important Update",
                "date": "20/04/2024",
                "body": "Dear Customer, We hope you had a wonderful experience with your IDFC First Bank Credit Card. Your statement for the month of April 2024 is now available for viewing. For instant payment, pay via the IDFC First Bank Mobile App or Net Banking. For more payment options and to access your E-Statement, please click on the link provided with this email. Thank you for banking with us. For any assistance, please call our customer service at 1800 10 888. Regards, IDFC First Bank",
                "attachments": [
                    "https://persist.signzy.tech/api/files/890811158/download/0b540fc20e6b44eea088ac9ea3ec0fa6beca01a58a2143c7acdca2233c2def07.pdf"
                ]
            }
        ]
    }
}
﻿
Output Parameters:
Parameter
Type
Description
result
Object
Contains the output of the API
result.emails
Array
List of Emails matching with the given parameters (subject, date, hasAttachment, etc..)
result.emails[i].from
String 
Represents the sender's name and email address. This parameter indicates who sent the email.
result.emails[i].to
String
Represents the recipient's name and email address. This parameter indicates to whom the email is addressed.
result.emails[i].subject
String
Represents the subject of the email. This parameter provides a summary or title for the content of the email.
result.emails[i].date
String
Represents the date and time when the email was sent. This parameter indicates when the email was composed or dispatched.
result.emails[i].body
String
Represents the main content or body of the email. 
result.emails[i].attachments
Array of Strings
Represents any attachments included with the email. Each attachment is represented by a URL pointing to the location where the attachment can be downloaded or accessed. 
﻿
Status Codes:
200 OK
400
401
500
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}
﻿
﻿

Email Scraper - Consent

Statement Analysis - Authenticate

Docs powered by Archbee

TABLE OF CONTENTS

Parameter	Type	Description	Mandatory/Optional
subject	String	Represents the subject of the email to be searched for. In this case, it is "Credit Card Statement" indicating that the system will search for emails related to a credit card with that name.	Mandatory
requestId	String/UUID	Represents a unique identifier generated for the user's consent request. This ID is obtained from the "consent" endpoint and is used to link the user's consent authorization with subsequent data retrieval requests.	Mandatory
date	String	Specifies the time range for email search. "1m" signifies the last month's emails. Options include: 1d (day) 1m (month) 1y (year) The default is 1m (1 month).	Optional
sender	Array	Sender email can be passed to filter the output data	Optional
hasAttachment	Boolean	Indicates whether the emails retrieved should have attachments. If set to "true," the system will only retrieve emails with attachments. If set to "false," emails without attachments will also be included in the search results.	Optional
keyWordInMailBody	String	Specific keywords can be passed to filter the email	Optional
dateFrom	String	Date from which the data has to be extracted	Optional
dateTo	String	Date till which the data has to be extracted	Optional
data	Object	Object contains personal data that will be used to unlock the password-protected pdfs.	Optional
data.name	String	Represents the user's name. In this case, it is "John Doe."	Optional
data.dob	String	Represents the user's date of birth. In this case, it is "02/12/1963".	Optional