Cancel Onboarding

Cancel an in-progress onboarding process for a recipient.

POST /v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel

Cancel Onboarding

cURL

curl --request POST \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel

Cancels an in-progress onboarding process for a recipient. Once cancelled, the onboarding status transitions to CANCELLED. To restart, create a new onboarding.

This action is not reversible for the same onboarding record. To resume onboarding after cancellation, you must Create a new Onboarding.

Path Parameters

recipient_id · string · required

The unique identifier of the recipient.

onboarding_id · string · required

The unique identifier of the onboarding process to cancel.

Related Pages

• Onboarding Statuses. Status lifecycle reference
• Create Onboarding. Start a new onboarding after cancellation
• Block Onboarding. Temporarily suspend instead of cancelling