Skip to main content
GET
/
v1
/
recipients
/
{recipient_id}
/
onboardings
/
{onboarding_id}
Get Onboarding
curl --request GET \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}
{
  "id": "<string>",
  "account_id": "<string>",
  "merchant_recipient_id": "<string>",
  "type": "<string>",
  "workflow": "<string>",
  "status": "<string>",
  "provider": {},
  "documentation": [
    {}
  ],
  "withdrawal_methods": [
    {}
  ],
  "legal_representatives": [
    {}
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}
Retrieves the details of a specific onboarding process, including its current status, provider information, documentation, and withdrawal methods.

​
Path Parameters

​
recipient_id
string
required
The unique identifier of the recipient.
​
onboarding_id
string
required
The unique identifier of the onboarding process.

​
Response Fields

​
id
string
Unique onboarding identifier.
​
account_id
string
Associated account identifier.
​
merchant_recipient_id
string
Merchant-defined recipient identifier.
​
type
string
Onboarding type: PREVIOUSLY_ONBOARDED or ONBOARD_ONTO_THE_PROVIDER.
​
workflow
string
Workflow type: HOSTED_BY_PROVIDER or DIRECT.
​
status
string
Current onboarding status. See Onboarding Statuses for all values.
​
provider
object
Provider details including id, connection_id, recipient_id, and recipient_type.
​
documentation
array
Array of uploaded documents with file details.
​
withdrawal_methods
array
Bank account information configured for payouts.
​
legal_representatives
array
Organization owners or beneficial owners, if applicable.
​
created_at
string
ISO 8601 creation timestamp.
​
updated_at
string
ISO 8601 last update timestamp.