WakaPay Docs

API Reference

KYC

← All tags

Purpose

KYC endpoints support identity verification workflows and any related storage/asset management.

When to use

  • Use these when regulatory checks are required before payout or activation.
  • Do not expose admin/KYC APIs directly to browsers.

Endpoints (9)

Click an endpoint to jump to its details.

get/kyc/documents
Auth

Get all KYC documents for current user

patch/kyc/documents/{documentId}
Auth

Update KYC document status (Admin only)

get/kyc/documents/{documentId}/signed-url
Auth

Get a signed URL for a KYC document (Admin only)

get/kyc/limits
Auth

Get transaction limits and current usage based on KYC level

get/kyc/status
Auth

Get current user KYC status

get/kyc/status/{userId}
Auth

Get user KYC status (Admin only)

patch/kyc/status/{userId}
Auth

Update user KYC status (Admin only)

post/kyc/submit
Auth

Submit KYC documents via URL (legacy method)

post/kyc/submit/file
Auth

Upload and submit KYC document file for verification

get/kyc/documents

Get all KYC documents for current user

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_getUserDocumentstag: KYCpermalink
patch/kyc/documents/{documentId}

Update KYC document status (Admin only)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_updateDocumentStatustag: KYCpermalink
get/kyc/documents/{documentId}/signed-url

Get a signed URL for a KYC document (Admin only)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_getDocumentSignedUrltag: KYCpermalink
get/kyc/limits

Get transaction limits and current usage based on KYC level

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_getTransactionLimitstag: KYCpermalink
get/kyc/status

Get current user KYC status

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_getKYCStatustag: KYCpermalink
get/kyc/status/{userId}

Get user KYC status (Admin only)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_getKYCStatusByUserIdtag: KYCpermalink
patch/kyc/status/{userId}

Update user KYC status (Admin only)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_updateKYCStatustag: KYCpermalink
post/kyc/submit

Submit KYC documents via URL (legacy method)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_submitKYCtag: KYCpermalink
post/kyc/submit/file

Upload and submit KYC document file for verification

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: KYCController_submitKYCFiletag: KYCpermalink