logo

Barong

RESTful API for barong OAuth server

#Version: 2.4.0

Security

BearerToken

jwtundefined
DescriptionBearer Token authentication
NameAuthorization
Inheader

/admin/levels

GET

Description:

Returns array of permissions as paginated collection

Responses
CodeDescription
200Returns array of permissions as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/profiles

PUT

Description:

Update a profile for user

Parameters
NameLocated inDescriptionRequiredSchema
uidformDataYesstring
first_nameformDataNostring
last_nameformDataNostring
dobformDataNodate
addressformDataNostring
postcodeformDataNostring
cityformDataNostring
countryformDataNostring
stateformDataNostring
metadataformDataAny additional key: value pairs in json string formatNostring
Responses
CodeDescription
200Update a profile for user
400Required params are empty
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

GET

Description:

Return all profiles

Parameters
NameLocated inDescriptionRequiredSchema
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Return all profiles
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/restrictions

DELETE

Description:

Delete restriction

Parameters
NameLocated inDescriptionRequiredSchema
idqueryRestriction idYesinteger
Responses
CodeDescription
204Delete restriction
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

PUT

Description:

Update restriction

Parameters
NameLocated inDescriptionRequiredSchema
idformDataRestriction idYesinteger
scopeformDataNostring
valueformDataNostring
stateformDataNostring
Responses
CodeDescription
200Update restriction
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

POST

Description:

Create restriction

Parameters
NameLocated inDescriptionRequiredSchema
scopeformDataYesstring
valueformDataYesstring
stateformDataNostring
Responses
CodeDescription
201Create restriction
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

GET

Description:

Returns array of restrictions as a paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
scopequeryNostring
rangequeryNostring
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns array of restrictions as a paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/metrics

GET

Description:

Returns main statistic in the given time period

Parameters
NameLocated inDescriptionRequiredSchema
created_fromqueryNostring
created_toqueryNostring
Responses
CodeDescription
200Returns main statistic in the given time period
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/activities/admin

GET

Description:

Returns array of activities as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
topicqueryNostring
actionqueryNostring
uidqueryNostring
emailqueryNostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved.Nointeger
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved.Nointeger
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
target_uidqueryNostring
rangequeryNostring
Responses
CodeDescription
200Returns array of activities as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/activities

GET

Description:

Returns array of activities as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
topicqueryNostring
actionqueryNostring
uidqueryNostring
emailqueryNostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved.Nointeger
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved.Nointeger
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns array of activities as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/permissions

PUT

Description:

Update Permission

Parameters
NameLocated inDescriptionRequiredSchema
idformDataPermission idYesinteger
roleformDatapermission field - roleNostring
verbformDatapermission field - request verbNostring
pathformDatapermission field - request pathNostring
actionformDataNostring
topicformDataNostring
Responses
CodeDescription
200Update Permission
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

DELETE

Description:

Deletes permission

Parameters
NameLocated inDescriptionRequiredSchema
idquerypermission idYesinteger
Responses
CodeDescription
204Deletes permission
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

POST

Description:

Create permission

Parameters
NameLocated inDescriptionRequiredSchema
roleformDataYesstring
verbformDataYesstring
pathformDataYesstring
actionformDataYesstring
topicformDataNostring
Responses
CodeDescription
201Create permission
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

GET

Description:

Returns array of permissions as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns array of permissions as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/data_storage

DELETE

Description:

Deletes user's data storage record

Parameters
NameLocated inDescriptionRequiredSchema
uidqueryuser uniq idYesstring
titlequerydata storage uniq titleYesstring
Responses
CodeDescription
204Deletes user's data storage record
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/{uid }

GET

Description:

Returns user info

Parameters
NameLocated inDescriptionRequiredSchema
uidpathuser uniq idYesstring
Responses
CodeDescription
200Returns user info
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/labels

DELETE

Description:

Deletes label for user

Parameters
NameLocated inDescriptionRequiredSchema
uidqueryuser uniq idYesstring
keyquerylabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.Yesstring
scopequerylabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.Yesstring
Responses
CodeDescription
204Deletes label for user
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

PUT

Description:

Update user label scope

Parameters
NameLocated inDescriptionRequiredSchema
uidformDatauser uniq idYesstring
keyformDataLabel key.Yesstring
scopeformDatalabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.Yesstring
descriptionformDatalabel description. [A-Za-z0-9_-] should be used. max - 255 characters.Nostring
valueformDataLabel value.Yesstring
Responses
CodeDescription
200Update user label scope
400Required params are empty
401Invalid bearer token
404Record is not found
422Validation errors
Security
Security SchemaScopes
BearerToken

