Set Identification status
Sets a customer’s identification to any status, bypassing the normal transition rules, so partners can rehearse every branch of their onboarding UI. Sandbox only.
Authorizations
API Key
Headers
a UUID ensuring the status update is only processed once
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 update
Body
The status to set
The Process status of the identification
The various state transitions an identification can go through.
Pending, Processed, PendingReview, Approved, Declined, Expired, Archived Response
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