# KYC reviewer version actions Source: https://docs.settlemint.com/docs/api-reference/compliance/kyc-reviewer-version-actions Approve, reject, or request changes on a KYC profile version under review through the DALP Platform API, SDK, and CLI. A reviewer decides the outcome of a KYC profile version that is under review. Three decisions are available: approve the version, reject it, or request changes from the user. Each decision is a single Platform API call against the version ID and returns the updated review metadata. These endpoints operate only on a version whose status is `under_review`. Submit a draft version for review first, then call one of the endpoints below. For the operator walkthrough in the Console, see [Manage KYC data](/docs/operators/compliance/manage-kyc-data). ## Prerequisites [#prerequisites] * The caller holds the `claimIssuer` or `identityManager` system role. * The target version status is `under_review`. The caller cannot review a draft, approved, or rejected version. ## Choose a review decision [#choose-a-review-decision] | Decision | SDK method | Use when | | -------------- | -------------------------------- | ------------------------------------------------------ | | Approve | `user.kyc.version.approve` | The data and documents meet your requirements. | | Reject | `user.kyc.version.reject` | The platform cannot accept the submission as provided. | | Request update | `user.kyc.version.requestUpdate` | The submission needs specific missing or changed data. | Direct HTTP integrations use these routes: * Approve: `POST /api/v2/kyc-profile-versions/{versionId}/approvals`. * Reject: `POST /api/v2/kyc-profile-versions/{versionId}/rejections`. * Request update: `POST /api/v2/kyc-profile-versions/{versionId}/update-requests`. ## Approve a version [#approve-a-version] Approving moves the version to `approved` and points the user's KYC profile at that version. DALP records the review outcome, review timestamp, and reviewer, syncs the approved name fields on the profile, and closes any open pending requests for that user's KYC profile. ```ts fixture=dalp-client group=kyc-reviewer-version-actions const approved = await client.user.kyc.version.approve({ params: { versionId: "kycv_01hzt7n4submittedversion" }, body: { reviewNotes: "ID and proof of address verified against the form fields.", }, }); ``` `reviewNotes` is optional. Depending on your organization's configuration these notes may be visible to the user, so keep internal-only detail out of them. ```json { "data": { "id": "kycv_01hzt7n4submittedversion", "status": "approved", "reviewOutcome": "approved", "reviewedAt": "2026-05-24T10:23:17.628Z", "reviewedBy": "usr_01hzt7n4reviewer001", "reviewNotes": "ID and proof of address verified against the form fields." } } ``` After approval, issue the on-chain KYC verification. See [Verify KYC](/docs/operators/compliance/verify-kyc). ## Reject a version [#reject-a-version] Rejecting moves the version to `rejected` and records the rejection reason, reviewer, and review timestamp. The rejection reason is shown to the user, so state clearly what was wrong. If the user already has a previously approved version, that approved version stays active; otherwise the profile returns to incomplete. ```ts group=kyc-reviewer-version-actions const rejected = await client.user.kyc.version.reject({ params: { versionId: "kycv_01hzt7n4submittedversion" }, body: { rejectionReason: "Proof of address document is expired. Upload a statement from the last 3 months.", reviewNotes: "Utility bill dated 14 months ago.", }, }); ``` `rejectionReason` requires at least 10 characters. `reviewNotes` is optional internal context. ```json { "data": { "id": "kycv_01hzt7n4submittedversion", "status": "rejected", "reviewOutcome": "rejected", "rejectionReason": "Proof of address document is expired. Upload a statement from the last 3 months.", "reviewedAt": "2026-05-24T10:25:02.114Z", "reviewedBy": "usr_01hzt7n4reviewer001" } } ``` ## Request an update [#request-an-update] Requesting an update keeps the version `under_review` with a review outcome of `changes_requested`, creates an open change request for the user, and marks the profile as needing an update. DALP creates the draft the user edits when they open the update flow, not from this call. ```ts group=kyc-reviewer-version-actions const updateRequest = await client.user.kyc.version.requestUpdate({ params: { versionId: "kycv_01hzt7n4submittedversion" }, body: { reason: "Add a proof of address document from the last 3 months.", requiredFields: ["proof_of_address"], dueAt: "2026-06-01T00:00:00.000Z", }, }); ``` `reason` requires at least 10 characters. `requiredFields` and `dueAt` are optional. `reviewNotes` is optional; when omitted, DALP uses the `reason` as the review note. ```json { "data": { "version": { "id": "kycv_01hzt7n4submittedversion", "status": "under_review" }, "actionRequest": { "id": "kycar_01hzt7n4openrequest001", "status": "open", "reason": "Add a proof of address document from the last 3 months.", "requiredFields": ["proof_of_address"], "dueAt": "2026-06-01T00:00:00.000Z", "requestedAt": "2026-05-24T10:26:40.902Z" } } } ``` ## State transitions [#state-transitions] | Decision | From | To | Side effect | | -------------- | -------------- | -------------------------------------------- | --------------------------------------------------------------------------- | | Approve | `under_review` | `approved` | Profile points at the version; DALP fulfills open pending requests. | | Reject | `under_review` | `rejected` | Profile stays approved if a prior approved version exists, else incomplete. | | Request update | `under_review` | `under_review` (outcome `changes_requested`) | DALP creates an open change request; the profile needs user attention. | ## CLI equivalents [#cli-equivalents] The DALP CLI exposes the same reviewer decisions for operator scripts. Use these commands when a back-office job is easier to run outside the SDK: | Task | CLI command | | -------------- | ---------------------------- | | Approve | `kyc version-approve` | | Reject | `kyc version-reject` | | Request update | `kyc version-request-update` | ## Validation and error handling [#validation-and-error-handling] Treat reviewer errors as terminal request errors unless the response says otherwise. Confirm the version status and your reviewer role before retrying. Store the request ID from the API response when you escalate a repeated platform error. | Error | What DALP observed | Caller response | | ----------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `DALP-0388` | Approve targeted a missing version or a version outside `under_review`. | No change is made. Confirm the version ID and that the version is under review. | | `DALP-0390` | Reject targeted a missing version or a version outside `under_review`. | No change is made. Confirm the version ID and that the version is under review. | | `DALP-0415` | Request update targeted a version outside `under_review`. | No change is made. Only an under-review version accepts change requests. | | `DALP-0419` | The version ID does not match a KYC version. | No change is made. Confirm the version ID. | ## Related [#related] * [Manage KYC data](/docs/operators/compliance/manage-kyc-data) * [KYC document uploads](/docs/api-reference/compliance/kyc-document-uploads) * [Verify KYC](/docs/operators/compliance/verify-kyc) * [Platform API error reference](/docs/api-reference/errors/platform-api-error-reference)