Read back a returned enrichment

View as Markdown

Request

Response

Found.

application/jsonStoredEnrichment

enrichment_idstringrequired
created_atstring · date-timerequired

Rate limit

debit_ti_v1operational_burst_protection · token_bucket

120 / min

per key · capacity 120 · refill 2/s

600 / min

per workspace · capacity 600 · refill 10/s

« 120 requetes / minute » est traduit en seau a jetons : capacite 120 (la rafale toleree) rechargee a 2 jetons / seconde (le regime durable). Une clef au repos peut envoyer 120 requetes d'un coup, puis 2 par seconde ; sur la premiere minute apres un repos, jusqu'a 240 passent. Le workspace, lui, borne la somme de toutes ses clefs a 600 / minute (capacite 600, 10 / s) : cent clefs ne font pas cent fois la limite.

This is not: sandbox_lifetime_quota · production_usage_quota · billing_entitlement · commercial_promise

Possible errors

Code
Status	Code	Title
`401`	`invalid_api_key`	The credential presented is not usable.
`403`	`account_inactive`	The workspace or organisation is not active.
`404`	`not_found`	No readable enrichment under this identifier. Unknown, expired or outside your scope: these cases are not distinguished.
`429`	`rate_limited`	Too many requests. The rate limit for this key has been reached. Replay after the Retry-After delay.
`500`	`internal_error`	An internal error occurred.

All errors

GET/transactions/v1/enrichments/{enrichment_id}

Serverhttps://api.noryo.app

curl -sS -g -X GET 'https://api.noryo.app/transactions/v1/enrichments/{enrichment_id}' \
  -H "Authorization: Bearer $NORYO_API_KEY"

Shell

Authorization

Header: Authorization
Type: http
Scheme: bearer

A credential of the txn family: nry_txn_sbx_<key_id>.<secret> in Sandbox, nry_txn_live_<key_id>.<secret> in Production. A nry_mer_* key is refused here, and vice versa: the families are isolated by the verifier's domain, not merely by a filter.

Response samples

Schema structure

