---
title: "Get Document Verification Link"
method: POST
path: "/api/v1/users/:userId/kyc/document-verification-link"
tags: ["Banking"]
---

# Get Document Verification Link

`POST /api/v1/users/:userId/kyc/document-verification-link`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/users/:userId/kyc/document-verification-link`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/users/:userId/kyc/document-verification-link/post.ts> (a function with typed inputs; its response is checked against the schema)

Generates a secure, time-limited link to document verification portal. Use this when a user's KYC status is 'AwaitingDocuments' and they need to upload identity documents (such as a driver's license or passport). The user should be redirected to the returned URL to complete the verification process.

## Path parameters

- `userId` string, uuid, required: The unique identifier for the user

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Request body

- object
  - `data` object, required
    - `type` 'DocumentVerificationLink', required
    - `attributes` object, required
      - `redirectUrl` string, uri, required: The URL to redirect the user to after they complete document verification

## Response `200`

Document verification link generated successfully. Redirect the user to the returned URL to complete identity document upload.

- GetDocumentVerificationLinkResponse
  - `data` DocumentVerificationLink, required: A secure link for users to complete document verification
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'DocumentVerificationLink', required
    - `attributes` object, required
      - `url` string, uri, required: The secure URL to document verification portal where users can upload identity documents
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)