Skip to main content
GET
List self-service KYC invitations for a buyer.

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant via Keycloak service account. Clients are provisioned per IntegrationOrganization in the nt24-idp realm.

Path Parameters

sellerId
string<uuid>
required

UUID of the seller trade partner (must be in caller's authorized list).

buyerId
string<uuid>
required

UUID of the buyer trade partner.

Response

OK

uuid
string<uuid>
required
kind
enum<string>
required
Available options:
KYC,
PROSPECT
status
enum<string>
required

Expiry outranks revocation: a link revoked after it had already lapsed reads EXPIRED, not REVOKED. MEMBER_LEFT is for kind: PROSPECT only: the link is neither revoked nor expired, but the member it credits (creditedContact) has left the seller, so buyers can no longer use it.

Available options:
ACTIVE,
REVOKED,
EXPIRED,
MEMBER_LEFT
createdAt
string<date-time>
required
recipientEmail
string<email>
label
string

The link handed to the recipient, rooted at the platform's configured frontend base url: {frontendBaseUrl}/kyc/selfservice/{token} for kind: KYC and {frontendBaseUrl}/click2comply?ref={code} for kind: PROSPECT, which opens the Click2Comply form for the seller. A kind: KYC invitation carries it only in the response of the create that made it: the platform stores a hash of the token alone, so the list, the revoke and a create that returns the recipient's live invitation leave it out. A kind: PROSPECT invitation carries it always.

expiresAt
string<date-time>

When the link stops working. Always present for kind: KYC. Absent for a kind: PROSPECT link that never expires: one created here with neverExpires: true, or one a seller's member made on the platform without an expiry.

lastUsedAt
string<date-time>
usageCount
integer
revokedAt
string<date-time>
revocationReason
string
creditedContact
object

kind: PROSPECT only. The seller's contact the link's prospects are credited to; absent when they are credited to the seller company.

paymentSetting
enum<string>
default:SELLER_DEFAULT

kind: PROSPECT only; always present there.

Available options:
SELLER_DEFAULT,
ENABLED,
DISABLED
documentUploadSetting
enum<string>
default:SELLER_DEFAULT

kind: PROSPECT only; always present there.

Available options:
SELLER_DEFAULT,
ENABLED,
DISABLED