Get Kyc Status

Get user KYC status

Returns the full verification state for a specific user, including KYC status,
verification mode, external verification details, and the latest verification link.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the full verification state for a single user that belongs to the authenticated client. The response includes the user's KYC status, verification mode, external attestation details, the source that granted verified status, and the most recently generated identity verification link with its generation and expiry timestamps. This is a read-only lookup with no side effects.

Authentication & access

  • Requires a Bearer token in the Authorization header.
  • API credentials must carry the kyc.users.read permission.
  • Dashboard sessions must hold one of the following roles: owner, developer, operations.

Path parameters

  • user_id (string, required) - the ID of the user to look up. The user must belong to the authenticated client; users owned by other clients are treated as not found.

Response

200 OK returns a UserKYCStatusResponse:

  • id, email, full_name, created_at, is_active - core user fields.
  • kyc_status - one of none, pending, approved, rejected, on_hold.
  • verification_mode - one of urbanpayx_kyc, urbanpayx_kyb, external_attestation.
  • external_verification_status - one of pending, verified, rejected; relevant when verification_mode is external_attestation.
  • verification_source - one of none, urbanpayx, external; identifies what granted the user's verified status.
  • external_verification_provider, external_verification_ref, external_verified_at - external attestation details, populated when verification was applied externally.
  • latest_kyc_verification_url, latest_kyc_verification_url_generated_at, latest_kyc_verification_url_expires_at - the most recently generated identity verification link and its timestamps.

Error responses

StatusWhen
404No user with the given user_id exists for the authenticated client.

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json