Skip to main content
A successful HTTP response can indicate acceptance rather than completed work. The source contract uses 202 for most long-running commands and 201 for creation of a verification session whose result arrives later. The event replay command returns a queued replay receipt. Monitor redelivery through your webhook receiver and the delivery controls configured during onboarding.

Poll safely

Persist the returned resource or job ID. Poll the documented retrieval route with bounded backoff, respect throttling, and stop at the resource’s terminal state or your application deadline. A client polling deadline does not cancel server work. Sync-style jobs use queued, running, completed, partial, failed, and cancelled. Other resources have their own typed states. Do not assume every job uses the same enum or that a generic cancellation command exists.

Interpret completion

  • partial means some requested scope remains unavailable. Inspect errors, missing intervals, completed jurisdictions, and missing-field reasons.
  • Verification completion means a result is available; it can be declined or require review.
  • A completed lien search with no results applies only to the declared completed scope.
  • Attribute calculation can complete with individual values marked unavailable.
  • A completed assessment is not authorization to fund a loan or contact a borrower.
  • Account cancellation immediately stops processing, usage deductions, and upcoming top-ups. Pending work is cancelled without a usage debit. Full account closure is at the end of the request month. After that month closes and final information is generated, deletion removes all associated workspace data; there is no public deletion-command API.
Retrieve the authoritative resource after an event. Use resource_version to avoid overwriting a newer record with an older delivery. See webhooks.