Skip to main content
POST
/
v1
/
banking
/
entities
/
{entity_id}
/
onboardings
/
{onboarding_id}
/
cancel
Cancel Entity Onboarding (Banking Connectivity)
curl --request POST \
  --url https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}/cancel \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'
{
  "id": "onb_990e8400-e29b-41d4-a716-446655440000",
  "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000",
  "yuno_account_id": "550e8400-e29b-41d4-a716-446655440000",
  "provider": {
    "entity_id": "col_entity_onboarded_123",
    "status": "cancelled"
  },
  "onboarding_type": "ONE_STEP",
  "status": "CANCELLED",
  "requirements": [],
  "created_at": "2026-02-01T10:00:00Z",
  "updated_at": "2026-02-02T08:45:00Z",
  "expires_at": "2026-02-08T10:00:00Z"
}
Cancel a pending onboarding. Only onboardings that have not reached a terminal status can be cancelled. See Onboarding statuses for which statuses are terminal.

Authorizations

​
public-api-key
string
header
required
​
private-secret-key
string
header
required

Path Parameters

​
entity_id
string
required

The id of the entity obtained from Create Entity.

​
onboarding_id
string
required

The id of the entity obtained from Create Entity.

Response

​
id
string
Example:

"onb_990e8400-e29b-41d4-a716-446655440000"

​
entity_id
string
Example:

"ent_660e8400-e29b-41d4-a716-446655440000"

​
yuno_account_id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
provider
object
​
onboarding_type
string
Example:

"ONE_STEP"

​
status
string
Example:

"CANCELLED"

​
requirements
object[]
​
created_at
string
Example:

"2026-02-01T10:00:00Z"

​
updated_at
string
Example:

"2026-02-02T08:45:00Z"

​
expires_at
string
Example:

"2026-02-08T10:00:00Z"