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>"
}

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>"
}

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

Path parameters

partner_user_id

string

required

Your internal user identifier.

Authorization

string

required

Bearer token. Format: Bearer <client_token>.

partner_user_id

string

Your internal user identifier (echo of the request).

status

string

One of not_started, pending, verified, failed. See KYC.

Status	Meaning
`not_started`	The user has never opened the widget or has not submitted documents
`pending`	Documents submitted; under review
`verified`	Verification passed; the user can transact
`failed`	Verification failed; the user must retry inside the widget

curl https://DOMAIN/widget/users/user-123/kyc-status \
  -H "Authorization: Bearer <client_token>"

Response

{
  "partner_user_id": "user-123",
  "status": "verified"
}

HTTP	`error`	`code`	Cause
401	`unauthorised`	`invalid_token`	Missing or inactive `client_token`
404	`not_found`	`not_found`	The `partner_user_id` is unknown for your partner
502	`upstream_error`	`provider_error`	Verification service failed; retry