Skip to main content
POST
Create a hosted verification link
Requires scope: manage:parties — see Required scopes. Mints a hosted verification link and returns the URL matching the party’s type — the KYC flow for INDIVIDUAL, the KYB flow for ORGANISATION. There is no request body: the stored partyType decides the flow. Hand the URL to the end-user. The verdict arrives asynchronously and flips the party’s kycStatus/kybStatus — poll Get a party for the outcome.
Links do not expire. Re-POSTing while a link is live returns the same URL with 200; if it was revoked, a fresh one comes back with 201. Either way you can safely call this again — you will not strand the user with a dead link.
Treat verificationUrl as a credential. It grants access to the end-user’s onboarding session, so deliver it over a channel you trust and never log it.
See Hosted verification links for the full flow, or Sumsub token sharing for the alternative route.

Errors

The codes this endpoint can return, in addition to the standard errors. Branch on code, never the message.

Authorizations

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

The party's existing live verification link was reissued unchanged

success
boolean

Indicates whether the request was successful

result
object

A hosted verification link minted for a party. Only the URL matching the party's type is exposed — the KYC flow for INDIVIDUAL, the KYB flow for ORGANISATION. The link does not expire; it stays valid until revoked, and a re-POST reissues the same URL.