Skip to main content
POST
Refresh status
Check the provider for a status update. Send an empty JSON object for the normal flow:
Read data.case.status after the call. A successful response can still mean verification is pending. An already approved request returns success without creating new hosted steps. If no provider status update is available, supported hosted steps can be renewed when availableActions includes refresh_provider_steps. Normal renewal requires at least one unsubmitted hosted step. Use force: true only to intentionally regenerate supported hosted steps; it does not bypass terminal-state checks. After approval, start a new fiat session to use the updated onboarding status. You can also receive status changes through webhooks.

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string<uuid>
required

Customer identifier.

caseId
string<uuid>
required

Customer onboarding case identifier.

Body

application/json

Send {} to check provider verification or refresh normally. force is optional and defaults to false.

force
boolean
default:false

Force hosted-session regeneration only in the supported renewal path. Does not bypass provider verification, terminal-state checks or ownership. With false, existing sessions must exist and not all be submitted.

Response

Verification synchronized, hosted steps refreshed, or case already approved.

status
boolean
required
Example:

true

message
string
required
data
object
required