ShopLens-Standard

Introduction

This API allows users to extract merchant details from images/pdf urls. It accepts a list of images and returns information about the merchant fetched from the banner and inventory image, such as the shop name, owner's name, contact number, address, industry, isMovable, and MCC codes.

MCC codes list includes list of NPCI, VISA and Mastercard MCC codes.

API details

Endpoint

POST https://api-preproduction.signzy.app/api/v3/extraction/merchant-detail

Request Body Parameters:

Name	Value	Description	Required
shopFrontImage	String	A URL of the image of shop front. Acceptable image format JPEG/JPG, PNG, PDF(MAX of 2 pages)	Mandatory
inventoryImage	String	A URL of the image of inventory. Acceptable image format JPEG/JPG, PNG, PDF	Optional
verificationRequired	Boolean	True or False	Optional
shopOwnerNameEnglish	String	Name of the Shop Owner in English	Optional
articles	Array of strings	An optional list of items or products to be verified in the uploaded image. The API checks whether the articles mentioned in the request are visually present in the provided shop or inventory image.	Optional
mccCode	String	Merchant Category Code representing the business type.	Optional

{
  "shopFrontImage": "",
  "inventoryImage": "",
  "verificationDetails": {
    "verificationRequired": "",
    "shopOwnerNameEnglish": "",
    "shopNameEnglish": "",
    "contactNumber": "",
    "addressEnglish": "",
    "articles": [],
    "mccCode": ""
  }
}

Code samples

curl --location 'https://api-preproduction.signzy.app/api/v3/extraction/merchant-detail' \
--header 'Authorization: <auth_key>' \
--header 'Content-Type: application/json' \
--data '{
  "shopFrontImage": "",
  "inventoryImage": "",
  "verificationDetails": {
    "verificationRequired": "",
    "shopOwnerNameEnglish": "",
    "shopNameEnglish": "",
    "contactNumber": "",
    "addressEnglish": "",
    "articles": [],
    "mccCode": ""
  }
}
'

Response body parameters

Parameter	Data Type	Description
shopNameExtracted	String	Name of the shop in the original language.
shopNameEnglish	String	Name of the shop in English translation.
shopOwnerNameExtracted	String	Name of the shop owner in the original language.
shopOwnerNameEnglish	String	Name of the shop owner in English translation.
contactNumber	String	Contact number of the shop owner.
addressExtracted	String	Address of the shop in the original language.
addressEnglish	String	Address of the shop in English translation.
shopImageLivenessCheck	String	Boolean value (as string) indicating if the shop image passed the liveness/anti-spoofing check.
shopImageLivenessConfidenceScore	Integer	Confidence score (out of 100) for the shop image liveness check.
inventoryImageLivenessCheck	String	Boolean value (as string) indicating if the inventory image passed the liveness check.
inventoryImageLivenessConfidenceScore	Integer	Confidence score (out of 100) for the inventory image liveness check.
waterMarkDetectedForShopImage	String	Boolean value (as string) indicating if a watermark was detected on the shop image.
waterMarkDetectedForInventoryImage	String	Boolean value (as string) indicating if a watermark was detected on the inventory image.
gstNumber	String	GST Number extracted from the provided data/images.
shopDetected	String	Boolean value (as string) indicating whether a shop was successfully detected.
inventoryDetected	String	Boolean value (as string) indicating whether inventory was detected or not.
faceDetected	String	Boolean value (as string) indicating whether a human face was detected in the images.
shopBoardType	String	Type of shop board or signage detected (e.g., Permanent, Banner, Standee).
isMovable	String	Boolean value (as string) based on the mobility of the shop setup.
articles	Array	List of articles or items detected in the inventory/images.
descriptionOfIndustry	Array of Objects	List of related industry classifications and MCC (Merchant Category Code) details.
verificationResult	Object	Detailed breakdown comparing the extracted data statuses against verified backend statuses.
overallConfidenceScore	Float	Aggregate confidence score for the entire extraction and verification process.
livenessScore	Integer	Aggregate score calculating the overall liveness of the submitted media.
legitimacyScore	Integer	Score representing the overall legitimacy of the merchant/shop.
extractionMatchScore	Float	Aggregate score representing how well the extracted details matched verified records.
permanenceScore	Integer	Score indicating the permanence of the shop structure

{
    "shopNameExtracted": "VARDA EV DRIVE",
    "shopNameEnglish": "VARDA EV DRIVE",
    "shopOwnerNameExtracted": "Jon Doe",
    "shopOwnerNameEnglish": "Jon Doe",
    "contactNumber": "9123456789, 9123456788",
    "addressExtracted": "Delhi Nagar, Yashoda Nagar, Kanpur",
    "addressEnglish": "Delhi Nagar, Yashoda Nagar, Kanpur",
    "shopImageLivenessCheck": "True",
    "shopImageLivenessConfidenceScore": 85,
    "inventoryImageLivenessCheck": "True",
    "inventoryImageLivenessConfidenceScore": 85,
    "waterMarkDetectedForShopImage": "False",
    "waterMarkDetectedForInventoryImage": "False",
    "gstNumber": "09AZAPC1112H1ZI",
    "shopDetected": "True",
    "inventoryDetected": "True",
    "faceDetected": "False",
    "shopBoardType": "Permanent",
    "isMovable": "False",
    "articles": [
        "Scooter",
        "Electric bike"
    ],
    "descriptionOfIndustry": [
        {
            "mccCode": "5571",
            "confidenceScore": 90,
            "description": "Motorcycle Dealers"
        }
    ],
    "verificationResult": {
        "verificationRequired": true,
        "shopNameEnglish": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "MISMATCH"
        },
        "shopOwnerNameEnglish": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "MATCH"
        },
        "contactNumber": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "MATCH"
        },
        "addressEnglish": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "PARTIAL_MATCH"
        },
        "articles": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "PARTIAL_MATCH"
        },
        "mccCode": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "MISMATCH"
        },
        "gstNumber": {
            "extractionStatus": "SUCCESS",
            "verificationStatus": "MISMATCH"
        }
    },
    "overallConfidenceScore": 57.5,
    "livenessScore": 91,
    "legitimacyScore": 90,
    "extractionMatchScore": 57.5,
    "permanenceScore": 100
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.