Archive an identification
Archive an identification. This is terminal and cannot be undone: the identification is permanently invalidated and can no longer be used to verify the customer.
Authorizations
API Key
Headers
Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01.
Path Parameters
the ID of the Identification to archive
Response
Identification Archived
Identification
The entity wrapping our KYC/KYB process and underlying providers
Rails (e.g. "ach", "sepa_thirdparty") the synchronous rule-engine
preflight gate definitively ruled out at creation time, keyed to a
partner-safe reason. Only set on an outsourced Person/Business
identification (empty otherwise) — see
controllers::identifications::create_person_customer_outsourced_identification /
create_business_customer_outsourced_identification_v2.
The Process status of the identification
The various state transitions an identification can go through.
Pending, Processed, PendingReview, Approved, Declined, Expired, Archived Absent on a referral partner's identification (partner-keyed record)
The owning partner for partner-keyed (referral) records
Curated, partner-safe summary of the async preflight pipeline
(document/selfie analysis + workflow predictor) — backfilled onto an
identification once the shadow worker finishes (see
controllers::identification_preflight_shadow). Deliberately narrower than
ApiIdentificationPreflightResult/PreflightShadowDetails: no internal
level names, trace/correlation ids, or per-check evaluation names — those
stay internal/backoffice-only.
ISO 3166-1 alpha-2 (2 letter) country code of the verified residence address; only set on the customer's most recent identification while it is approved
- BusinessIdentificationStepStatus
- PersonIdentificationStepStatus