Skip to main content
POST
/
partners
/
{sellerId}
/
buyers
/
{buyerId}
/
kyc
/
self-service-invitations
Create a self-service KYC invitation (emailed link).
curl --request POST \
  --url https://api.novatrade24.com/v1/partners/{sellerId}/buyers/{buyerId}/kyc/self-service-invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "recipientEmail": "[email protected]",
  "expiresInDays": 30,
  "language": "en"
}
'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "publicLinkUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "recipientEmail": "[email protected]",
  "label": "<string>",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "usageCount": 123,
  "revokedAt": "2023-11-07T05:31:56Z",
  "revocationReason": "<string>"
}

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
​
publicLinkUrl
string<uri>
required
​
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