OpenAPI specification
Release: ActiveSingle operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
Loading, please wait…
Submit party onboarding request.
/ch/v1/party/onboardCreates or updates parties, submits KYB, KYC and Provisions final approved parties. KYB/KYC results are asynchronous; Register for webhook or poll /ch/v1/party/inquire for status.
Showing 6 of 6 top-level parameters (13 total fields) for Create party minimum
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.
transactionDetailsRequiredobjectThe transactionDetails field.
partyRequiredobjectParty data. CREATE requires type, country, email, and platform identifiers; UPDATE, REPLACE, and PROVISION require partyId. Additional completeness fields may be required before PROVISION.
Request
Create party minimumResponse
Continue with notifications
Explore the notification steps and callback examples for this request.
Top-level fields returned in a successful (201) response.
gatewayResponseobjectGateway response and transaction state. Use transactionId or apiTraceId to track asynchronous completion.
partyobjectParty data. CREATE requires type, country, email, and platform identifiers; UPDATE, REPLACE, and PROVISION require partyId. Additional completeness fields may be required before PROVISION.
requiredFieldViolationsarrayOutcome of the party validation during a provision process.
curl --request POST 'https://connect-cert.fiservapis.net/ch/v1/party/onboard' \
--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 '{
"transactionDetails": {
"operationType": "CREATE"
},
"party": {
"type": "BUSINESS",
"partyRole": "BUYER",
"country": "USA",
"email": "party@domain.com",
"platform": {
"merchantPartyId": "merchant-001"
}
}
}'| 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. |
| 422 | Unprocessable Entity. Returned when an OFAC screen rejects the party — either a HIT (matchresult=FAIL or hasHits=true; reasonCode=OFAC_HIT) or a HOLD (score at/above the configured threshold with no list hit; reasonCode=OFAC_SCORE_THRESHOLD_EXCEEDED). No party is created and no OFAC screening record is persisted. |
| 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.