Merchant Profiling

Fetch Merchant Report

7min

Introduction
This API is used to fetch the merchant report for the submitted requst in the submit merchatn URL api.
How to call the API
You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.
API Input Guidelines
Need to pass follow information:
1. requestId
Sample Curl
Preproduction
Production
Curl
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/merchant-underwriting/fetch-report' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>' \
--data-raw '{
    "requestId": "1682489774477-592220"
}'

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/merchant-underwriting/fetch-report' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>' \
--data-raw '{
    "requestId": "1682489774477-592220"
}'
﻿
Curl
curl --location --request POST 'https://api.signzy.app/api/v3//merchant-underwriting/fetch-report' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>' \
--data-raw '{
    "requestId": "1682489774477-592220"
}'


curl --location --request POST 'https://api.signzy.app/api/v3//merchant-underwriting/fetch-report' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>' \
--data-raw '{
    "requestId": "1682489774477-592220"
}'

﻿
Input Parameters
PARAMETER NAME
REQUIRED/OPTIONAL
DESCRIPTION
requestId
Required
requestId that was generated in the Submit Merchant URL api
﻿
Sample Response
JSON
{
    "merchantUrl": "https://www.merchant.com/",
    "requestId": "1682489774477-592220",
    "merchantCode": "1234",
    "callbackUrl": "callbackUrl",
    "status": "PROCESSED",
    "domainAnalysisReport": {
        "domainOwnership": "{\n  \"Domain Name\": \"merchant.com\",\n  \"Registrant Name\": \"Sample Merchant\",\n  \"Registrant Organization\": \"Sample Domain Registrant\",\n  \"Registrant Street\": \"1234 ABC street\",\n  \"Registrant City\": \"XYZ\",\n  \"Registrant State/Province\": \"Arizona\",\n  \"Registrant Postal Code\": \"12345\",\n  \"Registrant Country\": \"US\",\n  \"Registrant Phone\": \"123456789\",\n  \"Name Server\": \"A1.sample.net\",\n  \"DNSSEC\": \"unsigned\"\n}",
        "domainIpAddresses": [
            "12.123.23.234"
        ],
        "domainReport": {
            "openPorts": [
                "80/tcp  open",
                "443/tcp open"
            ],
            "protocols": [
                "TLSv1.0",
                "TLSv1.1",
                "TLSv1.2"
            ],
            "ciphers": [
                "TLS_DHE_RSA_WITH_AES_128_CBC_SHA",
                "TLS_DHE_RSA_WITH_AES_256_CBC_SHA",
                "TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA",
                "TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA",
                "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
            ]
        },
        "subDomains": [
            "cc.merchant.com",
            "corporate.merchant.com",
            "corptest.merchant.com"
        ],
        "subDomainAnalysis": [
            {
                "domain": "cc.merchant.com",
                "ipaddresses": [
                    "12.123.23.234"
                ],
                "openPorts": [
                    "25/tcp   open",
                    "80/tcp   open"
                ],
                "protocols": [
                    "TLSv1.2",
                    "TLSv1.0",
                    "TLSv1.1"
                ],
                "ciphers": [
                    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
                    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
                    "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256",
                    "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384",
                    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
                ]
            },
            {
                "domain": "corporate.merchant.com",
                "ipaddresses": [
                    "12.123.23.234"
                ],
                "openPorts": [
                    "443/tcp open"
                ],
                "protocols": [
                    "TLSv1.0",
                    "TLSv1.1",
                    "TLSv1.2"
                ],
                "ciphers": [
                    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
                    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
                ]
            },
            {
                "domain": "corptest.merchant.com",
                "ipaddresses": [],
                "openPorts": null,
                "protocols": null,
                "ciphers": null
            }
        ],
        "vulnerabilities": {
            "weakCiphers": [
                "TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA",
                "TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA",
                "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
            ],
            "weakProtocols": [
                "TLSv1.0",
                "TLSv1.1"
            ]
        }
    },
    "domainAnalysisStatus": "SUCCESS",
    "externalLinks": [
        {
            "text": "www.merchant.ae",
            "href": "https://www.merchant.ae/"
        },
        {
            "text": "www.merchant.sg",
            "href": "https://www.merchant.sg/"
        }
    ],
    "internalLinks": [
        {
            "text": "Shop",
            "href": "https://www.merchant.com/shop"
        },
        {
            "text": "Collections",
            "href": "https://www.merchant.com/collections"
        }
    ],
    "policyLinks": {
        "privacyPolicies": [
            "https://www.merchant.com/info/privacy-policy"
        ],
        "refundPolicies": [],
        "cancellationPolicies": [],
        "termsAndConditions": [
            "https://www.merchant.com/info/terms-and-conditions",
            "https://www.merchant.com/info/terms-of-use"
        ],
        "about": [
            "https://www.merchant.com/info/about-us"
        ],
        "contact": [
            "https://www.merchant.com/info/contact-us"
        ],
        "otherPolicies": [
            "https://www.merchant.com/info/privacy-policy",
            "https://www.merchant.com/info/faq"
        ]
    },
    "socialMediaLinks": {
        "facebook":"https://www.facebook.com/sample-merchant",
        "instagram":"https://www.facebook.com/sample-merchant",
        "whatsapp":"https://www.wa.me/1234567890",
        "twitter":"https://www.twitter.com/sample-merchant",
        "youtube":"https://www.youtube.com/sample-merchant"
    },
    "companyData": {
        "emailAddresses": [
            "[email protected]"
        ],
        "registeredAddress": "Sample Merchant, Sample Address",
        "mailingAddress": "Sample Merchant, Sample Address",
        "companyName": "Sample Merchant",
        "phoneNumbers": [
            "1234567890"
        ],
        "productOrServices": [
            "Flowers",
            "Cakes",
            "Gifts"
        ],
        "companyDescription": "Sample Description"
    },
    "highRiskMccCodes": {
        "5968": "Direct marketing, subscription, continuity / subscription merchants",
        "9399": "Government services"
    },
    "mccCodes": [
        "5947",
        "5992"
    ],
    "piiData": [
        "name",
        "email",
        "age",
        "username",
        "password",
        "Email Address",
        "IP address",
        "Demographic information (like gender, age, income)",
        "Personal Information of children under the age of 18 years (if shared)",
        "Contact number"
    ],
    "pdfLink": "<pdfLink>"
}
{
    "merchantUrl": "https://www.merchant.com/",
    "requestId": "1682489774477-592220",
    "merchantCode": "1234",
    "callbackUrl": "callbackUrl",
    "status": "PROCESSED",
    "domainAnalysisReport": {
        "domainOwnership": "{\n  \"Domain Name\": \"merchant.com\",\n  \"Registrant Name\": \"Sample Merchant\",\n  \"Registrant Organization\": \"Sample Domain Registrant\",\n  \"Registrant Street\": \"1234 ABC street\",\n  \"Registrant City\": \"XYZ\",\n  \"Registrant State/Province\": \"Arizona\",\n  \"Registrant Postal Code\": \"12345\",\n  \"Registrant Country\": \"US\",\n  \"Registrant Phone\": \"123456789\",\n  \"Name Server\": \"A1.sample.net\",\n  \"DNSSEC\": \"unsigned\"\n}",
        "domainIpAddresses": [
            "12.123.23.234"
        ],
        "domainReport": {
            "openPorts": [
                "80/tcp  open",
                "443/tcp open"
            ],
            "protocols": [
                "TLSv1.0",
                "TLSv1.1",
                "TLSv1.2"
            ],
            "ciphers": [
                "TLS_DHE_RSA_WITH_AES_128_CBC_SHA",
                "TLS_DHE_RSA_WITH_AES_256_CBC_SHA",
                "TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA",
                "TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA",
                "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
            ]
        },
        "subDomains": [
            "cc.merchant.com",
            "corporate.merchant.com",
            "corptest.merchant.com"
        ],
        "subDomainAnalysis": [
            {
                "domain": "cc.merchant.com",
                "ipaddresses": [
                    "12.123.23.234"
                ],
                "openPorts": [
                    "25/tcp   open",
                    "80/tcp   open"
                ],
                "protocols": [
                    "TLSv1.2",
                    "TLSv1.0",
                    "TLSv1.1"
                ],
                "ciphers": [
                    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
                    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
                    "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256",
                    "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384",
                    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
                ]
            },
            {
                "domain": "corporate.merchant.com",
                "ipaddresses": [
                    "12.123.23.234"
                ],
                "openPorts": [
                    "443/tcp open"
                ],
                "protocols": [
                    "TLSv1.0",
                    "TLSv1.1",
                    "TLSv1.2"
                ],
                "ciphers": [
                    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
                    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
                ]
            },
            {
                "domain": "corptest.merchant.com",
                "ipaddresses": [],
                "openPorts": null,
                "protocols": null,
                "ciphers": null
            }
        ],
        "vulnerabilities": {
            "weakCiphers": [
                "TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA",
                "TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA",
                "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
            ],
            "weakProtocols": [
                "TLSv1.0",
                "TLSv1.1"
            ]
        }
    },
    "domainAnalysisStatus": "SUCCESS",
    "externalLinks": [
        {
            "text": "www.merchant.ae",
            "href": "https://www.merchant.ae/"
        },
        {
            "text": "www.merchant.sg",
            "href": "https://www.merchant.sg/"
        }
    ],
    "internalLinks": [
        {
            "text": "Shop",
            "href": "https://www.merchant.com/shop"
        },
        {
            "text": "Collections",
            "href": "https://www.merchant.com/collections"
        }
    ],
    "policyLinks": {
        "privacyPolicies": [
            "https://www.merchant.com/info/privacy-policy"
        ],
        "refundPolicies": [],
        "cancellationPolicies": [],
        "termsAndConditions": [
            "https://www.merchant.com/info/terms-and-conditions",
            "https://www.merchant.com/info/terms-of-use"
        ],
        "about": [
            "https://www.merchant.com/info/about-us"
        ],
        "contact": [
            "https://www.merchant.com/info/contact-us"
        ],
        "otherPolicies": [
            "https://www.merchant.com/info/privacy-policy",
            "https://www.merchant.com/info/faq"
        ]
    },
    "socialMediaLinks": {
        "facebook":"https://www.facebook.com/sample-merchant",
        "instagram":"https://www.facebook.com/sample-merchant",
        "whatsapp":"https://www.wa.me/1234567890",
        "twitter":"https://www.twitter.com/sample-merchant",
        "youtube":"https://www.youtube.com/sample-merchant"
    },
    "companyData": {
        "emailAddresses": [
            "help@merchant.com"
        ],
        "registeredAddress": "Sample Merchant, Sample Address",
        "mailingAddress": "Sample Merchant, Sample Address",
        "companyName": "Sample Merchant",
        "phoneNumbers": [
            "1234567890"
        ],
        "productOrServices": [
            "Flowers",
            "Cakes",
            "Gifts"
        ],
        "companyDescription": "Sample Description"
    },
    "highRiskMccCodes": {
        "5968": "Direct marketing, subscription, continuity / subscription merchants",
        "9399": "Government services"
    },
    "mccCodes": [
        "5947",
        "5992"
    ],
    "piiData": [
        "name",
        "email",
        "age",
        "username",
        "password",
        "Email Address",
        "IP address",
        "Demographic information (like gender, age, income)",
        "Personal Information of children under the age of 18 years (if shared)",
        "Contact number"
    ],
    "pdfLink": "<pdfLink>"
}
﻿
Response Parameter
PARAMETER NAME
DESCRIPTION
merchantUrl
Input Url of the merchant
requestId
Unique request ID generated
merchantCode
Input merchant MCC code
callbackUrl
Input callback url
status
status of the API
_id
Unique Mongo ID
domainAnalysisReport
Object containing complete domain analysis report
domainAnalysisReport.domainOwnership
Domain Ownership details
domainAnalysisReport.domainIpAddresses
Domain IP addresses
domainAnalysisReport.domainReport
Object containing the domain analysis report
domainAnalysisReport.domainReport.openPorts
Open ports of the domain
domainAnalysisReport.domainReport.protocols
Protocols of the domain 
domainAnalysisReport.domainReport.ciphers
Ciphers of the domain
domainAnalysisReport.subDomains
All the subdomains of the website
domainAnalysisReport.subDomainAnalysis
Array of objects containing the analysis of each subdomain
domainAnalysisReport.subDomainAnalysis.domain
Subdomain name
domainAnalysisReport.subDomainAnalysis.ipaddresses
subdomain ip addresses
domainAnalysisReport.subDomainAnalysis.openPorts
subdomaon open ports
domainAnalysisReport.subDomainAnalysis.protocols
subdomain protocols
domainAnalysisReport.subDomainAnalysis.ciphers
subdomain ciphers
domainAnalysisReport.vulnerabilities
Object containing the vulnerabilities of the merchant based on domain analysis
domainAnalysisReport.vulnerabilities.weakCiphers
Weak Ciphers of the merchant
domainAnalysisReport.vulnerabilities.weakProtocols
Weak protocols of the merchant
domainAnalysisStatus
Status of the domain analysis
externalLinks
List of all the external links
internalLinks
List of all the internal links
policyLinks
Object containing the list of different policies. eg: privacy policy, refund policy
socialMediaLinks
Social media links of the merchant
companyData
Object containing the details of the merchant
highRiskMccCodes
List of the high risk mcc codes identified for the merchant
mccCodes
List of the mcc codes for this merchant
piiData
List of the data being collected by the merchant
pdfLink
Pdf link of the report of the merchant
Alternate Response
JSON
{
    "status": "Still Processing"
}
{
    "status": "Still Processing"
}
﻿
PARAMETER NAME
DESCRIPTION
status
The request is still processing, please try again in some time.
﻿

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
requestId	Required	requestId that was generated in the Submit Merchant URL api

