Account Holders

Refresh account holder onboarding

Changed on

Manually re-runs the onboarding pipeline (screening + RuleEngine + control application) for an existing account holder. Clears the currently-scheduled rescreen job and enqueues a new one based on the engine's next_screening_at.

Used by operator-driven re-screen flows; the same OnboardingContext.refresh/2 is invoked by AtomicFi.OnboardingWorker on the scheduled cadence.

post/api/account-holders/{id}/refresh

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/account-holders/{id}/refresh
  • Auth: none required

Path parameters

idstring uuid required

Account holder ID

Response

Refreshed account holder

account_holder_numberstring nullable
account_holder_type'individual' | 'business' | 'trust' | 'nonprofit' required
enabled_currenciesstring[] nullable
enabled_regimesstring[] nullable
external_idstring nullable
idstring uuid
inserted_atstring date-time
kyc_status'not_started' | 'in_progress' | 'approved' | 'rejected' | 'expired' nullable
last_reviewed_atstring date-time nullable
onboarded_atstring date-time nullable
risk_level'low' | 'medium' | 'high' | 'very_high' | 'prohibited' nullable
status'pending' | 'active' | 'suspended' | 'closed' | 'flagged' nullable
tenant_idstring uuid
updated_atstring date-time

Example response

{
  "account_holder_number": "",
  "account_holder_type": "individual",
  "beneficial_owners": [
    null
  ],
  "enabled_currencies": [
    ""
  ],
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "kyc_status": "not_started",
  "last_reviewed_at": "2020-04-20T16:20:00Z",
  "legal_entity": null,
  "onboarded_at": "2020-04-20T16:20:00Z",
  "risk_level": "low",
  "status": "pending",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes