Skip to main content
POST
/
v1
/
recipients
/
{recipient_id}
/
onboardings
/
{onboarding_id}
/
block
Block onboarding
curl --request POST \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/block \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "reason": "Pending compliance review"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
public-api-key
string
header
required

Your public API key from the Yuno Dashboard

​
private-secret-key
string
header
required

Your private secret key (server-side only)

Path Parameters

​
recipient_id
string<uuid>
required

The unique identifier of the recipient

​
onboarding_id
string<uuid>
required

The unique identifier of the onboarding

Body

application/json
​
reason
string

Reason for blocking

Response

Onboarding blocked

​
id
string<uuid>
​
recipient_id
string<uuid>
​
status
enum<string>
Available options:
PENDING,
IN_PROGRESS,
BLOCKED,
COMPLETED,
FAILED
​
created_at
string<date-time>
​
updated_at
string<date-time>