post
https://api.useoval.com/entity_onboarding//actions//refresh
POST /entity_onboarding/{id}/actions/{action_id}/refresh
Refresh an available or expired action on an active onboarding. Use the onboarding ID and action ID from the latest fetch. The response includes the updated onboarding.
Use a server-side bearer key for the same organisation and environment. See Authentication.
Use data.id for {id} and the selected actions[].id for {action_id}. Send the POST with no request body. Read the returned action and present its available URL to the applicant. In test mode, refreshing invalidates the earlier link. A terminal onboarding cannot be refreshed.
Response · HTTP 200
{
"data": {
"id": "10000000-0000-4000-8000-000000000042",
"entity_type": "person",
"reference": "applicant-0042",
"status": "action_required",
"status_reason": null,
"person_id": null,
"created_at": "2026-11-01T12:00:00Z",
"updated_at": "2026-11-01T12:03:00Z",
"actions": [
{
"id": "20000000-0000-4000-8000-000000000042",
"type": "open_url",
"status": "available",
"url": "https://example.invalid/hosted/replacement",
"expires_at": "2026-11-01T12:33:00Z"
}
]
}
}
Errors
| HTTP | What to check |
|---|---|
| 401 | Invalid credentials or organisation access |
| 404 | Check the onboarding ID and key scope. |
| 409 | Fetch the latest actions. An unknown or unusable action ID, a concurrent change, or a terminal onboarding can cause this conflict. |
| 500 | Graph could not process the request. Fetch the current state before retrying; reuse the same reference if the create result is uncertain. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Invalid credentials or organisation access