Response Structure
All responses share a common structure:Success Responses
Full Success
When all enrichment modules succeed:Partial Success
When some enrichment modules succeed and others fail:Enrichment Statuses
Each enrichment module returns a status:| Status | Meaning | data | confidence |
|---|---|---|---|
found | Entity identified | Object | Number |
no_match | Could not identify | null | null |
not_applicable | Module doesn’t apply | null | null |
Handling Each Status
Error Responses
When a request fails entirely:Error Response Handling
Working with Enrichment Data
Merchant Data
Location Data
Category Data
Subscription Detection
Complete Processing Example
Best Practices
Always check success status first
Always check success status first
Before accessing data, verify
success === true.Handle partial results gracefully
Handle partial results gracefully
Don’t fail if some enrichments are missing. Use what’s available.
Check enrichment status before data
Check enrichment status before data
Always check
status === 'found' before accessing .data.Use confidence scores for display decisions
Use confidence scores for display decisions
Show confidence indicators to users or flag low-confidence results.
Store the requestId
Store the requestId
Keep the
meta.requestId for debugging and issue reports.