Quick Start by Persona

For Engineers and Architects

• Externalize endpoint base urls, paths, and API parameters (e.g., matchConfidenceThresholdOverride, showGrades) in config, rather than hard-coding them into your integration.
• Persist markaazId, traceId, and key response fields on your own logging database.
• Include epInternalId in requests and match with the same epInternalId echoed back in Markaaz API responses, allowing you to link API requests and responses to your own data, such as customer numbers.
• Halt additional Markaaz API enrichment requests when no match is returned by Advanced Match or Search.
• Implement API request retry logic with backoff for transient API connectivity errors.
• Validate upstream form inputs where possible to improve match quality. (avoid “NA”, “not available”, or other sentinal values, as they can degrade business matching)
• Construct Advanced Match with required fields: legalName, address, locality, postalCode, country. Sending requests with missing required fields will return a 400 series error.
• Set showGrades to “true” in requests and leverage Markaaz field grades to enahnce your decision logic.
  

For Product Managers

• Decide whether onboarding uses Search → select business → Advanced Match, or Advanced Match only.
• Define acceptance thresholds using markaazMatchConfidenceScore and field-level grades (A/B/C/F/Z) for business‑critical request fields (e.g., legalName, address).
• Choose which Verification APIs to call on a retrieved markaazId (e.g., Firmographics + Business Health for prioritization; Compliance for KYB/KYC).
• Utilize the pass-through epInternalId, which can be linked to a customer-side client ID, for support, traceability, and data analysis.