Get Entity Onboarding Status (Banking Connectivity)
curl --request GET \
--url https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id} \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>'import requests
url = "https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}"
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};
fetch('https://api-sandbox.y.uno/v1/banking/entities/{entity_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/banking/entities/{entity_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",
CURLOPT_HTTPHEADER => [
"private-secret-key: <api-key>",
"public-api-key: <api-key>"
],
]);
$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/banking/entities/{entity_id}/onboardings/{onboarding_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": "verification_pending"
},
"onboarding_type": "ONE_STEP",
"status": "PENDING",
"requirements": [],
"created_at": "2026-02-01T10:00:00Z",
"updated_at": "2026-02-01T10:00:00Z",
"expires_at": "2026-02-08T10:00:00Z"
}Entity Onboarding (Banking Connectivity)
Get Entity Onboarding Status (Banking Connectivity)
GET
/
banking
/
entities
/
{entity_id}
/
onboardings
/
{onboarding_id}
Get Entity Onboarding Status (Banking Connectivity)
curl --request GET \
--url https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id} \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>'import requests
url = "https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}"
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};
fetch('https://api-sandbox.y.uno/v1/banking/entities/{entity_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/banking/entities/{entity_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",
CURLOPT_HTTPHEADER => [
"private-secret-key: <api-key>",
"public-api-key: <api-key>"
],
]);
$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/banking/entities/{entity_id}/onboardings/{onboarding_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": "verification_pending"
},
"onboarding_type": "ONE_STEP",
"status": "PENDING",
"requirements": [],
"created_at": "2026-02-01T10:00:00Z",
"updated_at": "2026-02-01T10:00:00Z",
"expires_at": "2026-02-08T10:00:00Z"
}Retrieve the current status of an entity onboarding. See Onboarding statuses for the full status lifecycle.
Path Parameters
The id of the entity obtained from Create Entity.
The id of the onboarding obtained from Create Entity Onboarding.
Response
Example:
"onb_990e8400-e29b-41d4-a716-446655440000"
Example:
"ent_660e8400-e29b-41d4-a716-446655440000"
Example:
"550e8400-e29b-41d4-a716-446655440000"
Show child attributes
Show child attributes
Example:
"ONE_STEP"
Example:
"PENDING"
Example:
"2026-02-01T10:00:00Z"
Example:
"2026-02-01T10:00:00Z"
Example:
"2026-02-08T10:00:00Z"
Was this page helpful?