PARAMETER NAME	DESCRIPTION
merchantUrl	Input Url of the merchant
requestId	Unique request ID generated
merchantCode	Input merchant MCC code
callbackUrl	Input callback url
status	status of the API
_id	Unique Mongo ID
domainAnalysisReport	Object containing complete domain analysis report
domainAnalysisReport.domainOwnership	Domain Ownership details
domainAnalysisReport.domainIpAddresses	Domain IP addresses
domainAnalysisReport.domainReport	Object containing the domain analysis report
domainAnalysisReport.domainReport.openPorts	Open ports of the domain
domainAnalysisReport.domainReport.protocols	Protocols of the domain
domainAnalysisReport.domainReport.ciphers	Ciphers of the domain
domainAnalysisReport.subDomains	All the subdomains of the website
domainAnalysisReport.subDomainAnalysis	Array of objects containing the analysis of each subdomain
domainAnalysisReport.subDomainAnalysis.domain	Subdomain name
domainAnalysisReport.subDomainAnalysis.ipaddresses	subdomain ip addresses
domainAnalysisReport.subDomainAnalysis.openPorts	subdomaon open ports
domainAnalysisReport.subDomainAnalysis.protocols	subdomain protocols
domainAnalysisReport.subDomainAnalysis.ciphers	subdomain ciphers
domainAnalysisReport.vulnerabilities	Object containing the vulnerabilities of the merchant based on domain analysis
domainAnalysisReport.vulnerabilities.weakCiphers	Weak Ciphers of the merchant
domainAnalysisReport.vulnerabilities.weakProtocols	Weak protocols of the merchant
domainAnalysisStatus	Status of the domain analysis
externalLinks	List of all the external links
internalLinks	List of all the internal links
policyLinks	Object containing the list of different policies. eg: privacy policy, refund policy
socialMediaLinks	Social media links of the merchant
companyData	Object containing the details of the merchant
highRiskMccCodes	List of the high risk mcc codes identified for the merchant
mccCodes	List of the mcc codes for this merchant
piiData	List of the data being collected by the merchant
pdfLink	Pdf link of the report of the merchant

PARAMETER NAME	DESCRIPTION
status	The request is still processing, please try again in some time.

Updated 11 Oct 2024

Did this page help you?

Submit Merchant URL