abf2adee265f
OpenAPI 3.0.42026-08-042281222.0 KBClients
Withdraw an attributed client
Withdraws a client that never completed onboarding. Archives the referral partner link and closes all pending cases with close code CaseNeverStartedInternal.
The same externalTenantId can be re-submitted via POST /clients after withdrawal.
Path Parameter
- externalTenantId - Your internal identifier for the client
Business Rules
- Only attributed clients (IsAttributedClient = true) can be withdrawn
- All cases for this client must be in PendingContractSigning status
What Happens
- The referral partner client link is archived
- All pending cases are closed with close code CaseNeverStartedInternal
After Withdrawal
- The same externalTenantId can be re-submitted via POST /clients
- A new client record will be created on re-submission
Error Cases
- 404 Not Found - No active client link exists for this externalTenantId and your partner account
- 409 Conflict - Client cannot be withdrawn because:
- IsAttributedClient = false (non-attributed clients cannot be withdrawn)
- One or more cases have progressed beyond PendingContractSigning
post/clients/{externalTenantId}/withdraw
Path parameters
externalTenantIdstring required
Response
Client withdrawn successfully