Skip to main content
PUT
Archive an identification

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-API-Version
string

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

id
string<uuid>
required

the ID of the Identification to archive

Response

Identification Archived

Identification

The entity wrapping our KYC/KYB process and underlying providers

blocking_abilities
object
required

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.

created_at
string<date-time>
required
id
string<uuid>
required
status
enum<string>
required

The Process status of the identification

The various state transitions an identification can go through.

Available options:
Pending,
Processed,
PendingReview,
Approved,
Declined,
Expired,
Archived
updated_at
string<date-time>
required
customer_id
string<uuid>

Absent on a referral partner's identification (partner-keyed record)

partner_id
string<uuid>

The owning partner for partner-keyed (referral) records

preflight_summary
IdentificationPreflightSummary · object

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.

residence_country
string

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

review_comment
string
step_status
BusinessIdentificationStepStatus · object
url
string
with_edd
boolean