POST

Description:

Adds label for user

Parameters
NameLocated inDescriptionRequiredSchema
uidformDatauser uniq idYesstring
keyformDatalabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.Yesstring
valueformDatalabel value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters.Yesstring
descriptionformDatalabel description. [A-Za-z0-9_-] should be used. max - 255 characters.Nostring
scopeformDataLabel scope: 'public' or 'private'. Default is publicNostring
Responses
CodeDescription
201Adds label for user
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

GET

Description:

Returns array of users as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
keyqueryLabel keyYesstring
valuequeryLabel valueYesstring
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns array of users as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/labels/update

POST

Description:

Update user label value

Parameters
NameLocated inDescriptionRequiredSchema
uidformDatauser uniq idYesstring
keyformDataLabel key.Yesstring
scopeformDatalabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.Yesstring
valueformDataLabel value.Yesstring
descriptionformDatalabel description. [A-Za-z0-9_-] should be used. max - 255 characters.Nostring
replaceformDataWhen true label will be created if not existNoBoolean
Responses
CodeDescription
201Update user label value
400Required params are empty
401Invalid bearer token
404Record is not found
422Validation errors
Security
Security SchemaScopes
BearerToken

/admin/users/labels/list

GET

Description:

Returns existing labels keys and values

Responses
CodeDescription
200Returns existing labels keys and values
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/documents/pending

GET

Description:

Returns array of users with pending or replaced documents as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
extendedqueryWhen true endpoint returns full information about usersNoBoolean
uidqueryNostring
emailqueryNostring
rolequeryNostring
first_namequeryNostring
last_namequeryNostring
countryqueryNostring
levelqueryNointeger
statequeryNostring
rangequeryNostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved.Nointeger
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved.Nointeger
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns array of users with pending or replaced documents as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users

PUT

Description:

Update user attributes

Parameters
NameLocated inDescriptionRequiredSchema
uidformDatauser uniq idYesstring
stateformDatauser stateNostring
otpformDatauser 2fa statusNoBoolean
Responses
CodeDescription
200Update user attributes
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

GET

Description:

Returns array of users as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
extendedqueryWhen true endpoint returns full information about usersNoBoolean
uidqueryNostring
emailqueryNostring
rolequeryNostring
first_namequeryNostring
last_namequeryNostring
countryqueryNostring
levelqueryNointeger
statequeryNostring
rangequeryNostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved.Nointeger
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved.Nointeger
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns array of users as paginated collection
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/role

POST

Description:

Update user role

Parameters
NameLocated inDescriptionRequiredSchema
uidformDatauser uniq idYesstring
roleformDatauser roleYesstring
Responses
CodeDescription
201Update user role
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/admin/users/update

POST

Description:

Update user attributes

Parameters
NameLocated inDescriptionRequiredSchema
uidformDatauser uniq idYesstring
stateformDatauser stateNostring
otpformDatauser 2fa statusNoBoolean
Responses
CodeDescription
201Update user attributes
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/identity/users/password/confirm_code

POST

Description:

Sets new account password

Parameters
NameLocated inDescriptionRequiredSchema
reset_password_tokenformDataToken from emailYesstring
passwordformDataUser passwordYesstring
confirm_passwordformDataUser passwordYesstring
langformDataLanguage in iso-2 formatNostring
Responses
CodeDescription
201Resets password
400Required params are empty
404Record is not found
422Validation errors

/identity/users/password/generate_code

POST

Description:

Send password reset instructions

Parameters
NameLocated inDescriptionRequiredSchema
emailformDataAccount emailYesstring
langformDataLanguage in iso-2 formatNostring
captcha_responseformDataResponse from captcha widgetNostring
Responses
CodeDescription
201Generated password reset code
400Required params are missing
404User doesn't exist
422Validation errors

/identity/users/email/confirm_code

POST

Description:

Confirms an account

Parameters
NameLocated inDescriptionRequiredSchema
tokenformDataToken from emailYesstring
langformDataLanguage in iso-2 formatNostring
Responses
CodeDescription
201Confirms an account
400Required params are missing
422Validation errors

/identity/users/email/generate_code

POST

Description:

Send confirmations instructions

Parameters
NameLocated inDescriptionRequiredSchema
emailformDataAccount emailYesstring
langformDataClient env languageNostring
captcha_responseformDataResponse from captcha widgetNostring
Responses
CodeDescription
201Generated verification code
400Required params are missing
422Validation errors

