Skip to main content
POST
Create a shareable prospect submission link.

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.

Headers

Idempotency-Key
string
required

Client-generated unique key (UUID recommended) for this write operation. Identical key + identical body within 24h returns the cached response. Identical key + different body returns 422.

Required string length: 1 - 255

Path Parameters

sellerId
string<uuid>
required

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

Body

application/json

A new Click2Comply campaign link. Every property is optional: {} makes an unlabelled link that expires after 30 days, is credited to the seller company and follows the seller's payment and document upload settings.

label
string
Example:

"LinkedIn Campaign Q2"

expiresInDays
integer
default:30
Required range: 1 <= x <= 365
neverExpires
boolean
default:false

true makes a link that never expires. Refused with 422 together with expiresInDays.

creditedContactId
string<uuid>

The seller's contact the link's prospects are credited to: a live member of this seller with a platform account. Any other id, including a contact of another seller of your organization, answers 400. Absent credits the seller company.

paymentSetting
enum<string>
default:SELLER_DEFAULT

A campaign link's own payment or document upload setting for buyers through it: ENABLED or DISABLED override the seller's Click2Comply setting, SELLER_DEFAULT follows it.

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

A campaign link's own payment or document upload setting for buyers through it: ENABLED or DISABLED override the seller's Click2Comply setting, SELLER_DEFAULT follows it.

Available options:
SELLER_DEFAULT,
ENABLED,
DISABLED

Response

Invitation created.

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