Commerce Hub

/

Delete Document

Delete party document reference.

Endpoint

POST/ch/v1/party/document-delete

Clears 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.

Request Parameters

Context:

Use case:

Showing 5 of 5 top-level parameters (5 total fields) for Clear all document slots

partyIdRequiredstring
The ID of the party that owns the KYB/KYC boarding step.
processRequiredstring
Boarding step selector determining which step's document slots are cleared. Case-insensitive.
Available enum values
Selecting a value updates the request body.
- Know Your Business verification process.
- Know Your Customer verification process.
documentTypeRequiredstring
MRD 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.
documentNameRequiredstring
Human-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.
docContextRequiredstring
The 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.
- Front side of document image.
- Back or reverse side of document.
- Multi-page document with multiple sheets.
- Live photograph or liveness verification.
- All document images for the type.

Request

Clear all document slots

Simulate

Response

Click Send Request to see the API response

Code Examples

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"
}'

Error Codes

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.

Download & explore

Back to API spec

OpenAPI specification

Release: Active

Single operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.

Postman workflow

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.

Explore Platforms Downloads →