GET /v1/onboarding/partner/applications/{id}.
Notifications are delivered as Amazon SNS messages on the
v1 notification system. To
register a webhook endpoint, create a subscription for End User Onboarding
notifications in the Circle Mint Console under
Developer > Subscriptions, then see
Set up a webhook endpoint.
When notifications fire
Webhooks are sent only for asynchronous outcomes that you cannot observe from the response to your own API call. Synchronous transitions you trigger directly—such asDRAFT → SUBMITTED from a submit request—are not delivered
as webhooks because the result is already in the HTTP response.
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 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 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 and the application moved to
PENDING_CUSTOMER_INFORMATION. Fetch the open RFIs with
List RFIs (the application’s
pendingRfis array also carries the bundle IDs), respond to each, 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. Cancellation is only reachable from DRAFT, so
previousStatus is always DRAFT. This is a terminal state.
Example payload
Example payload