Try it! - How To

Once you've received your API key and Partner ID you're ready to execute an API call. If you're not familiar with how to do that, let's take a look.

Let's Start With Markaaz Match

The Markaaz Match API is the entry point for utilizing the Markaaz API Services. Each process will begin with matching your inputs to a record in the Markaaz Directory. If we are able to successfully match your inputs with a record we will return a response with the matched record. The Markaaz Match API returns sufficient information to uniquely identify the business entity. Along with business-specific data we also return the Markaaz ID. This ID is the unique identifier in the Directory and will be needed to call other APIs that return specific business information, such as firmographic or compliance data.

Setting up the matching request

This POST API request requires body parameters for the bizInfo input object. Just in case you're not familiar with the portal, you'll need to expand the Business Info Object illustrated in the screenshot below by clicking the user interface control circled in red.

Once you have the Business Info Object section expanded in the API Reference, enter data for all required fields (indicated by the red border). We accept a number of parameters but for now, let's just stick to the six required fields.

As you enter data into the bizInfo object you'll notice the code displayed in the CURL request is being updated with the data you've entered by completing a JSON object. Once you've completed the required fields click "Try It!" and you'll get a response from the Markaaz Directory.

Sample curl request & response

In this example we entered the Markaaz legal name and address into the bizInfo object and produced the following command. Executing this command produces a 200 response and provides key identifying information about the business. The Markaaz ID returned (AZ0000055945770) may be used to call other APIs to gather more data about the business.

curl --request POST \
     --url https://api-partner-sandbox.app.markaaz.com/v2.0/business/match \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: gGESg2TSDj31R4xf7ZLtH6ZTUDyurihB35hVfoqs' \
     --header 'x-partner-id: 300792e8-25dd-4463-ad88-e7854f5ee047' \
     --data '
{
  "bizInfo": {
    "country": "US",
    "legalName": "Markaaz",
    "address": "310 Comal Street",
    "locality": "Austin",
    "region": "TX",
    "postalCode": "78702"
  }
}
'

200 RESPONSE - Match Found

{
  "markaaz": {
    "traceId": "d50777b0-c92a-42b0-be37-af5fe2a397ab",
    "markaazId": "AZ0000055945770",
    "markaazMatchConfidenceScore": 9.34,
    "bizInfo": {
      "dba": "",
      "legalName": "MARKAAZ, INC.",
      "taxId": "",
      "nationalId": "",
      "addresses": [
        {
          "type": "Primary",
          "line1": "310 COMAL ST STE 258",
          "line2": null,
          "locality": "AUSTIN",
          "region": "TX",
          "country": "US",
          "postalCode": "78702",
          "latitude": "30.265000",
          "longitude": "-97.717100",
          "geoprecision": "5",
          "businessIndicator": null,
          "residentialIndicator": null,
          "sohoIndicator": null
        }
      ]
    }
  }
}

📘

Some Test Markaaz IDs:

• Markaaz ID AZ0004011901661 - Loop 1 Photography, LLC.
• Markaaz ID AZ0004010591485 - Saunderstown Yacht Club
• Markaaz ID AZ0003100128078 CSM CORPORATION BERHAD
• Markaaz ID AZ0003072719974 NEW HOONG FATT HOLDINGS BERHAD
• Markaaz ID AZ0003081136605 LBS BINA GROUP BERHAD
• Markaaz ID AZ0003118635493 Hunter Douglas Holding GmbH & Co. KG
• Markaaz ID AZ0003113715998 Newsfactory GmbH
• Markaaz ID AZ0003114013902 PROXIA Software AG
• Markaaz ID AZ0003068750437 ONCODESIGN SERVICES
• Markaaz ID AZ0003084008342 NATIXIS
• Markaaz ID AZ0003109027762 INSTALLUX SA
• Markaaz ID AZ0003008320893 T H KENYON HOLDINGS LIMITED
• Markaaz ID AZ0003003087659 FALLOWS PRINT LIMITED
• Markaaz ID AZ0003002467799 S.J.BARGH LIMITED
• Markaaz ID AZ0000107193330 AMSOIL,INC.
• Markaaz ID AZ0000067210687 FIRMIN PRINTING & OFFICE EQUIPMENT COMPANY
• Markaaz ID AZ0000112269101 Welsh Facilities Services, LLC

Next up are details regarding setting up your own integration!