Skip to content

checkKYCStatus(claim_id)

Purpose

Returns the current verification status of a user’s KYC submission.
Used to drive frontend updates and determine when payouts can proceed.


Endpoint

GET /api/check-kyc-status/{claim_id}


Authorization

  • Required Scope: user.verify
  • Token: Bearer Token from user session

Parameters

Name Type Required Description
claim_id string The unique claim identifier for a submitted high-value win

Response: Success (200 OK)

{
  "claim_id": "claim_001",
  "status": "approved",
  "approved_at": "2025-06-27T09:45:00Z"
}

Status Values

Value Meaning
pending Documents submitted, awaiting review
approved KYC verified, payout can proceed
rejected Failed verification; needs resubmit
expired Docs timed out, submission invalidated

Error States

HTTP Code Error Key Description
404 claim_not_found No matching KYC submission found
403 unauthorized Claim ID does not belong to user

Integration Notes

  • This endpoint may be polled in frontend apps or called on login/session restore.
  • Once approved, user should be redirected to fulfillHighValuePlay() to complete custody.
  • Rejections should surface a resubmit CTA with document hints if available.
  • Repeated failures or expired attempts may trigger customer service alerts.