Get Onboarding

GET

recipients

{recipient_id}

onboardings

{onboarding_id}

Get Onboarding

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

const options = {method: 'GET'};

fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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

string

required

The unique identifier of the recipient.

string

required

The unique identifier of the onboarding process.

Response Fields

string

Unique onboarding identifier.

string

Associated account identifier.

string

Merchant-defined recipient identifier.

string

Onboarding type: PREVIOUSLY_ONBOARDED or ONBOARD_ONTO_THE_PROVIDER.

string

Workflow type: HOSTED_BY_PROVIDER or DIRECT.

string

Current onboarding status. See Onboarding Statuses for all values.

object

Provider details including id, connection_id, recipient_id, and recipient_type.

array

Array of uploaded documents with file details.

array

Bank account information configured for payouts.

array

Organization owners or beneficial owners, if applicable.

string

ISO 8601 creation timestamp.

string

ISO 8601 last update timestamp.

Onboarding Statuses. Status lifecycle reference
Create Onboarding. Start a new onboarding
Update Onboarding. Modify an existing onboarding

Get Onboarding

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

const options = {method: 'GET'};

fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>"
}

Getting started

Conventions

Core

Recurring

Hosted

Marketplace

Embedded finance

Operations

Recovery

Reference data

Path Parameters

Response Fields

​Path Parameters

​Response Fields

​Related Pages

Path Parameters

Response Fields

Related Pages