Skip to main content
GET
Get a party's KYC status
Requires scope: manage:parties — see Required scopes. Returns where the party’s verification stands — KYC for an INDIVIDUAL, KYB for an ORGANISATION — read live from the verification platform. Use it to tell a verification that is under review apart from one that is waiting on your end customer, and to see which step needs attention. When verificationState is AWAITING_CUSTOMER, issue a KYC completion link and hand it to your end customer.
This endpoint reports progress, not the verdict you branch on. The party’s and its accounts’ kycStatus/kybStatus change only once a verdict (APPROVED or DECLINED) is reached — read those from Get a party.
New values may be added to every enum-like field. Treat an unknown verificationState as still in progress.

Errors

See Troubleshooting verification.

Authorizations

FlowClient Credentials
Token URL
https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

partyId
string<uuid>
required

Unique party identifier

Response

Where the party's verification stands

success
boolean

Indicates whether the request was successful

result
object

Where a party's identity verification stands, relayed live from the verification platform. Enum-like values are relayed as-is and new values may be added; treat an unknown verificationState as still in progress.