Submit Merchant URL

Introduction

This API is used to submit the url of the merchant for which the merchant webcrawling report must be generated.

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. merchantUrl 2. callbackUrl 3. merchantCode

Sample Curl

Preproduction

Production

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/merchant-underwriting/submit-url' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>' \
--data-raw '{
    "merchantUrl": "<merchant-url>",
    "callbackUrl":"callback-url",
    "merchantCode":"mcc-code"
}'

curl --location --request POST 'https://api.signzy.app/api/v3/merchant-underwriting/submit-url' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>' \
--data-raw '{
    "merchantUrl": "<merchant-url>",
    "callbackUrl":"callback-url",
    "merchantCode":"mcc-code"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
merchantUrl	Required	The merchant url for which the merchant report must be generated.
merchantCode	Optional	The merchant mcc code.
callbackUrl	Optional	The callback url to which the callback data must be posted.

Sample Response

{
    "merchantUrl": "<merchant_url>",
    "requestId": "<unique_request_id>",
    "merchantCode": "<input-mcc-code>",
    "callbackUrl": "<callback_Url>",
    "status": "SUBMITTED",
    "_id": "<unique-id>"
}

Response Parameter

PARAMETER NAME	DESCRIPTION
merchantUrl	Input Url of the merchant
requestId	Unique request ID generated - used in fetch merchant report api
merchantCode	Input merchant MCC code
callbackUrl	Input callback url
status	status of the API
_id	unique ID