user

Retrieve user

SecurityapiAuth

Responses

200

get/3/user/

Request samples

Javascript SDK
Python SDK

rehive.user.get().then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": false,
"id_number": "string",
"birth_date": "2019-08-24",
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"account": "string",
"balance": 0,
"available_balance": 0,
"company": "string",
"owner": true,
"language": "string",
"nationality": "AF",
"residency": "AF",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": {"property1": null,
"property2": null
},
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": 0,
"name": "string",
"label": "string",
"tx_type": "credit"
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
}
]
}
}
}

Update user

SecurityapiAuth

Request

Request Body schema:
application/json
required

username required	string or null <= 150 characters ^[\w.@+-]+$
first_name	string or null <= 50 characters
middle_name	string or null <= 50 characters
last_name	string or null <= 50 characters
profile	string or null <uri>
id_number	string or null <= 24 characters
birth_date	string or null <date>
language	string <= 24 characters
nationality	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
residency	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
gender	string or null `male` - Male `female` - Female `other` - Other `not_specified` - Not Specified Enum: "male" "female" "other" "not_specified" null
title	string or null `mr` - Mr `mrs` - Mrs `ms` - Ms `mx` - Mx Enum: "mr" "mrs" "ms" "mx" null
marital_status	string or null `single` - Single `married` - Married `divorced` - Divorced `widowed` - Widowed Enum: "single" "married" "divorced" "widowed" null
fathers_name	string or null <= 100 characters
mothers_name	string or null <= 100 characters
grandfathers_name	string or null <= 100 characters
grandmothers_name	string or null <= 100 characters
central_bank_number	string or null <= 100 characters
timezone	string or null <= 100 characters
website	string or null <= 100 characters
business_name	string or null <= 100 characters

Responses

200

put/3/user/

Request samples

Payload
Javascript SDK
Python SDK

{"username": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"nationality": "AF",
"residency": "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": "success",
"data": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": false,
"id_number": "string",
"birth_date": "2019-08-24",
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"account": "string",
"balance": 0,
"available_balance": 0,
"company": "string",
"owner": true,
"language": "string",
"nationality": "AF",
"residency": "AF",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": {"property1": null,
"property2": null
},
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": 0,
"name": "string",
"label": "string",
"tx_type": "credit"
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
}
]
}
}
}

Partially update user

SecurityapiAuth

Request

Request Body schema:
application/json

username	string or null <= 150 characters ^[\w.@+-]+$
first_name	string or null <= 50 characters
middle_name	string or null <= 50 characters
last_name	string or null <= 50 characters
profile	string or null <uri>
id_number	string or null <= 24 characters
birth_date	string or null <date>
language	string <= 24 characters
nationality	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
residency	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
gender	string or null `male` - Male `female` - Female `other` - Other `not_specified` - Not Specified Enum: "male" "female" "other" "not_specified" null
title	string or null `mr` - Mr `mrs` - Mrs `ms` - Ms `mx` - Mx Enum: "mr" "mrs" "ms" "mx" null
marital_status	string or null `single` - Single `married` - Married `divorced` - Divorced `widowed` - Widowed Enum: "single" "married" "divorced" "widowed" null
fathers_name	string or null <= 100 characters
mothers_name	string or null <= 100 characters
grandfathers_name	string or null <= 100 characters
grandmothers_name	string or null <= 100 characters
central_bank_number	string or null <= 100 characters
timezone	string or null <= 100 characters
website	string or null <= 100 characters
business_name	string or null <= 100 characters

Responses

200

patch/3/user/

Request samples

Payload
Javascript SDK
Python SDK

{"username": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"nationality": "AF",
"residency": "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": "success",
"data": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": false,
"id_number": "string",
"birth_date": "2019-08-24",
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"account": "string",
"balance": 0,
"available_balance": 0,
"company": "string",
"owner": true,
"language": "string",
"nationality": "AF",
"residency": "AF",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": {"property1": null,
"property2": null
},
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": 0,
"name": "string",
"label": "string",
"tx_type": "credit"
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
}
]
}
}
}

List addresses

SecurityapiAuth

Responses

200

get/3/user/addresses/

Request samples

Javascript SDK
Python SDK

rehive.user.addresses.get().then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"created": 0,
"updated": 0
}
]
}

Create address

SecurityapiAuth

Request

