OpenAPI specification
Release: ActiveSingle operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
Loading, please wait…
Upload party document.
/ch/v1/party/document-uploadUse this API to upload KYC/KYB documents. Authenticate the multipart request with CommerceHub HMAC.
Showing 12 of 12 top-level parameters (12 total fields) for Upload KYC document
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.
fileRequiredstringDocument binary. Runtime clients use PDF, JPEG, or PNG; the configured gateway limit is 10 MiB.
partyIdRequiredstringThe ID of the party for whom the evaluation was triggered
documentTypeRequiredstringMRD document code identifying the document being uploaded, e.g. MRD-KYB-007 (KYB business documents) or MRD-KYC-001 (KYC identity documents). MRD-KYC-000 is the liveness document (KYC only).
docContextRequiredstringDocument slot (front, back, live, multipage) or the legacy descriptive context accepted by CommerceHub, for example "KYC identity document (MRD-KYC-001)".
documentNameRequiredstringHuman-readable name of the document type/code being uploaded (e.g. "Certificate of Registration or equivalent").
actionIdRequiredstringUPLOAD_DOCUMENT action identifier returned by inquiryType=ERRORS.
processstringThe process field.
Available enum values
Selecting a value updates the request body.
operationTypestringThe operationType field.
Available enum values
Selecting a value updates the request body.
Request
Upload KYC documentResponse
Top-level fields returned in a successful (201) response.
gatewayResponseobjectGateway response and transaction state. Use transactionId or apiTraceId to track asynchronous completion.
partyIdstringThe ID of the party for whom the evaluation was triggered
documentDetailsobjectThe documentDetails field.
pendingBoardingStepsarrayList of steps or actions that are still required to be completed in order to complete a party boarding process.
curl --request POST 'https://connect-cert.fiservapis.net/ch/v1/party/document-upload' \
--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' \
--form-string 'partyId=100000000010001' \
--form-string 'actionId=<action-id>' \
--form-string 'documentType=MRD-KYC-001' \
--form-string 'documentName=Driver'"'"'s License' \
--form-string 'docContext=front' \
--form-string 'process=KYC' \
--form-string 'operationType=DOCUMENT_UPLOAD' \
--form 'file=@/path/to/document.pdf'| 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.