/identity/users/register_geetest

GET

Description:

Register Geetest captcha

Responses
CodeDescription
200Register Geetest captcha

/identity/users

POST

Description:

Creates new user

Parameters
NameLocated inDescriptionRequiredSchema
emailformDataUser EmailYesstring
passwordformDataUser PasswordYesstring
refidformDataReferral uidNostring
langformDataClient env languageNostring
captcha_responseformDataResponse from captcha widgetNostring
dataformDataAny additional key: value pairs in json string formatNostring
Responses
CodeDescription
201Creates new user
400Required params are missing
422Validation errors

/identity/sessions

DELETE

Description:

Destroy current session

Responses
CodeDescription
204Destroy current session
400Required params are empty
404Record is not found

POST

Description:

Start a new session

Parameters
NameLocated inDescriptionRequiredSchema
emailformDataYesstring
passwordformDataYesstring
captcha_responseformDataResponse from captcha widgetNostring
otp_codeformDataCode from Google AuthenticatorNostring
Responses
CodeDescription
201Start a new session
400Required params are empty
404Record is not found

/identity/configs

GET

Description:

Get barong configurations

Responses
CodeDescription
200Get barong configurations

/identity/version

GET

Description:

Get barong version

Responses
CodeDescription
200Get barong version

/identity/time

GET

Description:

Get server current unix timestamp.

Responses
CodeDescription
200Get server current unix timestamp.

/identity/ping

GET

Description:

Test connectivity

Responses
CodeDescription
200Test connectivity

/identity/password/validate

POST

Description:

Password strength testing

Parameters
NameLocated inDescriptionRequiredSchema
passwordformDataUser passwordYesstring
Responses
CodeDescription
201Password strength testing

/resource/data_storage

POST

Description:

Create data storage

Parameters
NameLocated inDescriptionRequiredSchema
titleformDataYesstring
dataformDataYesstring
Responses
CodeDescription
201Create data storage
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/api_keys

GET

Description:

List all api keys for current account.

Parameters
NameLocated inDescriptionRequiredSchema
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200List all api keys for current account.
400Require 2FA and totp code
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

POST

Description:

Create an api key

Parameters
NameLocated inDescriptionRequiredSchema
algorithmformDataYesstring
kidformDataNostring
scopeformDatacomma separated scopesNostring
totp_codeformDataCode from Google AuthenticatorYesstring
Responses
CodeDescription
201Create an api key
400Required params are empty
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/api_keys/{kid }

DELETE

Description:

Delete an api key

Parameters
NameLocated inDescriptionRequiredSchema
kidpathYesstring
totp_codequeryCode from Google AuthenticatorYesstring
Responses
CodeDescription
204Succefully deleted
400Required params are empty
401Invalid bearer token
404Record is not found
Security
Security SchemaScopes
BearerToken

PATCH

Description:

Updates an api key

Parameters
NameLocated inDescriptionRequiredSchema
kidpathYesstring
scopeformDatacomma separated scopesNostring
stateformDataState of API Key. "active" state means key is active and can be used for authNostring
totp_codeformDataCode from Google AuthenticatorYesstring
Responses
CodeDescription
200Updates an api key
400Required params are empty
401Invalid bearer token
404Record is not found
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/otp/verify

POST

Description:

Verify 2FA code

Parameters
NameLocated inDescriptionRequiredSchema
codeformDataCode from Google AuthenticatorYesstring
Responses
CodeDescription
201Verify 2FA code
4002FA has not been enabled for this account or code is missing
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/otp/disable

POST

Description:

Disable 2FA

Parameters
NameLocated inDescriptionRequiredSchema
codeformDataCode from Google AuthenticatorYesstring
Responses
CodeDescription
201Disable 2FA
4002FA has not been enabled for this account or code is missing
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/otp/enable

POST

Description:

Enable 2FA

Parameters
NameLocated inDescriptionRequiredSchema
codeformDataCode from Google AuthenticatorYesstring
Responses
CodeDescription
201Enable 2FA
4002FA has been enabled for this account or code is missing
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/otp/generate_qrcode

POST

Description:

Generate qr code for 2FA

Responses
CodeDescription
201Generate qr code for 2FA
4002FA has been enabled for this account
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/resource/phones/verify

POST

Description:

Verify a phone

