GET
/api/v2/users/{userId}Get user by ID
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | unknown | Yes | User ID |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Phone | string | No | |
| DateOfBirth | string | No | |
| Address | string | No | |
| City | string | No | |
| State | string | No | |
| Country | string | No | |
| ZipCode | string | No | |
| ExpectedMonthlyVolume | string | No | Recognized expected monthly account volume band from the latest onboarding submission. This is a declared account-use preference, not actual spending, income, or a travel budget. Unknown and legacy free-text values are omitted. |
| KycProvider | string | No | |
| KycVerificationId | string | No | |
| KycVerificationDate | string | No | |
| KycRejectionReason | string | No | |
| KycCompletedAt | string | No | |
| SumsubTokenForTransak | string | No | |
| LastKycSubmissionId | unknown | No | |
| LastKycSumsubUserId | string | No | |
| LastKycProviderStatus | string | No | |
| LastKycProviderApplicationId | string | No | |
| ReferralId | string | No | |
| ReferralAccepted | boolean | No | Whether the user accepted their referral attribution at registration (null when no referral relationship exists). |
| ReferralTermsVersion | unknown | No | |
| Id | unknown | No | |
| ExternalUserId | string | No | |
| string | No | ||
| FirstName | string | No | |
| LastName | string | No | |
| Status | AccountStatusV2 | No | User account lifecycle status. Possible values: PENDING, ACTIVE, SUSPENDED, BLOCKED, DELETED. |
| KycStatus | KycStatusV2 | No | Platform KYC lifecycle status. Possible values: NOT_STARTED, PENDING, APPROVED, REJECTED, RETRY, INITIATED, SUBMITTED. |
| KycLevel | KycLevelV2 | No | |
| CreatedAt | string | No | |
| UpdatedAt | string | No | |
| CompanyId | unknown | No | |
| PackageId | unknown | No | |
| BusinessName | string | No | |
| BusinessExternalId | string | No | |
| BusinessParentId | unknown | No | |
| AccountType | business | personal | No | Allowed values: business, personal. |
| PrimaryExternalWalletId | string | No | |
| SelectedTierId | unknown | No | |
| TierBillingCycle | string | No | |
| OnboardingProductPreference | string | No | |
| ReferralAttribution | object | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
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.