BYbyaccrue
Banking

Get Document Verification Link

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.

post/api/v1/users/:userId/kyc/document-verification-link

Request

Path parameters

userIdstring uuid required

The unique identifier for the user

Example:550e8400-e29b-41d4-a716-446655440000

Headers

Client-IDstring 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.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "redirectUrl": "https://example.com/kyc/callback"
    }
  }
}

Response

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

Example response

{
  "data": {
    "attributes": {
      "url": "https://verify.sardine.ai/session/abc123xyz"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.