Get a specific user

GET

/business/user-management/users/{userUuid}

• production API Server

Returns detailed information about a specific user.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

userUuid

required

string format: uuid

UUID of the user to retrieve

Responses

200

Successful operation

object

user

object

uuid

Unique identifier for the user

string format: uuid

66c9c977-f379-4692-9d5c-f989c17543ee

institution_id

ID of the institution this user belongs to

integer

3

first_name

First name of the user

string

Faizan

last_name

Last name of the user

string

Ali

email

Email address of the user

string format: email

faizananwer2011@gmail.com

email_verification_status

Email verification status

string

Allowed values: verified unverified

verified

email_verified_at

When the email was verified

string format: date-time

nullable

2025-02-03T12:54:19.000000Z

phone

Phone number of the user

string

+971569158359

phone_verification_status

Phone verification status

string

Allowed values: verified unverified

verified

phone_verified_at

When the phone was verified

string format: date-time

nullable

2025-02-03T11:47:51.000000Z

is_archived

Whether the user is archived

boolean

has_signature

Whether the user has a signature

boolean

true

signature

URL to the user’s signature image

string format: uri

nullable

https://api.vec.digital/storage/signatures/75fd0390-099a-47bc-963e-e3be09ab2c2b.png

signature_added_at

When the signature was added

string format: date-time

nullable

2025-03-13T14:05:28.000000Z

signatory_name

Name to use when signing certificates

string

nullable

Faizan Ali

signatory_designation

Designation/role to use when signing certificates

string

nullable

Software Developer

avatar

URL to the user’s avatar

string format: uri

https://api.vec.digital/storage/avatars/avatar_67765e0c784a00.82650762.png

setup_status

Setup status of the user

string

Allowed values: pending completed

completed

created_at

Creation timestamp

string format: date-time

2024-10-16T19:15:50.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-13T14:05:28.000000Z

institution

object

id

Unique identifier for the institution

integer

3

name

Name of the institution

string

ABC University

logo

URL to the institution’s logo

string format: uri

nullable

https://api.vec.digital/storage/institutions/logos/abc_university.png

is_verified

Whether the institution is verified

boolean

true

status

Status of the institution

string

Allowed values: active suspended pending

active

created_at

Creation timestamp

string format: date-time

2024-10-16T19:15:50.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-13T14:05:28.000000Z

user_management_roles

User management roles

Array<object>

object

id

Unique identifier for the role

integer

1

name

Name of the role

string

Administrator

description

Description of the role

string

nullable

Full administrative access

created_at

Creation timestamp

string format: date-time

2024-10-16T19:15:50.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-13T14:05:28.000000Z

permissions

Permissions assigned to this role

Array<object>

object

id

Unique identifier for the permission

integer

1

name

Permission identifier

string

certificate-templates:list

display_name

Human-readable permission name

string

List Certificate Templates

description

Description of the permission

string

nullable

Allows viewing the list of certificate templates

401

Authentication failed

object

message

Error message

string

Unauthorized - Invalid API token

403

Permission denied

object

message

Error message

string

Forbidden - Insufficient permissions

required_permission

Required permission to access this resource

string

batches:view

404

Resource not found

object

message

Error message

string

The requested ID 9d3a6b04-c4e5-485f-b945-8f1fd66396ce was not found.

error

Error code

string

resource_not_found

500

Server error

object

message

Error message

string

An unexpected error occurred. Our team has been notified.

error_code

Error code

string

SERVER_ERROR