1. Verifications
Kobble
  • Introduction
  • API Fundamentals
    • Idempotency
    • Rate Limits
    • Healthcheck
      GET
  • Authorization
    • Authorization
    • Get access token
      POST
  • Beneficiaries
    • List all beneficiaries
      GET
    • Get beneficiary by ID
      GET
    • Create beneficiary
      POST
    • Create Payid beneficiary
      POST
    • Update beneficiary
      PATCH
  • Cards
    • Cards API
    • Card Creation Flow — Developer Guide & Onboarding
    • Get all cards
      GET
    • Create a new card
      POST
    • Get card by ID
      GET
    • Update card status
      PATCH
    • Replace or renew card
      POST
    • Generate card secret
      POST
    • Generate MeaWallet widget session token
      POST
  • Card Programs
    • Card Programs API
    • Get all programs
    • Create a new program
    • Get program by ID
  • Clients
    • Clients API
    • Get all clients
    • Get client by ID
    • Create a new client
    • Update client status
  • Endusers
    • Endusers API
    • Usage of Metadata on Endusers
    • Get all endusers
    • Create a new enduser
    • Get enduser by ID
    • Update enduser
    • Create a stakeholder
    • List stakeholders
    • Update stakeholder
  • Transactions
    • Transactions API
    • Get all transactions
    • Create a transaction
    • Get transaction by ID
    • Create manual credit transaction
    • Create manual debit transaction
    • Download the partner's confirmation letter for a `_4` transaction
  • Wallets
    • Wallets API
    • Get all wallets
    • Create a new wallet
    • Get wallet by ID
    • Update wallet
    • Download the partner's confirmation letter for a `_4` wallet
  • Relays
    • Relays API
    • Create subscription
  • Webhooks
    • Webhooks API
    • Webhook Signature Verification
    • Create a webhook
    • Report completed
    • Get all webhooks
    • Delete a webhook
  • Wallet Statements
    • Request a wallet statement
    • List wallet statements
    • Get a wallet statement
    • Get a wallet statement download URL
  • Card Art
    • Get a card art upload URL
    • Register a card art
    • List card arts
    • Get a card art
    • Update a card art
    • Activate a card art
    • Archive a card art
  • Verifications
    • List verifications for a subject
      GET
    • Create a verification
      POST
    • Get verification by ID
      GET
    • Get a verification session (SDK token or hosted link)
      GET
    • Record a client-asserted outcome
      POST
    • Email a KYB party its hosted verification link
      POST
    • Set a KYB party's USD details
      PATCH
    • Project the company's declared owners into KYB parties
      POST
  • Transaction Documents
    • Request a presigned upload for a supporting document
    • List the supporting documents on a transaction
  • Mandates
    • List mandates
    • Create mandate
    • Get mandate by ID
    • Update mandate
  • FX Quotes
    • Request an FX quote
    • Get an FX quote by ID
  • Schemas
    • Schemas
    • CardWidgetSessionTokenResponse
    • 202 Accepted
    • Webhook
    • 201 Created
    • Relay
    • Create Beneficiary with bank details
    • Client
    • Beneficiary
    • Card
    • CardCreateInputDto
    • CardStatusUpdateDto
    • CardRenewReplaceInputDto
    • Program
    • MetadataKobbleDebit1
    • ProgramCreateInputDto
    • Person
    • Company
    • Enduser
    • Enduser Create Person Input
    • Enduser Create Company Input
    • Metadata
    • Enduser Create Input DTO
    • Transaction
    • TransactionCreateManualCreditInputDto
    • TransactionDocumentType
    • TransactionDocumentStatus
    • TransactionDocumentCreateInput
    • WalletUpdateInputDto
    • TransactionDocumentUpload
    • WalletStatement
    • TransactionDocument
    • TransactionCreateInputDto
    • ReportCompletedEntity
    • Mandate
    • Wallet
    • ReportCompletedNotification
    • WalletCreateInputDto
    • CardArt
    • CardArtDetail
    • WebhookNotification
    • CardArtUploadUrlInput
    • CardArtUploadUrlResponse
    • CardArtCreateInput
    • CardArtPatchInput
    • Error
    • RelayCreateResponse
    • ScreeningSummary
    • VerificationPartyLink
    • Verification
    • VerificationSessionToken
    • Address
    • Stakeholder
    • StakeholderCreateInput
    • StakeholderUpdateInput
    • VerificationPartyInviteResult
    • FxQuoteCreateInputDto
    • FxQuote
  1. Verifications

Email a KYB party its hosted verification link

POST
/customers/v1/verifications/{companyId}/parties/{partyId}/invite
Optional (on request). Applies only if this feature is enabled for your client.
Send an owner or officer of a KOBBLE_KYB_2 company — discovered by the partner from the company registry (links_from[].source PARTNER), or declared by you and projected with POST /customers/v1/verifications/{companyId}/parties/declared (source CUSTOMER) — its hosted verification link by email, so the party can complete identity verification without the company relaying a URL. companyId is the company verification and partyId one of its links_from[].party_id; both must belong to the calling client, otherwise 404 Party link not found.
Kobble mints a fresh hosted link for the party (the same link GET /verifications/{partyId}/session-token would return), emails it, and records the invite on the party link (invited_email masked, invited_at, invite_count on the company's links_from). A NOT_STARTED party moves to PENDING.
The email. Plain text, sent from Kobble on behalf of the company. It greets the party by its registry display_name, explains that the named company has asked them to verify their identity as one of its owners or officers as part of its business verification, carries the secure link, states that the link expires in 7 days, and — when message is supplied — quotes your message verbatim, attributed to the company. It closes by noting the address is not monitored. No ownership figure, address, date of birth or partner reference is included.
Cooldown and re-issue. One invite per party per 10 minutes: a second call inside the window is a 409 INVITE_RATE_LIMITED with error.context.retry_after_seconds. A call after the cooldown (e.g. to a corrected address, or because the 7-day link lapsed) issues a brand-new link and sends a fresh email; earlier links for the party are superseded.
Not invitable. 409 PARTY_NOT_INVITABLE when the party is on a _1 product (verified inside the company's SDK flow), when the partner has not yet created an applicant for it (the ownership graph is still being fetched), or when the party is already APPROVED / REJECTED / CANCELLED. The same conditions make the party's session-token call a 400 with the same reason.
Requires the client/write scope. Owner-scoped.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "email": "jane.citizen@example.com",
    "message": "Hi Jane — please complete this before Friday so we can open the business account. Call Sam on 0400 000 000 with any questions."
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/customers/v1/verifications//parties//invite' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "jane.citizen@example.com",
    "message": "Hi Jane — please complete this before Friday so we can open the business account. Call Sam on 0400 000 000 with any questions."
}'

Responses

🟢200OK
application/json
Invite sent.
Bodyapplication/json

Example
{
    "sent_to": "jane.citizen@example.com",
    "sent_at": "2026-09-21T03:12:44.000Z",
    "verification_url": "https://verify.kobble.net/verification/def456"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409
Modified at 2026-11-13 07:19:25
Previous
Record a client-asserted outcome
Next
Set a KYB party's USD details
Built with