GET /v1/onboarding/partner/applications/{id}.
Notifications arrive as Amazon SNS messages on the
v1 notification system. To
register a webhook, create an End User Onboarding subscription in the
Circle Console under Developer >
Subscriptions. Then follow
Set up a webhook endpoint.
When notifications fire
Webhooks fire only for outcomes you cannot see in your own API response. For example,DRAFT → SUBMITTED from a submit call does not send a webhook. The
HTTP response already includes the result.
onboarding_application_rfi_requested signals that the compliance team has
issued one or more Requests for Information (RFIs). See
Handle requests for information for
the RFI workflow, and
Application types and states
for the full lifecycle.
Payload
Every End User Onboarding notification carries the same flat payload.status and previousStatus use the same values as
Application types and states.
Internal review sub-states are collapsed to IN_REVIEW, so a transition out of
review reports previousStatus as IN_REVIEW.Event types
onboarding_application_rfi_requested
The compliance team issued one or more RFIs. The application moved to
PENDING_CUSTOMER_INFORMATION. Fetch open RFIs with
List RFIs. The application’s
pendingRfis array also lists the bundle IDs. Respond to each RFI, then
resubmit.
Example payload
Example payload
onboarding_application_approved
Compliance review completed and the application was approved. This is a terminal
state.
Example payload
Example payload
onboarding_application_denied
Compliance review completed and the application was denied. This is a terminal
state.
Example payload
Example payload
onboarding_application_cancelled
The application was canceled. previousStatus reflects the application’s status
before cancellation and depends on the application type. This is a terminal
state.
Example payload
Example payload
onboarding_periodic_review_requested
A periodic review application moved from IN_REVIEW back to DRAFT, making it
editable. Use this notification to start the partner response flow for the
review request.
Example payload
Example payload