Simulate periodic review

post

https://example.com/api/v3.0/users/{appUserId}/periodic-review/mock

Description

This endpoint allows the partner to simulate a periodic review by triggering either an enrollment or an escalation.
When no request body is provided, the default configuration is applied. Otherwise, the provided values override the defaults.

Prerequisite

Not accessible in production.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appUserId

string

required

Body Params

overdueInterval

string | null

Duration after enrollment before the review is considered overdue.
OverdueAt = RequestedAt + OverdueInterval.
Defaults to the global overdue interval setting (90 days).

timeoutInterval

string | null

Duration after becoming overdue before the review times out.
TimeoutAt = RequestedAt + OverdueInterval + TimeoutInterval.
Defaults to the global timeout interval setting (30 days).

followUpIntervals

array of strings or null | null

Durations (relative to RequestedAt) at which follow-up reminders are sent.
The system picks the earliest interval that has not yet passed to schedule the next follow-up.
Defaults to the global follow-up intervals setting.

followUpIntervals

Headers

CorrId

string

Defaults to beca2153-6113-481a-a2a8-2b0f167ffe85

Correlation Id

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200

403Forbidden

404Not Found