Authenticating
This chapter describes the process of authentication by API.
You can see this process for UI using the link to the User Guide below:
Authentication Guide
Confirm code
/api/v2/auth/identity/users/password/confirm_code
POST
Description
Sets new account password
Parameters
Responses
/api/v2/auth/identity/users/password/generate_code
POST
Description
Send password reset instructions
Parameters
Responses
/api/v2/auth/identity/users/email/confirm_code
POST
Description
Confirms an account
Parameters
Responses
/api/v2/auth/identity/users/email/generate_code
POST
Description
Send confirmations instructions
Parameters
Responses
/api/v2/auth/identity/users/register_geetest
GET
Description
Register Geetest captcha
Responses
/api/v2/auth/identity/users
POST
Description
Creates new user
Parameters
Responses
/api/v2/auth/identity/users/access
POST
Description
Creates new whitelist restriction
Parameters
Responses
/api/v2/auth/identity/sessions/auth0
POST
Description
Auth0 authentication by id_token
Parameters
Responses
/api/v2/auth/identity/sessions
DELETE
Description
Destroy current session
Responses
POST
Description
Start a new session
Parameters
Responses
/api/v2/auth/identity/configs
GET
Description
Get auth configurations
Responses
/api/v2/auth/identity/version
GET
Description
Get auth version
Responses
/api/v2/auth/identity/time
GET
Description
Get server current unix timestamp.
Responses
/api/v2/auth/identity/ping
GET
Description
Test connectivity
Responses
/api/v2/auth/identity/password/validate
POST
Description
Password strength testing
Parameters
Responses
/api/v2/auth/resource/swagger_doc/{name}
GET
Description
Swagger compatible API description for specific API
Parameters
Responses
/api/v2/auth/resource/swagger_doc
GET
Description
Swagger compatible API description
Responses
/api/v2/auth/resource/service_accounts/api_keys/{kid}
PUT
Description
Updates an api key
Parameters
Responses
DELETE
Description
Delete an api key for specific service account
Parameters
Responses
/api/v2/auth/resource/service_accounts/api_keys
POST
Description
Create api key for specific service account.
Parameters
Responses
GET
Description
List all api keys for specific service account.
Parameters
Responses
/api/v2/auth/resource/service_accounts
GET
Description
List all service accounts for current user.
Responses
Security
/api/v2/auth/resource/data_storage
POST
Description
Create data storage
Parameters
Responses
/api/v2/auth/resource/api_keys
GET
Description
List all api keys for current account.
Parameters
Responses
POST
Description
Create an api key
Parameters
Responses
/api/v2/auth/resource/api_keys/{kid}
DELETE
Description
Delete an api key
Parameters
Responses
PATCH
Description
Updates an api key
Parameters
Responses
/api/v2/auth/resource/otp/verify
POST
Description
Verify 2FA code
Parameters
Responses
/api/v2/auth/resource/otp/disable
POST
Description
Disable 2FA
Parameters
Responses
/api/v2/auth/resource/otp/enable
POST
Description
Enable 2FA
Parameters
Responses
/api/v2/auth/resource/otp/generate_qrcode
POST
Description
Generate qr code for 2FA
Responses
/api/v2/auth/resource/phones/verify
POST
Description
Verify a phone
Parameters
Responses
/api/v2/auth/resource/phones/send_code
POST
Description
Resend activation code
Parameters
Responses
/api/v2/auth/resource/phones
POST
Description
Add new phone
Parameters
Responses
GET
Description
Returns list of user's phones
Responses
/api/v2/auth/resource/documents
POST
Description
Upload a new document for current user
Parameters
Responses
GET
Description
Return current user documents list
Responses
/api/v2/auth/resource/profiles
PUT
Description
Update a profile for current_user
Parameters
Responses
POST
Description
Create a profile for current_user
Parameters
Responses
/api/v2/auth/resource/profiles/me
GET
Description
Return profiles of current resource owner
Responses
/api/v2/auth/resource/labels/{key}
DELETE
Description
Delete a label with 'public' scope.
Parameters
Responses
PATCH
Description
Update a label with 'public' scope.
Parameters
Responses
GET
Description
Return a label by key.
Parameters
Responses
/api/v2/auth/resource/labels
POST
Description
Create a label with 'public' scope.
Parameters
Responses
GET
Description
List all labels for current user.
Parameters
Responses
/api/v2/auth/resource/users/password
PUT
Description
Sets new account password
Parameters
Responses
/api/v2/auth/resource/users/activity/{topic}
GET
Description
Returns user activity
Parameters
Responses
/api/v2/auth/resource/users/me
DELETE
Description
Blocks current user
Parameters
Responses
PUT
Description
Updates current user data field
Parameters
Responses
GET
Description
Returns current user
Responses
/api/v2/auth/resource/addresses
POST
Description
Upload a new address approval document for current user
Parameters
Responses
/api/v2/auth/public/configs/auth0
GET
Description
Get auth0 configuration
Responses
/api/v2/auth/public/configs
GET
Description
Get auth configurations
Responses
/api/v2/auth/public/version
GET
Description
Get auth version
Responses
/api/v2/auth/public/time
GET
Description
Get server current unix timestamp.
Responses
/api/v2/auth/public/ping
GET
Description
Test connectivity
Responses
/api/v2/auth/public/password/validate
POST
Description
Password strength testing
Parameters
Responses
/api/v2/auth/public/kyc
POST
Description
KYC callback
Responses
Models
API_V2_Entities_UserWithFullInfo
Returns current user
API_V2_Entities_Label
List all labels for current user.
API_V2_Entities_Phone
Returns list of user's phones
API_V2_Entities_Profile
Return profiles of current resource owner
API_V2_Entities_DataStorage
API_V2_Entities_APIKey
Create an api key
API_V2_Entities_Document
Return current user documents list
API_V2_Entities_Activity
Returns user activity
API_V2_Entities_Level
API_V2_Entities_User
API_V2_Entities_UserWithProfile
API_V2_Entities_UserWithKYC
API_V2_Entities_AdminLabelView
API_V2_Entities_Comment
API_V2_Entities_ServiceAccounts
Last updated