Sign in
KYC

Get the KYC status of an address for a yield

Returns the normalized KYC status for the given address. Yields without a KYC requirement return not_required.

get/v1/yields/{yieldId}/kyc/status

Path parameters

yieldIdstring required

The yield integration ID

Query parameters

addressstring required

Wallet address to check KYC status for

Response

kycStatus'not_required' | 'not_started' | 'pending' | 'approved' | 'rejected' required

Normalized KYC status for the address on this yield

authorizeUrlstring

Issuer's KYC portal URL, when applicable

Example response

{
  "kycStatus": "not_required"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.