User

Retrieve user

SecurityToken
Responses
200
get/user/
Request samples
rehive.user.get().then(function(res){
    ...
}, function(err){
    ...
})
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Update user

SecurityToken
Request
Request Body schema: application/json
username
required
string or null (Username) <= 150 characters ^[\w.@+-]+$
first_name
string (First name) <= 50 characters
last_name
string (Last name) <= 50 characters
id_number
string or null (Id number) <= 24 characters
birth_date
string or null <date> (Birth date)
language
string (Language) [ 1 .. 24 ] characters
nationality
string or null (Nationality)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
gender
string or null (Gender)
Enum: "male" "female" "other" "not_specified"
title
string or null (Title)
Enum: "mr" "mrs" "ms" "mx"
marital_status
string or null (Marital status)
Enum: "single" "married" "divorced" "widowed"
fathers_name
string or null (Fathers name) <= 100 characters
mothers_name
string or null (Mothers name) <= 100 characters
grandfathers_name
string or null (Grandfathers name) <= 100 characters
grandmothers_name
string or null (Grandmothers name) <= 100 characters
central_bank_number
string or null (Central bank number) <= 100 characters
timezone
string or null (Timezone) <= 100 characters
website
string or null (Website) <= 100 characters
business_name
string or null (Business name) <= 100 characters
Responses
200
put/user/
Request samples
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "id_number": "string",
  • "birth_date": "2019-08-24",
  • "language": "string",
  • "nationality": "AF",
  • "gender": "male",
  • "title": "mr",
  • "marital_status": "single",
  • "fathers_name": "string",
  • "mothers_name": "string",
  • "grandfathers_name": "string",
  • "grandmothers_name": "string",
  • "central_bank_number": "string",
  • "timezone": "string",
  • "website": "string",
  • "business_name": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Partially update user

SecurityToken
Request
Request Body schema: application/json
username
required
string or null (Username) <= 150 characters ^[\w.@+-]+$
first_name
string (First name) <= 50 characters
last_name
string (Last name) <= 50 characters
id_number
string or null (Id number) <= 24 characters
birth_date
string or null <date> (Birth date)
language
string (Language) [ 1 .. 24 ] characters
nationality
string or null (Nationality)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
gender
string or null (Gender)
Enum: "male" "female" "other" "not_specified"
title
string or null (Title)
Enum: "mr" "mrs" "ms" "mx"
marital_status
string or null (Marital status)
Enum: "single" "married" "divorced" "widowed"
fathers_name
string or null (Fathers name) <= 100 characters
mothers_name
string or null (Mothers name) <= 100 characters
grandfathers_name
string or null (Grandfathers name) <= 100 characters
grandmothers_name
string or null (Grandmothers name) <= 100 characters
central_bank_number
string or null (Central bank number) <= 100 characters
timezone
string or null (Timezone) <= 100 characters
website
string or null (Website) <= 100 characters
business_name
string or null (Business name) <= 100 characters
Responses
200
patch/user/
Request samples
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "id_number": "string",
  • "birth_date": "2019-08-24",
  • "language": "string",
  • "nationality": "AF",
  • "gender": "male",
  • "title": "mr",
  • "marital_status": "single",
  • "fathers_name": "string",
  • "mothers_name": "string",
  • "grandfathers_name": "string",
  • "grandmothers_name": "string",
  • "central_bank_number": "string",
  • "timezone": "string",
  • "website": "string",
  • "business_name": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List addresses

SecurityToken
Responses
200
get/user/addresses/
Request samples
rehive.user.addresses.get().then(function(res){
    ...
}, function(err){
    ...
})
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create address

