Advance a ComplianceEntity to a successor identity

The explicit identity transition: end-dates the current record and mints a successor with the supplied facts, linked through previousId/nextId. The target must be the chain's current record; advancing a superseded record returns 409 ResourceConflict. The successor inherits the chain's owner and subject, starts every verification lane at NotStarted, and becomes the source for refreshed downstream projections such as Auto W-9s. The successor type must equal the predecessor's immutable chain type. effectiveDate defaults to now, or to the predecessor's startDate plus 1 ms when needed for a subject-scoped chain. It cannot precede the predecessor's startDate; a client-supplied date cannot be in the future and, for a subject-scoped chain, must be strictly later than the predecessor's startDate. The id is resolved with the same authorized-lane and primary-wins semantics as GET, and the resolved owner kind is retained through the transition. Idempotent via Idempotency-Key. Fires ComplianceEntity.Inactivated on the predecessor and ComplianceEntity.Evolved on the successor.

Requires a session with recent MFA step-up for HighRiskWriteAction. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "HighRiskWriteAction", then retry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of a ComplianceEntity record within the subject's chain (current or historical).

Body Params

Full successor facts for advanceComplianceEntity. The chain's owner and subject are inherited and cannot be supplied. effectiveDate becomes the successor's startDate and predecessor's endDate; it defaults to now, cannot precede the predecessor's startDate, and cannot be in the future. type is required for a complete successor body but must equal the predecessor's immutable chain type.

string
enum
required

Must equal the predecessor ComplianceEntity's type; changing chain type returns 422.

Allowed:
string
required

ISO 3166-1 alpha-2 country code for the successor's primary compliance jurisdiction.

string
enum

Universal canonical legal form; local fidelity preserved via jurisdictionalFormCode.

string
enum
Allowed:
string
enum
Allowed:
string
string
string
string
string
string
string
formationJurisdiction
object
string
string
uri
individualLegalName
object

Globalization-aware natural-person name. Application invariant: either fullLegalName, or both familyName and givenName, must be populated.

date
usTaxProfile
object

U.S. tax identity for a non-US individual. The name is distinct from the ComplianceEntity's local legal name. Only givenName, middleNames, and familyName are stored; fullLegalName, suffix, prefix, and transliteration are rejected on write.

governmentIds
array of objects
governmentIds
string
string

Primary contact number (both types).

string

Primary email address (Individual only).

string

Free-text job title or occupation (Individual only).

physicalAddress
object

Postal address. Subdivision codes per locale; country ISO 3166-1 alpha-2.

mailingAddress
object

Optional correspondence address (PO box / registered agent / mail-forwarding).

taxIdentifiers
array of objects
taxIdentifiers
string
metadata
object

Not yet supported; requests with non-empty metadata return 422.

date-time

Defaults to now; must not precede the predecessor's startDate or be in the future.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json