Skip to main content
POST
Issue a KYC completion link
Requires scope: manage:parties — see Required scopes. Issues a fresh link your end customer opens to finish a verification that is waiting on them — typically a Sumsub verification you forwarded with sumsubToken whose applicant never completed their checks. Call it when the party’s KYC status is AWAITING_CUSTOMER. Takes no request body. Every call mints a new, short-lived link, and nothing is stored — so when one expires, simply call this again. The URL embeds an access token. Treat it as a credential: don’t log it, don’t put it in a shared inbox, and don’t reuse it across customers. Follow the customer’s progress on Get a party’s KYC status; the verdict itself lands on the party’s kycStatus/kybStatus.

Errors

See Sumsub token sharing.

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

A completion link was issued

success
boolean

Indicates whether the request was successful

result
object

A freshly issued link the end customer opens to finish a verification that is waiting on them. completionUrl embeds a short-lived access token — treat it as a credential. It is not stored.