Skip to main content
GET
/
widget
/
users
/
{partner_user_id}
/
kyc-status
GET /widget/users/{id}/kyc-status
curl --request GET \
  --url https://domain/widget/users/{partner_user_id}/kyc-status \
  --header 'Authorization: <authorization>'
{
  "partner_user_id": "<string>",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.proof.community/llms.txt

Use this file to discover all available pages before exploring further.

Returns the identity-verification status for one of your users.

​
Path parameters

​
partner_user_id
string
required
Your internal user identifier.

​
Headers

​
Authorization
string
required
Bearer token. Format: Bearer <client_token>.

​
Response

​
partner_user_id
string
Your internal user identifier (echo of the request).
​
status
string
One of not_started, pending, verified, failed. See KYC.

​
Statuses

StatusMeaning
not_startedThe user has never opened the widget or has not submitted documents
pendingDocuments submitted; under review
verifiedVerification passed; the user can transact
failedVerification failed; the user must retry inside the widget

​
Examples

curl https://DOMAIN/widget/users/user-123/kyc-status \
  -H "Authorization: Bearer <client_token>"
Response
{
  "partner_user_id": "user-123",
  "status": "verified"
}

​
Errors

HTTPerrorcodeCause
401unauthorisedinvalid_tokenMissing or inactive client_token
404not_foundnot_foundThe partner_user_id is unknown for your partner
502upstream_errorprovider_errorVerification service failed; retry