{
  "enrichment_id": "<string>",
  "created_at": "<string · date-time>",
  "expires_at": "<string · date-time>",
  "resolution": {
    "policy": {
      "outcome": "<string>",
      "archetype": "<string>",
      "missing": "<array<string>>",
      "policy_version": "<string>"
    },
    "normalized": {
      "descriptor": "<string>",
      "signal": "<string>",
      "useful": "<string>",
      "residual": "<string>",
      "normalizer_version": "<string>"
    },
    "counterparty": {
      "entity_id": "<string · uuid>",
      "name": "<string>",
      "kind": "<string>",
      "evidence": {
        "match": "<string>",
        "pattern": "<string>",
        "coverage": "<number ≥ 0>",
        "covered": "<number · 0.6–1>"
      },
      "semantics": {
        "activity": {
          "code": "<string>",
          "label": "<string>",
          "parent": "<string>"
        },
        "recurring_model": "<string>",
        "roles": "<array<string>>",
        "legal_entity": {
          "entity_id": "<string · uuid>",
          "name": "<string>"
        },
        "provenance": {
          "nature": "<string>",
          "source": "<string>",
          "strength": "<number · 0–1>",
          "calibration": "<string>",
          "evidence": "<object>"
        }
      }
    },
    "counterparty_type": "<string>",
    "counterparty_note": "<string>",
    "category": {
      "slug": "<string>",
      "label": "<string>",
      "source": "<string>"
    },
    "identity_abstention": "<string>",
    "intermediaries": [
      {
        "name": "<string>",
        "role": "<string>",
        "entity_id": "<string · uuid>",
        "carries_sub_merchant": "<boolean>",
        "evidence": {
          "code": "<string>",
          "source": "<string>"
        }
      }
    ],
    "transaction_type": {
      "canonical": "<string>",
      "evidence": "<string>",
      "contradiction": "<string>"
    },
    "payment": {
      "rail": "<string>",
      "mechanism": "<string>",
      "note": "<string>"
    },
    "signal_conflicts": [
      {
        "dimension": "<string>",
        "signals": "<array<string>>",
        "resolution": "<string>",
        "resolved_to": "<string>"
      }
    ],
    "submerchant_lane": "<string>",
    "truncated_lane": "<string>",
    "confidence": {
      "entity": "<number · 0–1>",
      "counterparty": "<number · 0–1>",
      "transaction_type": "<number · 0–1>",
      "category": "<number · 0–1>",
      "location": "<number>",
      "calibration": "<string>"
    },
    "timings_ms": {
      "normalization": "<number>",
      "entity_resolution": "<number>",
      "submerchant": "<number>",
      "total": "<number>"
    },
    "versions": {
      "graph": "<string>",
      "rules": "<string>",
      "engine": "<string>",
      "resolution_policy": "<string>",
      "calibration": "<string>"
    }
  },
  "relationships": [
    {
      "type": "<string>",
      "role": "<string>",
      "symmetric": "<boolean>",
      "counterpart": "<string>",
      "match_strength": {
        "value": "<number · 0.001–1>",
        "calibration": "<string>",
        "corroborations": {
          "present": "<integer ≥ 0>",
          "possible": "<integer ≥ 1>"
        }
      },
      "evidence": [
        {
          "code": "<string>",
          "value": "<string>",
          "value_seconds": "<integer>"
        }
      ],
      "window_seconds": "<integer>",
      "detector_version": "<string>",
      "status": "<string>",
      "created_at": "<string · date-time>"
    }
  ],
  "series": [
    {
      "series_id": "<string>",
      "type": "<string>",
      "implies": "<array<string>>",
      "status": "<string>",
      "cadence": "<string>",
      "occurrence_count": "<integer>",
      "amount_behavior": {
        "kind": "<string>",
        "min_minor_units": "<string>",
        "max_minor_units": "<string>",
        "currency": "<string>"
      },
      "first_seen": "<string · date-time>",
      "last_seen": "<string · date-time>",
      "expected_next_at": "<string · date-time>",
      "match_strength": {
        "value": "<number · 0.001–1>",
        "calibration": "<string>",
        "corroborations": {
          "present": "<integer>",
          "possible": "<integer>"
        }
      },
      "evidence": [
        {
          "code": "<string>",
          "value": "<string | integer>"
        }
      ],
      "lifecycle": {
        "state": "<string>",
        "reason": "<string>",
        "last_observed_on": "<string · date>",
        "expected_next_window": {
          "from": "<string · date>",
          "to": "<string · date>",
          "tolerance_days": "<integer>",
          "anchor": "<string>",
          "widened_to_family_floor": "<boolean>"
        },
        "consecutive_misses": "<integer>",
        "observation_coverage": "<string>",
        "cadence_strength": "<number>",
        "calendar_anchor": "<any>",
        "evidence": [
          {
            "code": "<string>"
          }
        ],
        "identity_status": "<string>",
        "policy_version": "<string>",
        "calibration": "<string>"
      },
      "identity": {
        "status": "<string>",
        "superseded_by": {
          "reason": "<string>",
          "at": "<string · date-time>",
          "evidence": "<array<string>>",
          "successor_series_ids": "<array<string>>"
        },
        "supersedes": "<array<string>>"
      },
      "membership": {
        "original_series_id": "<string>",
        "current_series_id": "<string>",
        "corrections": [
          {
            "reason": "<string>",
            "from_series_id": "<string>",
            "to_series_id": "<string>",
            "at": "<string · date-time>"
          }
        ]
      },
      "first_observed_on": "<string · date>",
      "last_observed_on": "<string · date>",
      "may_predate_observation": "<boolean>",
      "cadence_detail": {
        "type": "<string>",
        "strength": "<number · 0–1>",
        "calibration": "<string>"
      },
      "calendar_pattern": {
        "type": "<string>",
        "nominal_day": "<integer>",
        "weekday": "<integer>",
        "day_range": "<array<integer>>",
        "weekend_shifts": "<integer>",
        "strength": "<number · 0–1>",
        "calibration": "<string>"
      },
      "history_coverage": {
        "observed_from": "<string · date>",
        "observed_to": "<string · date>",
        "raw_days": "<integer>",
        "derived_days": "<integer>",
        "observed_days": "<integer>",
        "retention_limit_days": "<integer>",
        "occurrence_count": "<integer>",
        "cadence": "<string>",
        "sufficiency": "<string>",
        "reason": "<string>",
        "first_occurrence_reason": "<string>",
        "first_occurrence_bounded": "<boolean>"
      },
      "detector_version": "<string>"
    }
  ],
  "customization": {
    "rules": [
      {
        "id": "<string · uuid>",
        "version": "<integer ≥ 1>",
        "fields": "<array<string>>"
      }
    ]
  }
}

JSON

Was this page helpful?