GET/api/v2/users/{userId}

Get user by ID

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
userId (path)unknownYesUser ID

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
PhonestringNo
DateOfBirthstringNo
AddressstringNo
CitystringNo
StatestringNo
CountrystringNo
ZipCodestringNo
KycProviderstringNo
KycVerificationIdstringNo
KycVerificationDatestringNo
KycRejectionReasonstringNo
KycCompletedAtstringNo
SumsubTokenForTransakstringNo
LastKycSubmissionIdunknownNo
LastKycSumsubUserIdstringNo
LastKycProviderStatusstringNo
LastKycProviderApplicationIdstringNo
ReferralIdstringNo
IdunknownNo
ExternalUserIdstringNo
EmailstringNo
FirstNamestringNo
LastNamestringNo
StatusAccountStatusV2No
KycStatusKycStatusV2No
KycLevelKycLevelV2No
CreatedAtstringNo
UpdatedAtstringNo
CompanyIdunknownNo
PackageIdunknownNo
BusinessNamestringNo
BusinessExternalIdstringNo
BusinessParentIdunknownNo
AccountTypebusiness | personalNoAllowed values: business, personal.
PrimaryExternalWalletIdstringNo
SelectedTierIdunknownNo
TierBillingCyclestringNo
OnboardingProductPreferencestringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/users/{userId}" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.