Get the KYC form schema
curl --request GET \
--url https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema', 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.next.orenda.finance/v1/applications/{applicationId}/kyc/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.next.orenda.finance/v1/applications/{applicationId}/kyc/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.next.orenda.finance/v1/applications/{applicationId}/kyc/schema")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"schema": {
"step-1": [
{
"key": "first_name",
"input_type": "text",
"label": "First name",
"required": true
},
{
"key": "dob",
"input_type": "date",
"label": "Date of birth",
"required": true
},
{
"key": "country",
"input_type": "select",
"label": "Country",
"required": true,
"options": [
"GB",
"US",
"FR"
]
},
{
"key": "proof_of_address",
"kyc_type": "documents",
"input_type": "file",
"required": true,
"formats": [
"pdf",
"jpg"
],
"required_if": {
"key": "country",
"value": "GB"
}
}
],
"schemaInfo": {
"step-1": {
"stepImage": "https://cdn.next.orenda.finance/kyc/step-1.png"
}
}
}
}
}{
"success": false,
"code": "VALIDATION_ERROR",
"message": "isCompany is required"
}{
"success": false,
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}{
"success": false,
"code": "RESOURCE_NOT_FOUND",
"message": "Application not found"
}{
"success": false,
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}Onboarding
Get the KYC form schema
Returns the dynamic, program-specific form definition the user must fill in for the current KYC/KYB step. Render the fields, collect the answers, and send them back to Submit KYC. The schema is grouped into steps; each field carries its input type, validation, and conditional required_if rules.
GET
/
v1
/
applications
/
{applicationId}
/
kyc
/
schema
Get the KYC form schema
curl --request GET \
--url https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema', 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.next.orenda.finance/v1/applications/{applicationId}/kyc/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.next.orenda.finance/v1/applications/{applicationId}/kyc/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.next.orenda.finance/v1/applications/{applicationId}/kyc/schema")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.next.orenda.finance/v1/applications/{applicationId}/kyc/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"schema": {
"step-1": [
{
"key": "first_name",
"input_type": "text",
"label": "First name",
"required": true
},
{
"key": "dob",
"input_type": "date",
"label": "Date of birth",
"required": true
},
{
"key": "country",
"input_type": "select",
"label": "Country",
"required": true,
"options": [
"GB",
"US",
"FR"
]
},
{
"key": "proof_of_address",
"kyc_type": "documents",
"input_type": "file",
"required": true,
"formats": [
"pdf",
"jpg"
],
"required_if": {
"key": "country",
"value": "GB"
}
}
],
"schemaInfo": {
"step-1": {
"stepImage": "https://cdn.next.orenda.finance/kyc/step-1.png"
}
}
}
}
}{
"success": false,
"code": "VALIDATION_ERROR",
"message": "isCompany is required"
}{
"success": false,
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}{
"success": false,
"code": "RESOURCE_NOT_FOUND",
"message": "Application not found"
}{
"success": false,
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}Authorizations
The user's access_token from authentication. The program and environment (sandbox/prod) are read from the token.
Path Parameters
The application id from create / get.
⌘I