Parameters
NameLocated inDescriptionRequiredSchema
phone_numberformDataPhone number with country codeYesstring
verification_codeformDataVerification code from smsYesstring
Responses
CodeDescription
201Verify a phone
400Required params are empty
401Invalid bearer token
404Record is not found
Security
Security SchemaScopes
BearerToken

/resource/phones/send_code

POST

Description:

Resend activation code

Parameters
NameLocated inDescriptionRequiredSchema
phone_numberformDataPhone number with country codeYesstring
channelformDataThe verification method to useNostring
Responses
CodeDescription
201Resend activation code
400Required params are empty
401Invalid bearer token
404Record is not found
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/phones

POST

Description:

Add new phone

Parameters
NameLocated inDescriptionRequiredSchema
phone_numberformDataPhone number with country codeYesstring
channelformDataThe verification method to useNostring
Responses
CodeDescription
201Add new phone
400Required params are empty
401Invalid bearer token
404Record is not found
422Validation errors
Security
Security SchemaScopes
BearerToken

GET

Description:

Returns list of user's phones

Responses
CodeDescription
200Returns list of user's phones
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/resource/documents

POST

Description:

Upload a new document for current user

Parameters
NameLocated inDescriptionRequiredSchema
doc_typeformDataDocument typeYesstring
doc_numberformDataDocument numberYesstring
uploadformDataArray of Rack::Multipart::UploadedFileYesstring
doc_expireformDataDocument expiration dateNodate
metadataformDataAny additional key: value pairs in json string formatNostring
Responses
CodeDescription
201Document is uploaded
400Required params are empty
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

GET

Description:

Return current user documents list

Responses
CodeDescription
200Return current user documents list
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/resource/profiles

PUT

Description:

Update a profile for current_user

Parameters
NameLocated inDescriptionRequiredSchema
first_nameformDataNostring
last_nameformDataNostring
dobformDataNodate
addressformDataNostring
postcodeformDataNostring
cityformDataNostring
countryformDataNostring
metadataformDataAny additional key: value pairs in json string formatNostring
confirmformDataProfile confirmationNoBoolean
Responses
CodeDescription
200Update a profile for current_user
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

POST

Description:

Create a profile for current_user

Parameters
NameLocated inDescriptionRequiredSchema
first_nameformDataNostring
last_nameformDataNostring
dobformDataNodate
addressformDataNostring
postcodeformDataNostring
cityformDataNostring
countryformDataNostring
metadataformDataAny additional key: value pairs in json string formatNostring
confirmformDataProfile confirmationNoBoolean
Responses
CodeDescription
201Create a profile for current_user
400Required params are empty
401Invalid bearer token
409Profile already exists
422Validation errors
Security
Security SchemaScopes
BearerToken

/resource/profiles/me

GET

Description:

Return profiles of current resource owner

Responses
CodeDescription
200Return profiles of current resource owner
401Invalid bearer token
404User has no profile
Security
Security SchemaScopes
BearerToken

/resource/labels/{key }

DELETE

Description:

Delete a label with 'public' scope.

Parameters
NameLocated inDescriptionRequiredSchema
keypathLabel key.Yesstring
Responses
CodeDescription
204Succefully deleted
400Required params are empty
401Invalid bearer token
404Record is not found
Security
Security SchemaScopes
BearerToken

PATCH

Description:

Update a label with 'public' scope.

Parameters
NameLocated inDescriptionRequiredSchema
keypathLabel key.Yesstring
valueformDataLabel value.Yesstring
Responses
CodeDescription
200Update a label with 'public' scope.
400Required params are empty
401Invalid bearer token
404Record is not found
422Validation errors
Security
Security SchemaScopes
BearerToken

GET

Description:

Return a label by key.

Parameters
NameLocated inDescriptionRequiredSchema
keypathLabel key.Yesstring
Responses
CodeDescription
200Return a label by key.
400Required params are empty
401Invalid bearer token
404Record is not found
Security
Security SchemaScopes
BearerToken

/resource/labels

POST

Description:

Create a label with 'public' scope.

Parameters
NameLocated inDescriptionRequiredSchema
keyformDataLabel key.Yesstring
valueformDataLabel value.Yesstring
Responses
CodeDescription
201Create a label with 'public' scope.
400Required params are empty
401Invalid bearer token
422Validation errors
Security
Security SchemaScopes
BearerToken

GET

Description:

List all labels for current user.

Responses
CodeDescription
200List all labels for current user.
401Invalid bearer token
Security
Security SchemaScopes
BearerToken

/resource/users/password

PUT

Description:

Sets new account password