SecurityToken
Request
Request Body schema: application/json
type
string (Type)
Enum: "permanent" "contact" "shipping" "billing" "business"
line_1
string or null (Line 1) <= 200 characters
line_2
string or null (Line 2) <= 200 characters
city
string or null (City) <= 100 characters
state_province
string or null (State province) <= 100 characters
country
string or null (Country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
postal_code
string or null (Postal code) <= 10 characters
Responses
201
post/user/addresses/
Request samples
application/json
{
  • "type": "permanent",
  • "line_1": "string",
  • "line_2": "string",
  • "city": "string",
  • "state_province": "string",
  • "country": "AF",
  • "postal_code": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve address

SecurityToken
Request
path Parameters
id
required
string
Responses
200
get/user/addresses/{id}/
Request samples
rehive.user.addresses.get(addressId).then(function(res){
    ...
}, function(err){
    ...
})
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Update address

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
type
string (Type)
Enum: "permanent" "contact" "shipping" "billing" "business"
line_1
string or null (Line 1) <= 200 characters
line_2
string or null (Line 2) <= 200 characters
city
string or null (City) <= 100 characters
state_province
string or null (State province) <= 100 characters
country
string or null (Country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
postal_code
string or null (Postal code) <= 10 characters
Responses
200
put/user/addresses/{id}/
Request samples
application/json
{
  • "type": "permanent",
  • "line_1": "string",
  • "line_2": "string",
  • "city": "string",
  • "state_province": "string",
  • "country": "AF",
  • "postal_code": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Partially update address

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
type
string (Type)
Enum: "permanent" "contact" "shipping" "billing" "business"
line_1
string or null (Line 1) <= 200 characters
line_2
string or null (Line 2) <= 200 characters
city
string or null (City) <= 100 characters
state_province
string or null (State province) <= 100 characters
country
string or null (Country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
postal_code
string or null (Postal code) <= 10 characters
Responses
200
patch/user/addresses/{id}/
Request samples
application/json
{
  • "type": "permanent",
  • "line_1": "string",
  • "line_2": "string",
  • "city": "string",
  • "state_province": "string",
  • "country": "AF",
  • "postal_code": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete address

SecurityToken
Request
path Parameters
id
required
string
Responses
204
delete/user/addresses/{id}/
Request samples
rehive.user.addresses.delete(addressId).then(function(res){
    ...
}, function(err){
    ...
})
Response samples
application/json
{
  • "status": "string"
}

List bank accounts

SecurityToken
Request
query Parameters
status
string
currency
string
Responses
200
get/user/bank-accounts/
Request samples
rehive.user.bankAccounts.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create bank account

SecurityToken
Request
Request Body schema: application/json
name
string or null (Name) <= 200 characters
number
string or null (Number) <= 200 characters
type
string or null (Type) <= 200 characters
bank_name
string or null (Bank name) <= 200 characters
bank_code
string or null (Bank code) <= 50 characters
branch_code
string or null (Branch code) <= 50 characters
object (UserBankBranchAddress)
routing_number
string or null (Routing number) <= 50 characters
swift
string or null (Swift) <= 16 characters
iban
string or null (Iban) <= 50 characters
bic
string or null (Bic) <= 16 characters
metadata
object or null (Metadata)
Responses
201
post/user/bank-accounts/
Request samples
application/json
{
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "bank_name": "string",
  • "bank_code": "string",
  • "branch_code": "string",
  • "branch_address": {
    },
  • "routing_number": "string",
  • "swift": "string",
  • "iban": "string",
  • "bic": "string",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve bank account

SecurityToken
Request
path Parameters
id
required
string
Responses
200
get/user/bank-accounts/{id}/
Request samples
rehive.user.bankAccounts.get(accountId).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Update bank account

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
name
string or null (Name) <= 200 characters
number
string or null (Number) <= 200 characters
type
string or null (Type) <= 200 characters
bank_name
string or null (Bank name) <= 200 characters
bank_code
string or null (Bank code) <= 50 characters
branch_code
string or null (Branch code) <= 50 characters
object (UserBankBranchAddress)
routing_number
string or null (Routing number) <= 50 characters
swift
string or null (Swift) <= 16 characters
iban
string or null (Iban) <= 50 characters
bic
string or null (Bic) <= 16 characters
metadata
object or null (Metadata)
Responses
200
put/user/bank-accounts/{id}/
Request samples
application/json
{
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "bank_name": "string",
  • "bank_code": "string",
  • "branch_code": "string",
  • "branch_address": {
    },
  • "routing_number": "string",
  • "swift": "string",
  • "iban": "string",
  • "bic": "string",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Partially update bank account

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
name
string or null (Name) <= 200 characters
number
string or null (Number) <= 200 characters
type
string or null (Type) <= 200 characters
bank_name
string or null (Bank name) <= 200 characters
bank_code
string or null (Bank code) <= 50 characters
branch_code
string or null (Branch code) <= 50 characters
object (UserBankBranchAddress)
routing_number
string or null (Routing number) <= 50 characters
swift
string or null (Swift) <= 16 characters
iban
string or null (Iban) <= 50 characters
bic
string or null (Bic) <= 16 characters
metadata
object or null (Metadata)
Responses
200
patch/user/bank-accounts/{id}/
Request samples
application/json
{
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "bank_name": "string",
  • "bank_code": "string",
  • "branch_code": "string",
  • "branch_address": {
    },
  • "routing_number": "string",
  • "swift": "string",
  • "iban": "string",
  • "bic": "string",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete bank account

SecurityToken
Request
path Parameters
id
required
string
Responses
204
delete/user/bank-accounts/{id}/
Request samples
rehive.user.bank_accounts.delete(bankId).then(function(res){
    ...
}, function(err){
    ...
})
Response samples
application/json
{
  • "status": "string"
}

List bank account currencies

SecurityToken
Request
path Parameters
id
required
string
Responses
200
get/user/bank-accounts/{id}/currencies/
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create bank account currency

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
currency
required
string (Currency) non-empty
Responses
201
post/user/bank-accounts/{id}/currencies/
Request samples
application/json
{
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve bank account currency

SecurityToken
Request
path Parameters
code
required
string
id
required
string
Responses
200
get/user/bank-accounts/{id}/currencies/{code}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete bank account currency

SecurityToken
Request
path Parameters
code
required
string
id
required
string
Responses
204
delete/user/bank-accounts/{id}/currencies/{code}/
Response samples
application/json
{
  • "status": "string"
}

List crypto accounts

SecurityToken
Request
query Parameters
status
string
currency
string
crypto_type
string
Responses
200
get/user/crypto-accounts/
Request samples
rehive.user.cryptoAccounts.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create crypto account

SecurityToken
Request
Request Body schema: application/json
address
required
string (Address) [ 1 .. 250 ] characters
name
string or null (Name) <= 50 characters
crypto_type
string (Crypto type)
Enum: "bitcoin" "ethereum" "stellar" "other"
network
string (Network)
Default: "testnet"
Enum: "testnet" "mainnet"
metadata
object or null (Metadata)
Responses
201
post/user/crypto-accounts/
Request samples
application/json
{
  • "address": "string",
  • "name": "string",
  • "crypto_type": "bitcoin",
  • "network": "testnet",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve crypto account

SecurityToken
Request
path Parameters
id
required
string
Responses
200
get/user/crypto-accounts/{id}/
Request samples
rehive.user.cryptoAccounts.get(accountId).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Update crypto account

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
address
required
string (Address) [ 1 .. 250 ] characters
name
string or null (Name) <= 50 characters
crypto_type
string (Crypto type)
Enum: "bitcoin" "ethereum" "stellar" "other"
network
string (Network)
Default: "testnet"
Enum: "testnet" "mainnet"
metadata
object or null (Metadata)
Responses
200
put/user/crypto-accounts/{id}/
Request samples
application/json
{
  • "address": "string",
  • "name": "string",
  • "crypto_type": "bitcoin",
  • "network": "testnet",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Partially update crypto account

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
address
required
string (Address) [ 1 .. 250 ] characters
name
string or null (Name) <= 50 characters
crypto_type
string (Crypto type)
Enum: "bitcoin" "ethereum" "stellar" "other"
network
string (Network)
Default: "testnet"
Enum: "testnet" "mainnet"
metadata
object or null (Metadata)
Responses
200
patch/user/crypto-accounts/{id}/
Request samples
application/json
{
  • "address": "string",
  • "name": "string",
  • "crypto_type": "bitcoin",
  • "network": "testnet",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete bank account

SecurityToken
Request
path Parameters
id
required
string
Responses
204
delete/user/crypto-accounts/{id}/
Request samples
rehive.user.crypto_accounts.delete(accountId).then(function(res){
    ...
}, function(err){
    ...
})
Response samples
application/json
{
  • "status": "string"
}

List crypto account currencies

SecurityToken
Request
path Parameters
id
required
string
Responses
200
get/user/crypto-accounts/{id}/currencies/
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create crypto account currency

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
currency
required
string (Currency) non-empty
Responses
201
post/user/crypto-accounts/{id}/currencies/
Request samples
application/json
{
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve crypto account currency

SecurityToken
Request
path Parameters
code
required
string
id
required
string
Responses
200
get/user/crypto-accounts/{id}/currencies/{code}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete crypto account currency

SecurityToken
Request
path Parameters
code
required
string
id
required
string
Responses
204
delete/user/crypto-accounts/{id}/currencies/{code}/
Response samples
application/json
{
  • "status": "string"
}

List devices

SecurityToken
Request
query Parameters
imei
string
Responses
200
get/user/devices/
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create device

SecurityToken
Request
Request Body schema: application/json
imei
required
string (Imei) [ 1 .. 64 ] characters
name
string or null (Name) <= 30 characters
metadata
object or null (Metadata)
Responses
201
post/user/devices/
Request samples
application/json
{
  • "imei": "string",
  • "name": "string",
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve device app

SecurityToken
Request
path Parameters
app_id
required
string
device_id
required
string
Responses
200
get/user/devices/{device_id}/apps/{app_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Update device app

SecurityToken
Request
path Parameters
app_id
required
string
device_id
required
string
Request Body schema: application/json
name
string or null (Name) <= 30 characters
type
required
string (Type)
Value: "expo"
Responses
200
put/user/devices/{device_id}/apps/{app_id}/
Request samples
application/json
{
  • "name": "string",
  • "type": "expo"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Partially update device app

SecurityToken
Request
path Parameters
app_id
required
string
device_id
required
string
Request Body schema: application/json
name
string or null (Name) <= 30 characters
type
required
string (Type)
Value: "expo"
Responses
200
patch/user/devices/{device_id}/apps/{app_id}/
Request samples
application/json
{
  • "name": "string",
  • "type": "expo"
}
Response samples
application/json