Request Body schema:
application/json

type	string `permanent` - Permanent `contact` - Contact `shipping` - Shipping `billing` - Billing `business` - Business Enum: "permanent" "contact" "shipping" "billing" "business"
line_1	string or null <= 200 characters
line_2	string or null <= 200 characters
city	string or null <= 100 characters
state_province	string or null <= 100 characters
country	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
postal_code	string or null <= 10 characters

Responses

201

post/3/user/addresses/

Request samples

Payload
Javascript SDK
Python SDK

{"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"created": 0,
"updated": 0
}
}

Retrieve address

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/addresses/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.addresses.get(addressId).then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"created": 0,
"updated": 0
}
}

Update address

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

type	string `permanent` - Permanent `contact` - Contact `shipping` - Shipping `billing` - Billing `business` - Business Enum: "permanent" "contact" "shipping" "billing" "business"
line_1	string or null <= 200 characters
line_2	string or null <= 200 characters
city	string or null <= 100 characters
state_province	string or null <= 100 characters
country	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
postal_code	string or null <= 10 characters

Responses

200

put/3/user/addresses/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"created": 0,
"updated": 0
}
}

Partially update address

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

type	string `permanent` - Permanent `contact` - Contact `shipping` - Shipping `billing` - Billing `business` - Business Enum: "permanent" "contact" "shipping" "billing" "business"
line_1	string or null <= 200 characters
line_2	string or null <= 200 characters
city	string or null <= 100 characters
state_province	string or null <= 100 characters
country	string or null `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe 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" "" null
postal_code	string or null <= 10 characters

Responses

200

patch/3/user/addresses/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"created": 0,
"updated": 0
}
}

Delete address

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/addresses/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.addresses.delete(addressId).then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

{"status": "sucess"
}

List bank accounts

SecurityapiAuth

Request

query Parameters

account_currency	string
action	string
created	string <date-time>
created__gt	string <date-time>
created__gte	string <date-time>
created__lt	string <date-time>
created__lte	string <date-time>
currency	string
name	string
name__contains	string
number	string
status	string

Responses

200

get/3/user/bank-accounts/

Request samples

Javascript SDK
Python SDK

rehive.user.bankAccounts.get().then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"code": "string",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}

Create bank account

SecurityapiAuth

Request

Request Body schema:
application/json

name	string or null <= 200 characters
number	string or null <= 200 characters
type	string or null <= 200 characters
beneficiary_type	string or null `individual` - Individual `business` - Business Enum: "individual" "business" null
clabe	string or null <= 20 characters
	object or null A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
bank_name	string or null <= 200 characters
bank_code	string or null <= 50 characters
branch_code	string or null <= 50 characters
	object (UserBankBranchAddress) A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
routing_number	string or null <= 50 characters
swift	string or null <= 16 characters
iban	string or null <= 50 characters
bic	string or null <= 16 characters
	object or null
action	string Default: "withdraw" `withdraw` - Withdraw Value: "withdraw"

Responses

201

post/3/user/bank-accounts/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"metadata": {"property1": null,
"property2": null
},
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"code": "string",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Retrieve bank account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/bank-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.bankAccounts.get(accountId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"code": "string",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Update bank account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 200 characters
number	string or null <= 200 characters
type	string or null <= 200 characters
beneficiary_type	string or null `individual` - Individual `business` - Business Enum: "individual" "business" null
clabe	string or null <= 20 characters
	object or null A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
bank_name	string or null <= 200 characters
bank_code	string or null <= 50 characters
branch_code	string or null <= 50 characters
	object (UserBankBranchAddress) A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
routing_number	string or null <= 50 characters
swift	string or null <= 16 characters
iban	string or null <= 50 characters
bic	string or null <= 16 characters
	object or null

Responses

200

put/3/user/bank-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"code": "string",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Partially update bank account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 200 characters
number	string or null <= 200 characters
type	string or null <= 200 characters
beneficiary_type	string or null `individual` - Individual `business` - Business Enum: "individual" "business" null
clabe	string or null <= 20 characters
	object or null A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
bank_name	string or null <= 200 characters
bank_code	string or null <= 50 characters
branch_code	string or null <= 50 characters
	object (UserBankBranchAddress) A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
routing_number	string or null <= 50 characters
swift	string or null <= 16 characters
iban	string or null <= 50 characters
bic	string or null <= 16 characters
	object or null

Responses

200

patch/3/user/bank-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "string",
"owner": {"first_name": "string",
"middle_name": "string",
"last_name": "string",
"phone_number": "string",
"email_address": "user@example.com",
"company_name": "string",
"ein_tin": "string",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"cpf_cpnj": "string"
},
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"code": "string",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Delete bank account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/bank-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.bank_accounts.delete(bankId).then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

{"status": "sucess"
}

user_bank_accounts_account_currencies_list

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/bank-accounts/{id}/account-currencies/

Response samples

application/json

{"status": "success",
"data": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
]
}

user_bank_accounts_account_currencies_create

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

account_currency

required

string

Responses

201

post/3/user/bank-accounts/{id}/account-currencies/

Request samples

Payload

{"account_currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
}

user_bank_accounts_account_currencies_retrieve

SecurityapiAuth

Request

path Parameters

account_currency_id required	string^[a-zA-Z0-9\_\-]+$
id required	string^\d+$

Responses

200

get/3/user/bank-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true,
"created": 0,
"updated": 0
}
}

user_bank_accounts_account_currencies_destroy

SecurityapiAuth

Request

path Parameters

account_currency_id required	string^[a-zA-Z0-9\_\-]+$
id required	string^\d+$

Responses

200

delete/3/user/bank-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "sucess"
}

List bank account currencies

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/bank-accounts/{id}/currencies/

Response samples

application/json

{"status": "success",
"data": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
]
}

Create bank account currency

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

currency

required

string

Responses

201

post/3/user/bank-accounts/{id}/currencies/

Request samples

Payload

{"currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
}

Retrieve bank account currency

SecurityapiAuth

Request

path Parameters

code required	string^\w+$
id required	string^\d+$

Responses

200

get/3/user/bank-accounts/{id}/currencies/{code}/

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
}

Delete bank account currency

SecurityapiAuth

Request

path Parameters

code required	string^\w+$
id required	string^\d+$

Responses

200

delete/3/user/bank-accounts/{id}/currencies/{code}/

Response samples

application/json

{"status": "sucess"
}

List crypto accounts

SecurityapiAuth

Request

query Parameters

account_currency	string
action	string
created	string <date-time>
created__gt	string <date-time>
created__gte	string <date-time>
created__lt	string <date-time>
created__lte	string <date-time>
crypto_type	string
currency	string
name	string
name__contains	string
status	string

Responses

200

get/3/user/crypto-accounts/

Request samples

Javascript SDK
Python SDK

rehive.user.cryptoAccounts.get().then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"status": "obsolete",
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}

Create crypto account

SecurityapiAuth

Request

Request Body schema:
application/json
required

address required	string <= 250 characters
name	string or null <= 50 characters
crypto_type	string `bitcoin` - Bitcoin `ethereum` - Ethereum `stellar` - Stellar `other` - Other Enum: "bitcoin" "ethereum" "stellar" "other"
network	string Default: "testnet" `testnet` - Testnet `mainnet` - Mainnet Enum: "testnet" "mainnet"
	object or null
action	string Default: "withdraw" `withdraw` - Withdraw Value: "withdraw"

Responses

201

post/3/user/crypto-accounts/

Request samples

Payload
Javascript SDK
Python SDK

{"address": "string",
"name": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
},
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"status": "obsolete",
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Retrieve crypto account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/crypto-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.cryptoAccounts.get(accountId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"status": "obsolete",
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Update crypto account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

address required	string <= 250 characters
name	string or null <= 50 characters
crypto_type	string `bitcoin` - Bitcoin `ethereum` - Ethereum `stellar` - Stellar `other` - Other Enum: "bitcoin" "ethereum" "stellar" "other"
network	string Default: "testnet" `testnet` - Testnet `mainnet` - Mainnet Enum: "testnet" "mainnet"
	object or null

Responses

200

put/3/user/crypto-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"address": "string",
"name": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"status": "obsolete",
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Partially update crypto account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

address	string <= 250 characters
name	string or null <= 50 characters
crypto_type	string `bitcoin` - Bitcoin `ethereum` - Ethereum `stellar` - Stellar `other` - Other Enum: "bitcoin" "ethereum" "stellar" "other"
network	string Default: "testnet" `testnet` - Testnet `mainnet` - Mainnet Enum: "testnet" "mainnet"
	object or null

Responses

200

patch/3/user/crypto-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"address": "string",
"name": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"status": "obsolete",
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Delete bank account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/crypto-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.crypto_accounts.delete(accountId).then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

{"status": "sucess"
}

user_crypto_accounts_account_currencies_list

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/crypto-accounts/{id}/account-currencies/

Response samples

application/json

{"status": "success",
"data": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
]
}

user_crypto_accounts_account_currencies_create

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

account_currency

required

string

Responses

201

post/3/user/crypto-accounts/{id}/account-currencies/

Request samples

Payload

{"account_currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
}

user_crypto_accounts_account_currencies_retrieve

SecurityapiAuth

Request

path Parameters

account_currency_id required	string^[a-zA-Z0-9\_\-]+$
id required	string^\d+$

Responses

200

get/3/user/crypto-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true,
"created": 0,
"updated": 0
}
}

user_crypto_accounts_account_currencies_destroy

SecurityapiAuth

Request

path Parameters

account_currency_id required	string^[a-zA-Z0-9\_\-]+$
id required	string^\d+$

Responses

200

delete/3/user/crypto-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "sucess"
}

List crypto account currencies

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/crypto-accounts/{id}/currencies/

Response samples

application/json

{"status": "success",
"data": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
]
}

Create crypto account currency

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

currency

required

string

Responses

201

post/3/user/crypto-accounts/{id}/currencies/

Request samples

Payload

{"currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
}

Retrieve crypto account currency

SecurityapiAuth

Request

path Parameters

code required	string^\w+$
id required	string^\d+$

Responses

200

get/3/user/crypto-accounts/{id}/currencies/{code}/

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
}

Delete crypto account currency

SecurityapiAuth

Request

path Parameters

code required	string^\w+$
id required	string^\d+$

Responses

200

delete/3/user/crypto-accounts/{id}/currencies/{code}/

Response samples

application/json

{"status": "sucess"
}

List devices

SecurityapiAuth

Request

query Parameters

imei

string

Responses

200

get/3/user/devices/

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": {"property1": null,
"property2": null
},
"created": 0,
"updated": 0
}
]
}

Create device

SecurityapiAuth

Request

Request Body schema:
application/json
required

imei required	string <= 64 characters
name	string or null <= 30 characters
	object or null

Responses

201

post/3/user/devices/

Request samples

Payload

{"imei": "string",
"name": "string",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": {"property1": null,
"property2": null
},
"created": 0,
"updated": 0
}
}

Retrieve device app

SecurityapiAuth

Request

path Parameters

app_id required	string^\d+$
device_id required	string^\d+$

Responses

200

get/3/user/devices/{device_id}/apps/{app_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"type": "expo",
"token": "string",
"created": 0,
"updated": 0
}
}

Update device app

SecurityapiAuth

Request

path Parameters

app_id required	string^\d+$
device_id required	string^\d+$

Request Body schema:
application/json
required

name	string or null <= 30 characters
type required	string `expo` - Expo Value: "expo"

Responses

200

put/3/user/devices/{device_id}/apps/{app_id}/

Request samples

Payload

{"name": "string",
"type": "expo"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"type": "expo",
"token": "string",
"created": 0,
"updated": 0
}
}

Partially update device app

SecurityapiAuth

Request

path Parameters

app_id required	string^\d+$
device_id required	string^\d+$

Request Body schema:
application/json

name	string or null <= 30 characters
type	string `expo` - Expo Value: "expo"

Responses

200

patch/3/user/devices/{device_id}/apps/{app_id}/

Request samples

Payload

{"name": "string",
"type": "expo"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"type": "expo",
"token": "string",
"created": 0,
"updated": 0
}
}

Delete device app

SecurityapiAuth

Request

path Parameters

app_id required	string^\d+$
device_id required	string^\d+$

Responses

200

delete/3/user/devices/{device_id}/apps/{app_id}/

Response samples

application/json

{"status": "sucess"
}

Retrieve device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/devices/{id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": {"property1": null,
"property2": null
},
"created": 0,
"updated": 0
}
}

Update device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 30 characters
	object or null

Responses

200

put/3/user/devices/{id}/

Request samples

Payload

{"name": "string",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": {"property1": null,
"property2": null
},
"created": 0,
"updated": 0
}
}

Partially update device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 30 characters
	object or null

Responses

200

patch/3/user/devices/{id}/

Request samples

Payload

{"name": "string",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": {"property1": null,
"property2": null
},
"created": 0,
"updated": 0
}
}

Delete device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/devices/{id}/

Response samples

application/json

{"status": "sucess"
}

List device apps

SecurityapiAuth

Request

path Parameters

required

string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/user/devices/{id}/apps/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string",
"created": 0,
"updated": 0
}
]
}
}

Create device app

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

name	string or null <= 30 characters
type required	string `expo` - Expo Value: "expo"
token	string or null <= 100 characters

Responses

201

post/3/user/devices/{id}/apps/

Request samples

Payload

{"name": "string",
"type": "expo",
"token": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"type": "expo",
"token": "string",
"created": 0,
"updated": 0
}
}

List documents

DEPRECATED: The document_type and document_category fields are deprecated.

SecurityapiAuth

Request

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/user/documents/

Request samples

Javascript SDK
Python SDK

rehive.user.documents.get().then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": {"property1": null,
"property2": null
},
"note": "string",
"expires": 0,
"created": 0,
"updated": 0
}
]
}
}

Create document

DEPRECATED: The document_type field is deprecated.

SecurityapiAuth

Request

Request Body schema:
application/json
required

file required	string <uri>
document_type	string Deprecated `utility_bill` - Utility Bill `bank_statement` - Bank Statement `lease_or_rental_agreement` - Lease or Rental Agreement `municipal_rate_and_taxes` - Municipal Rate and Taxes Invoice `mortgage_statement` - Mortgage Statement `telephone` - Telephone or Cellular Account `insurance_policy` - Insurance Policy Document `retail_store` - Statement of Account Issued by a Retail Store `generic_proof_of_address` - Generic Proof of Address `government_id` - Government Issued ID `passport` - Passport `drivers_license` - Drivers License `generic_proof_of_identity` - Generic Proof of Identity `payslip` - Payslip `employment_letter` - Employment Letter `financial_statement` - Financial Statement `id_confirmation` - ID Confirmation Photo `generic_advanced_proof_of_identity` - Generic Advanced Proof of Identity `other` - Other Enum: "utility_bill" "bank_statement" "lease_or_rental_agreement" "municipal_rate_and_taxes" "mortgage_statement" "telephone" "insurance_policy" "retail_store" "generic_proof_of_address" "government_id" "passport" "drivers_license" "generic_proof_of_identity" "payslip" "employment_letter" "financial_statement" "id_confirmation" "generic_advanced_proof_of_identity" "other"
type	integer
	object or null
expires	integer or null

Responses

201

post/3/user/documents/

Request samples

Payload
Javascript SDK
Python SDK

{"file": "http://example.com",
"document_type": "utility_bill",
"type": 0,
"metadata": {"property1": null,
"property2": null
},
"expires": 0
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": {"property1": null,
"property2": null
},
"note": "string",
"expires": 0,
"created": 0,
"updated": 0
}
}

Retrieve document

DEPRECATED: The document_type and document_category fields are deprecated.

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/documents/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.documents.get({id: documentId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": {"property1": null,
"property2": null
},
"note": "string",
"expires": 0,
"created": 0,
"updated": 0
}
}

List emails

SecurityapiAuth

Responses

200

get/3/user/emails/

Request samples

Javascript SDK
Python SDK

rehive.user.emails.get().then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
]
}

Create email

SecurityapiAuth

Request

Request Body schema:
application/json
required

email required	string <email> <= 254 characters
primary	boolean

Responses

201

post/3/user/emails/

Request samples

Payload
Javascript SDK
Python SDK

{"email": "user@example.com",
"primary": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Retrieve email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/emails/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.emails.get(emailId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Update email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary

boolean

Responses

200

put/3/user/emails/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Partially update email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary

boolean

Responses

200

patch/3/user/emails/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Delete email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/emails/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.emails.delete(emailId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "sucess"
}

List legal terms

SecurityapiAuth

Request

query Parameters

group	string
name	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
type	string

Responses

200

get/3/user/legal-terms/

Request samples

Python SDK

rehive.user.legal_terms.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"type": "system",
"name": "string",
"description": "string",
"versions": [{"id": 0,
"version": 0,
"accepted": true,
"created": 0,
"updated": 0
}
],
"created": 0,
"updated": 0
}
]
}
}

Retrieve legal term

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/legal-terms/{id}/

Request samples

Python SDK

rehive.user.legal_terms.get(legal_terms_id)

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "system",
"name": "string",
"description": "string",
"versions": [{"id": 0,
"version": 0,
"accepted": true,
"created": 0,
"updated": 0
}
],
"created": 0,
"updated": 0
}
}

List legal term version

SecurityapiAuth

Request

path Parameters

required

string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/user/legal-terms/{id}/versions/

Request samples

Python SDK

rehive.user.legal_terms.obj(legal_terms_id).versions.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"version": 0,
"accepted": true,
"accepted_date": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
]
}
}

Retrieve legal term version

SecurityapiAuth

Request

path Parameters

term_id required	string^\d+$
version_id required	string^\d+$

Responses

200

get/3/user/legal-terms/{term_id}/versions/{version_id}/

Request samples

Python SDK

rehive.user.legal_terms.obj(legal_terms_id).versions.get(
  version_id
)

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"version": 0,
"accepted": true,
"accepted_date": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
}

Update legal term version

SecurityapiAuth

Request

path Parameters

term_id required	string^\d+$
version_id required	string^\d+$

Request Body schema:
application/json
required

accepted

required

boolean

Responses

200

put/3/user/legal-terms/{term_id}/versions/{version_id}/

Request samples

Payload
Python SDK

{"accepted": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"version": 0,
"accepted": true,
"accepted_date": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
}

Partially update legal term version

SecurityapiAuth

Request

path Parameters

term_id required	string^\d+$
version_id required	string^\d+$

Request Body schema:
application/json

accepted

boolean

Responses

200

patch/3/user/legal-terms/{term_id}/versions/{version_id}/

Request samples

Payload
Python SDK

{"accepted": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"version": 0,
"accepted": true,
"accepted_date": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
}

List messages

SecurityapiAuth

Request

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/user/messages/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"level": "info",
"message": "string",
"created": 0,
"updated": 0
}
]
}
}

Retrieve message

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/messages/{id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"level": "info",
"message": "string",
"created": 0,
"updated": 0
}
}

List mobiles

SecurityapiAuth

Responses

200

get/3/user/mobiles/

Request samples

Javascript SDK
Python SDK

rehive.user.mobiles.get().then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"number": "string",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
]
}

Create mobile

SecurityapiAuth

Request

Request Body schema:
application/json
required

number

required

string <= 24 characters

Responses

201

post/3/user/mobiles/

Request samples

Payload
Javascript SDK
Python SDK

{"number": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"number": "string",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Retrieve mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/mobiles/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.mobiles.get(mobileId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"number": "string",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Update mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary

boolean

Responses

200

put/3/user/mobiles/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"number": "string",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Partially update mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary

boolean

Responses

200

patch/3/user/mobiles/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"number": "string",
"primary": true,
"verified": true,
"created": 0,
"updated": 0
}
}

Delete mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/mobiles/{id}/

Request samples

Javascript SDK
Python SDK

rehive.user.mobiles.delete(mobileId).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "sucess"
}

List wallet accounts

SecurityapiAuth

Request

query Parameters

account_currency	string
action	string
created	string <date-time>
created__gt	string <date-time>
created__gte	string <date-time>
created__lt	string <date-time>
created__lte	string <date-time>
currency	string
name	string
name__contains	string
status	string

Responses

200

get/3/user/wallet-accounts/

Request samples

Python SDK

rehive.user.wallet_accounts.get()

Response samples

application/json

{"status": "success",
"data": [{"id": 0,
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}

Create wallet account

SecurityapiAuth

Request

Request Body schema:
application/json

username	string or null <= 200 characters
email	string or null <email> <= 254 characters
mobile	string or null <= 24 characters
name	string or null <= 50 characters
type	string `paypal` - Paypal `venmo` - Venmo `other` - Other Enum: "paypal" "venmo" "other"
	object or null
action	string Default: "withdraw" `withdraw` - Withdraw Value: "withdraw"

Responses

201

post/3/user/wallet-accounts/

Request samples

Payload
Python SDK

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Retrieve wallet account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/wallet-accounts/{id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Update wallet account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

username	string or null <= 200 characters
email	string or null <email> <= 254 characters
mobile	string or null <= 24 characters
name	string or null <= 50 characters
type	string `paypal` - Paypal `venmo` - Venmo `other` - Other Enum: "paypal" "venmo" "other"
	object or null

Responses

200

put/3/user/wallet-accounts/{id}/

Request samples

Payload

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Partially update wallet account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

username	string or null <= 200 characters
email	string or null <email> <= 254 characters
mobile	string or null <= 24 characters
name	string or null <= 50 characters
type	string `paypal` - Paypal `venmo` - Venmo `other` - Other Enum: "paypal" "venmo" "other"
	object or null

Responses

200

patch/3/user/wallet-accounts/{id}/

Request samples

Payload

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"account_currencies": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Delete wallet account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/user/wallet-accounts/{id}/

Response samples

application/json

{"status": "sucess"
}

user_wallet_accounts_account_currencies_list

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/user/wallet-accounts/{id}/account-currencies/

Response samples

application/json

{"status": "success",
"data": [{"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
]
}

user_wallet_accounts_account_currencies_create

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

account_currency

required

string

Responses

201

post/3/user/wallet-accounts/{id}/account-currencies/

Request samples

Payload

{"account_currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true
}
}

user_wallet_accounts_account_currencies_retrieve

SecurityapiAuth

Request

path Parameters

account_currency_id required	string^[a-zA-Z0-9\_\-]+$
id required	string^\d+$

Responses

200

get/3/user/wallet-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"balance": 0,
"available_balance": 0,
"account": {"reference": "string",
"name": "string",
"label": "string",
"primary": true
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"active": true,
"created": 0,
"updated": 0
}
}

user_wallet_accounts_account_currencies_destroy

SecurityapiAuth

Request

path Parameters

account_currency_id required	string^[a-zA-Z0-9\_\-]+$
id required	string^\d+$

Responses

200

delete/3/user/wallet-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "sucess"
}

List wallet account currencies

SecurityapiAuth

Request

path Parameters

required

string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/user/wallet-accounts/{id}/currencies/

Request samples

Python SDK

rehive.user.wallet_accounts.obj(
  wallet_account_id
).currencies.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
]
}
}

Create wallet account currency

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

currency

required

string

Responses

201

post/3/user/wallet-accounts/{id}/currencies/

Request samples

Payload
Python SDK

{"currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
}

Retrieve wallet account currency

SecurityapiAuth

Request

path Parameters

code required	string^\w+$
id required	string^\d+$

Responses

200

get/3/user/wallet-accounts/{id}/currencies/{code}/

Request samples

Python SDK

rehive.user.wallet_accounts.obj(
  wallet_account_id
).currencies.get(currency_code)

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"created": 0,
"updated": 0
}
}

Delete wallet account currency

SecurityapiAuth

Request

path Parameters

code required	string^\w+$
id required	string^\d+$

Responses

200

delete/3/user/wallet-accounts/{id}/currencies/{code}/

Request samples

Python SDK

rehive.user.wallet_accounts.obj(
  wallet_account_id
).currencies.delete(currency_code)

Response samples

application/json

{"status": "sucess"
}

user

Retrieve user

Update user

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Partially update user

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

List addresses

Create address

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Retrieve address

path Parameters

Update address

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Partially update address

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Delete address

path Parameters

List bank accounts

query Parameters

Create bank account

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Retrieve bank account

path Parameters

Update bank account

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Partially update bank account

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Delete bank account

path Parameters

user_bank_accounts_account_currencies_list

path Parameters

user_bank_accounts_account_currencies_create

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

user_bank_accounts_account_currencies_retrieve

path Parameters

user_bank_accounts_account_currencies_destroy

path Parameters

List bank account currencies

path Parameters

Create bank account currency

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Retrieve bank account currency

path Parameters

Delete bank account currency

path Parameters

List crypto accounts

query Parameters

Create crypto account

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Retrieve crypto account

path Parameters

Update crypto account

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Partially update crypto account

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Delete bank account

path Parameters

user_crypto_accounts_account_currencies_list

path Parameters

user_crypto_accounts_account_currencies_create

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

user_crypto_accounts_account_currencies_retrieve

path Parameters

user_crypto_accounts_account_currencies_destroy

path Parameters

List crypto account currencies

path Parameters

Create crypto account currency

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Retrieve crypto account currency

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json