Get KYC status

Get the KYC status of an address for a yield

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/kyc/status \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.yield.xyz/v1/yields/{yieldId}/kyc/status', 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.yield.xyz/v1/yields/{yieldId}/kyc/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-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.yield.xyz/v1/yields/{yieldId}/kyc/status"

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

	req.Header.Add("x-api-key", "<api-key>")

	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.yield.xyz/v1/yields/{yieldId}/kyc/status")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "kycStatus": "not_required",
  "authorizeUrl": "<string>"
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

GET

yields

{yieldId}

kyc

status

Get the KYC status of an address for a yield

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/kyc/status \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.yield.xyz/v1/yields/{yieldId}/kyc/status', 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.yield.xyz/v1/yields/{yieldId}/kyc/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-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.yield.xyz/v1/yields/{yieldId}/kyc/status"

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

	req.Header.Add("x-api-key", "<api-key>")

	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.yield.xyz/v1/yields/{yieldId}/kyc/status")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "kycStatus": "not_required",
  "authorizeUrl": "<string>"
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

Requires x-api-key and the query parameter address. Yields with no KYC requirement return not_required. Reference contract only; issuer requirements are in RWA KYC, and the pre-flight flow is in Check eligibility.

Response

Field	Type	Notes
`kycStatus`	string	One of the statuses below.
`authorizeUrl`	string, optional	The issuer’s KYC portal URL. Present only when the issuer provides one, typically for `not_started` and `rejected`. Do not depend on it for other statuses.

KYC statuses

Value	Meaning
`not_required`	The yield has no KYC requirement.
`not_started`	The address has not begun KYC with the issuer.
`pending`	Declared for KYC under review; no current issuer integration returns it.
`approved`	The address is cleared to transact.
`rejected`	KYC was declined.

Errors

Status	Cause
400	`address` is missing or empty, or (on a KYC-gated yield) not a valid address for its network.
401	Missing or invalid API key.
404	The yield was not found.
429	Rate limited.

An action on an RWA yield for an address that is not cleared fails with 412. See Errors and retries.

Authorizations

x-api-key

string

header

required

Path Parameters

yieldId

string

required

The yield integration ID

Query Parameters

address

string

required

Wallet address to check KYC status for

Response

kycStatus

enum<string>

required

Normalized KYC status for the address on this yield

Available options:

not_required,

not_started,

pending,

approved,

rejected

Example:

"not_required"

authorizeUrl

string

Issuer's KYC portal URL, when applicable

Getting started

Earn

Trade

Borrow

Response

KYC statuses

Errors

Authorizations

Path Parameters

Query Parameters

Response

​Response

​KYC statuses

​Errors

Authorizations

Path Parameters

Query Parameters

Response

Response

KYC statuses

Errors