{"openapi":"3.1.0","info":{"title":"GET /api/v1/counterparty-naming/inconsistencies","version":"1.0.0","description":"Find inconsistently named counterparties"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-naming/inconsistencies":{"get":{"tags":["counterparty-naming"],"summary":"Find inconsistently named counterparties","description":"Deterministic grouping of names that probably refer to the same counterparty: case/punctuation variants, legal suffixes, store numbers, common abbreviations, and near-identical spellings.","operationId":"list_name_inconsistencies","parameters":[{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3650,"minimum":1},{"type":"null"}],"description":"Only consider transactions in this window","default":365,"title":"Window Days"},"description":"Only consider transactions in this window"},{"name":"threshold","in":"query","required":false,"schema":{"type":"number","maximum":1.0,"minimum":0.5,"default":0.86,"title":"Threshold"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_NameInconsistenciesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"401":{"description":"Unauthorized - Missing/invalid token or no access to this business","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_name_inconsistencies_api_v1_counterparty_naming_inconsistencies_get"}}},"components":{"schemas":{"NameInconsistenciesResponse":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/NameInconsistencyGroup"},"type":"array","title":"Groups"},"total_groups":{"type":"integer","title":"Total Groups","default":0},"names_scanned":{"type":"integer","title":"Names Scanned","default":0},"window_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Window Days"},"threshold":{"type":"number","title":"Threshold"}},"type":"object","required":["threshold"],"title":"NameInconsistenciesResponse"},"NameInconsistencyGroup":{"properties":{"id":{"type":"string","title":"Id","description":"Stable id derived from the member names."},"suggested_name":{"type":"string","title":"Suggested Name"},"reason":{"type":"string","title":"Reason","description":"case_punctuation | suffix_or_number | similar"},"score":{"type":"number","title":"Score"},"txn_count":{"type":"integer","title":"Txn Count"},"members":{"items":{"$ref":"#/components/schemas/NameInconsistencyMember"},"type":"array","title":"Members"}},"type":"object","required":["id","suggested_name","reason","score","txn_count","members"],"title":"NameInconsistencyGroup"},"NameInconsistencyMember":{"properties":{"counterparty":{"type":"string","title":"Counterparty"},"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"},"txn_count":{"type":"integer","title":"Txn Count","default":0}},"type":"object","required":["counterparty"],"title":"NameInconsistencyMember"},"SuccessEnvelope_NameInconsistenciesResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/NameInconsistenciesResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[NameInconsistenciesResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}