Skip to main content
POST
Create a self-service KYC invitation (emailed 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).

buyerId
string<uuid>
required

UUID of the buyer trade partner.

Body

application/json
recipientEmail
string<email>
required
expiresInDays
integer
default:30
Required range: 1 <= x <= 90
language
string
Example:

"en"

Response

Invitation created and email queued.

uuid
string<uuid>
required
kind
enum<string>
required
Available options:
KYC,
PROSPECT
status
enum<string>
required
Available options:
ACTIVE,
USED,
REVOKED,
EXPIRED
createdAt
string<date-time>
required
expiresAt
string<date-time>
required
recipientEmail
string<email>
label
string
lastUsedAt
string<date-time>
usageCount
integer
revokedAt
string<date-time>
revocationReason
string