Parameters
NameLocated inDescriptionRequiredSchema
old_passwordformDataPrevious account passwordYesstring
new_passwordformDataUser passwordYesstring
confirm_passwordformDataUser passwordYesstring
langformDataLanguage in iso-2 formatNostring
Responses
CodeDescription
201Changes password
400Required params are empty
404Record is not found
422Validation errors

/resource/users/activity/{topic }

GET

Description:

Returns user activity

Parameters
NameLocated inDescriptionRequiredSchema
topicpathTopic of user activity. Allowed: [all, password, session, otp]Yesstring
pagequeryPage number (defaults to 1).Nointeger
limitqueryNumber of users per page (defaults to 100, maximum is 100).Nointeger
Responses
CodeDescription
200Returns user activity

/resource/users/me

DELETE

Description:

Returns current user

Parameters
NameLocated inDescriptionRequiredSchema
passwordqueryAccount passwordYesstring
otp_codequeryCode from Google AuthenticatorNostring
Responses
CodeDescription
204Returns current user

GET

Description:

Returns current user

Responses
CodeDescription
200Returns current user

Models

Level

NameTypeDescriptionRequired
idintegerLevel identifier, level numberNo
keystringLabel key. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters.No
valuestringLabel value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters.No

Label

NameTypeDescriptionRequired
keystringLabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.No
valuestringLabel value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters.No
scopestringLabel scope: 'public' or 'private'No
created_atstringNo
updated_atstringNo

APIKey

NameTypeDescriptionRequired
kidstringjwt public keyNo
algorithmstringcryptographic hash function typeNo
scopestringserialized array of scopesNo
statestringactive/non-active state of keyNo
secretstringNo
created_atstringNo
updated_atstringNo

Profile

NameTypeDescriptionRequired
first_namestringNo
last_namestringNo
dobdateBirthday dateNo
addressstringNo
postcodestringNo
citystringNo
countrystringNo
statestringNo
metadataobjectProfile additional fieldsNo

User

NameTypeDescriptionRequired
emailstringNo
uidstringNo
rolestringNo
levelintegerNo
otpbooleanis 2FA enabled for accountNo
statestringNo
referral_uidstringUID of referrerNo
datastringadditional phone and profile infoNo

UserWithProfile

NameTypeDescriptionRequired
emailstringNo
uidstringNo
rolestringNo
levelintegerNo
otpbooleanis 2FA enabled for accountNo
statestringNo
datastringadditional phone and profile infoNo
profilesProfileNo
referral_uidstringUID of referrerNo
created_atstringNo
updated_atstringNo

UserWithKYC

NameTypeDescriptionRequired
emailstringNo
uidstringNo
rolestringNo
levelintegerNo
otpbooleanNo
statestringNo
datastringadditional phone and profile infoNo
profilesProfileNo
labelsAdminLabelViewNo
phonesPhoneNo
documentsDocumentNo
data_storagesDataStorageNo
referral_uidstringUID of referrerNo
created_atstringNo
updated_atstringNo

AdminLabelView

NameTypeDescriptionRequired
keystringLabel key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters.No
valuestringLabel value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters.No
scopestringLabel scope: 'public' or 'private'No
descriptionstringLabel desc: json string with any additional informationNo
created_atstringNo
updated_atstringNo

Phone

NameTypeDescriptionRequired
countrystringNo
numberstringNo
validated_ats (g)No

Document

NameTypeDescriptionRequired
uploadstringfile urlNo
doc_typestringdocument type: passport, driver licenseNo
doc_numberstringdocument number: AB123123 typeNo
doc_expirestringexpire date of uploaded documentsNo
metadatastringany additional stored dataNo
created_atstringNo
updated_atstringNo

DataStorage

NameTypeDescriptionRequired
titlestringany additional data titleNo
datastringany additional data json key:value pairsNo
created_atstringNo
updated_atstringNo

UserWithFullInfo

NameTypeDescriptionRequired
emailstringNo
uidstringNo
rolestringNo
levelintegerNo
otpbooleanNo
statestringNo
referral_uidstringUID of referrerNo
csrf_tokenstringcsrf protection tokenNo
datastringadditional phone and profile infoNo
created_atstringNo
updated_atstringNo
labelsLabelNo
phonesPhoneNo
profilesProfileNo
data_storagesDataStorageNo

Activity

NameTypeDescriptionRequired
user_ipstringNo
user_agentstringNo
topicstringNo
actionstringNo
resultstringNo
datastringNo
created_atstringNo