Skip to main content

Get User by ID

Retrieves detailed information about a specific user by their ID.

Request

GET /v2/users/users/{user_id}

Parameters

NameTypeInDescription
user_idstringpathRequired. The ID of the user to retrieve

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication
User-AgentOptional. Client application identifier

Example

curl --request GET \
--url '\{\{baseUrl\}\}/v2/users/users/680c02896d91ca0145cfeb81' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'User-Agent: insomnia/11.5.0'

Response

A successful response returns the user information:

{
"id": "680c02896d91ca0145cfeb81",
"name": "Tom",
"surname": "Hardy",
"email": "user@apex.com",
"address": "0xa112983907944387b64ba512daf256b3f28f93f5",
"identity_number": "11111111111",
"kyc": {
"is_verified": true,
"token_sent": true,
"token_sent_at": "2025-04-25T21:53:47.356Z",
"token_tx_hash": "0xf42d9234c0b22da68cfe7bf22975cad881d219a711c72b39d6c9a741e0344b62"
}
}

Response Fields

FieldTypeDescription
idstringUnique identifier for the user
namestringUser's first name
surnamestringUser's last name
emailstringUser's email address
addressstringUser's blockchain wallet address
identity_numberstringUser's national identity number
kycobjectKnow Your Customer verification information
kyc.is_verifiedbooleanWhether KYC verification is completed
kyc.token_sentbooleanWhether verification token was sent
kyc.token_sent_atstringISO 8601 timestamp when token was sent
kyc.token_tx_hashstringBlockchain transaction hash for token verification

Status Codes

Status CodeDescription
200Success - User information retrieved successfully
400Bad Request - Invalid request parameters
401Unauthorized - Invalid or missing authentication token
404Not Found - User ID does not exist
500Internal Server Error