OpenAPI specification
Release: ActiveSingle operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
Loading, please wait…
Delete party document reference.
/ch/v1/party/document-deleteClears stored document references for a document type on a party's KYB/KYC step. This cannot be used after documents have been submitted for evaluation.
Showing 9 of 9 top-level parameters (9 total fields) for Clear all document slots
Client-Request-IdRequiredstringheaderUnique request correlation identifier used in HMAC signing.
TimestampRequiredstringheaderUnix epoch timestamp in milliseconds used in HMAC signing.
Auth-Token-TypeRequiredstringheaderAuthentication mechanism used by the request.
Available enum values
Selecting a value updates the request header.
AuthorizationRequiredstringheaderBase64 HMAC-SHA-256 signature; no prefix.
partyIdRequiredstringThe ID of the party that owns the KYB/KYC boarding step.
processRequiredstringBoarding step selector determining which step's document slots are cleared. Case-insensitive.
Available enum values
Selecting a value updates the request body.
documentTypeRequiredstringMRD document code whose documentId slot(s) will be cleared, e.g. MRD-KYC-001. Case-sensitive. Must be a valid MRD document code that is currently requested on the party's boarding step (i.e. previously surfaced by the Document Upload flow). The legacy JSON key documentCode is also accepted as an alias.
documentNameRequiredstringHuman-readable document name. Must match the canonical label mapped to the provided documentType (e.g. MRD-KYC-001 maps to "Driver's License"). Comparison is case-insensitive.
docContextRequiredstringThe document slot to clear. front - clear only the front documentId associated with the documentType. back - clear only the back documentId. multipage - clear only the multipage documentId. live - clear only the live documentId (allowed only for the liveness document MRD-KYC-000). all - clear every documentId slot associated with the documentType.
Available enum values
Selecting a value updates the request body.
Request
Clear all document slotsResponse
Top-level fields returned in a successful (200) response.
partyIdstringThe ID of the party whose boarding step was updated.
processstringBoarding step selector echoed from the request.
Available enum values
KYBKnow Your Business verification process.KYCKnow Your Customer verification process.documentTypestringMRD document code whose slot(s) were cleared.
documentNamestringHuman-readable document name echoed from the request.
docContextstringSlot selector echoed from the request.
Available enum values
frontFront side of document image.backBack or reverse side of document.multipageMulti-page document with multiple sheets.liveLive photograph or liveness verification.allAll document images for the type.statusstringOutcome of the operation. DELETED on success.
clearedSlotsarrayThe slot keys that were emptied, using the request vocabulary (front / back / multipage / live).
messagestringHuman-readable summary of the operation.
boardingStepobjectThe refreshed KYB/KYC boarding step with the cleared slots.
curl --request POST 'https://connect-cert.fiservapis.net/ch/v1/party/document-delete' \
--header 'Client-Request-Id: <Client-Request-Id>' \
--header 'Timestamp: <Timestamp>' \
--header 'Auth-Token-Type: HMAC' \
--header 'Authorization: YOUR_BASE64_HMAC_SIGNATURE' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"partyId": "101628000012860",
"process": "KYC",
"documentType": "MRD-KYC-001",
"documentName": "Driver'"'"'s License",
"docContext": "all"
}'| HTTP | Description |
|---|---|
| 400 | The request is invalid. |
| 401 | Authentication failed or credentials are missing. |
| 404 | The requested resource was not found. |
| 408 | The request timed out. |
| 415 | The request media type is unsupported. |
| 425 | The request was sent too early. |
| 429 | The request rate limit was exceeded. |
| 500 | An unexpected server error occurred. |
| 503 | The service is temporarily unavailable. |
| 504 | The upstream service timed out. |
Single operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
No Postman workflow is mapped to this operation. No product-wide collection is substituted.
QA collections: Configure your environment and credentials before running. Some requests create resources or move funds.